ROOT logo
HYDRA - THE HADES ANALYSIS PACKAGE » (UNKNOWN) » HParticleTrackSorter

class HParticleTrackSorter: public TNamed

_HADES_CLASS_DESCRIPTION



 HParticleTrackSorter

 This Class loops over the HParticleCand category and
 analyze the objects. If the ECAL detector is used a loop over
 HEmcCluster is performed too to mark the clusters used by selected
 candidates. The Purpose of the procedure is to categorize
 the objects in the case of multiple usage of the single detector
 hits (RICH, InnerMDC, OuterMDC, META) as Double_t hit and to provide
 a hint which of the candidates is the best with respect to certain
 criteria (described by the bit flags below). If a HParticleCand
 object has been marked before by an other task with HParticleCand::kIsUsed it
 will be ignored by the sort process and stay unchanged. For the description
 of the differnt set/get functions of the HParticleCand objects see the
 documentation.
 To use HParticleTrackSorter without changing the flags of the HParticleCand objects
 (non persitent way inside a macro or reconstructor) one can call the
 backupFlags() function before and modification of the flags and
 restore the flags by calling restoreFlags() after the privat work has been
 done.

 For debugging purpose one cand set screen printouts to check the sorting
 (setDebug() + setPrintLevel(Int_t level)(level = 1-3)).

 The analysis of the HParticleCand objects is done in several steps:

 1. Create the HParticleTrackSorter object and call the HParticleTrackSorter::Init()
    To initialze the sorter object with category pointers etc ...
 2. The internal structures are filled per event from the HParticleCand
    category by calling the
    Int_t HParticleTrackSorter::fill(Bool_t (*function)(HParticleCand* ))
    function which expects a function pointer to a function taking an
    HParticleCand pointer as argument and returning a Bool_t if the conditions on
    the HParticleCand object are fullfilled (like for example in
    Bool_t HParticleTrackSorter::selectHadrons(HParticleCand* pcand). For objects
    failing the test the kIsRejected bit is set. The user can provide
    his own selection functions to replace the build in selectLeptons(.....)
    and selectHadrons(....) select functions.
    The function pointer can be a pointer to a global function or member function
    of an Object for example:

    Bool_t select(HParticleCand* cand){             // global function
             if ( put all selection criteria here ) return kTRUE;
             else                                   return kFALSE;
    } or

    static Bool_t dummy::select(HParticleCand* cand){ // member function of object dummy
                                                      // needs to be declared static !
             if ( put all selection criteria here ) return kTRUE;
             else                                   return kFALSE;
    }
    would be called in the code like

    dummy d;
    HParticleCand* p= new HParticleCand() // just to get an object
    HParticleTrackSorter sorter;               // create the sorter object
    // now we have 3 possibilities to call the
    // test function
    1. sorter.fill(select)        // global function
    2. sorter.fill(dummy::select) // member function of object dummy (static call without object creation)
    3. sorter.fill(d.select)      // member function of real object dummy
 3. For all accepted objects the quality criteria and Double_t hit flags are
    evaluated in within the selected sample and flagged to the HParticleCand objects.
    The objects which fullfill the given minimum criteria the kIsAcceptedXXX bit is
    flagged. For the RICH, InnerMDC, OuterMDC and META the kIsDoubleHitXXX bit are set
    if the same detector hit index has been used more than once in the sample.
    For the double hit rejection of Meta hits only the selected Meta hits
    (ParticleCand::getSelectedMeta()) are taken into account. In the case of RPCClst+SHOWERHIT
    The shower hit might be used by more than one candidate.
 4. With the call of
    Int_t HParticleTrackSorter::selectBest(Particle::ESwitch byQuality, Int_t byParticle)
    the final selection on the objects is performed. The by the fill() procedure
    selected objects are sorted by the selected quality criteria. Starting from the
    best object one goes down the list and marks all objects with the kIsUsed and
    kIsBestXXX bit if they do not reuse an already used detector hit index
    (Double_t hit rejection).
    For leptons the kIsLepton bit is flagged in addition. Individual detector hits
    can be ignored in the selection procedure with the setIgnoreXXX(kTRUE) functions
    (by default all hits are taken into account).
    Particle::ESwitch byQuality can be used as quality criteria switch for

          Particle::kIsBestHitRichSorter          (by number of pads)
          Particle::kIsBestHitInnerMdcSorter      (by chi2, non fitted segments last)
	    Particle::kIsBestHitOuterMdcSorter      (by chi2, non fitted segments last)
          Particle::kIsBestHitMetaSorter          (by RK metamatch quality (or metaMatch quality if no RK , lower proirity))
          Particle::kIsBestRKSorter               (by RK chi2, none fitted outer segments with lower priority)
          Particle::kIsBestRKRKMETASorter         (by RK chi2 * RK META match quality)
          Particle::kIsBestRKRKMETARadiusSorter   (by RK chi2 * RK META match radius)
          Particle::kIsBestUserSorter             (by user provided sort function, no default function!)

    user provide sort function:
    static void   setUserSort(Bool_t    (*function)(candidateSort*, candidateSort*)
    The user has to provide a function for sorting of the candidates:

    Bool_t mysort(candidateSort* a, candidateSort* b) {
      // this example does the same as kIsBestRKRKMETA
      // sort in ascending order by RK_Chi2 * RK_META_match_Quality
      // the function can use all data members of struct candidateSort defined in hparticletracksorter.h
      return (a->RK_Chi2 * a->RK_META_match_Quality)  < (b->RK_Chi2 * b->RK_META_match_Quality);
    }


 5. The scheme allows for multiple selection following each other as
    the already used objects are excluded from the next steps (for example first
    select leptons and in the second iteration hadrons). The detector hit indicies
    of the previous selection of kIsUsed marked objects are added to list of used
    indicies by default not allowing to use a detector hit twice. To skip that
    memory one can set setIgnorePreviousIndex(kTRUE).
 6. After the analysis call HParticleTrackSorter::finalize(). After the selection
    the user has to take into account only HParticleCand objects which  have
    been flagged with kIsUsed. The objects slected by the Lepton selection will
    be marked in addition with kIsLepton to identify them easily.
 7. For lepton selections the internal selectLepton() function cand be manipulated.
    With setRICHMatching(Particle::EMatch ,Float_t window) the matching between
    inner MDC and RICH hit can be selected (default: HParticleTrackSorter::kUseRKRICHWindow,4 degree ).
 8. For Better suppression of background the build in select functions can apply
    a spacial match to the meta cell in y coordinate. setUseYMatching(kTRUE) (default)
    makes use of a match in y in within 3 mm. ( see HParticleTool::isGoodMetaCell(HParticleCand* c,Float_t bound))
 9. For Better suppression of background the build in select functions can require a valid beta measurement (beta>0)
    setUseBeta(kTRUE) (default), for leptons in addition a low cut in beta can be set setBetaLetonCut(0.9) (default)
10. For Better suppression of background the build in select functions can suppress fake measurement
    setUseFakeRejection(kTRUE) (default)


    A selection of unique lepton and hadron tracks could look like
    the following example :

 void myMacro(Int_t nEvents,TString inputDir, TString inFile)
 {
    Hades* myHades = new Hades;
    gHades->setQuietMode(2);

    HRootSource* source = new HRootSource();
    source->setDirectory(((Text_t *)inputDir.Data()));
    source->addFile((Text_t *)inFile.Data());

    myHades->setDataSource(source);

    if(!myHades->init()){
	cout<<"Hades Init() failed!"<<endl;
	exit(1);
    }


    //------------------------------------------------------------------------
    // get category ointers and iterators
    HCategory* pidCat  = (HCategory*)gHades->getCurrentEvent()->getCategory(catParticleCand);
    HIterator* iter    = NULL;
    if(pidCat)
    {
         iter = (HIterator *)pidCat->MakeIterator("native");
    } else {
        cout<<"Category Pointer is NULL!"<<endl;
	exit(1);
    }
    //------------------------------------------------------------------------


    //--------------------------CONFIGURATION---------------------------------------------------
    //At begin of the program (outside the event loop)
    HParticleTrackSorter sorter;
    //sorter.setDebug();                                            // for debug
    //sorter.setPrintLevel(3);                                      // max prints
    //sorter.setRICHMatching(Particle::kUseRKRICHWindowSorter,4.); // select matching RICH-MDC for selectLeptons() function
    //sorter.setUseYMatching(kTRUE);                                // use meta cell build in select functions
    //sorter.setMetaBoundary(4.0);                                   // match in 4 mm to meta cell
    //sorter.setUseBeta(kTRUE);                                     // require beta >0 in build in select functions
    //sorter.setTOFMAXCut( 60.);                                    // maximum tof [ns] allowd for match ( if beta is used)
    //sorter.setBetaLeptonCut(0.9);                                 // lower beta cut for lepton select
    //sorter.setUseFakeRejection(kTRUE);                            // reject fakes in  build in select functions (default kTRUE)
    //sorter.setUseMETAQA(kTRUE);                                   // metaqa in  build in select functions (default kTRUE)
    //sorter.setMETAQACut(3.0);                                     // metaqa cut for ahdrons+leptons
    //sorter.setIgnoreInnerMDC();                                   // do not reject Double_t inner MDC hits
    //sorter.setIgnoreOuterMDC();                                   // do not reject Double_t outer MDC hits
    //sorter.setIgnoreMETA();                                       // do not reject Double_t META hits
    //sorter.setIgnorePreviousIndex();                              // do not reject indices from previous selctions
    sorter.init();                                                  // get catgegory pointers etc...



    //------------------------------------------------------------------------
    // Event loop
    for(Int_t i = 1;i < nEvents; i ++)
    {
        //----------break if last event is reached-------------
        if(!gHades->eventLoop(1)) break;

        //------------------------------------------------------------------------
        // run your selection and set all flags

        //------------------------------------------------------------------------
        // clean vectors and index arrays
        sorter.cleanUp();
        //------------------------------------------------------------------------

        // if you do not want to modify the flags
        // for the following tasks etc (needs call of
        // restoreFlags() at the end of the eventloop)
        //sorter.backupFlags();

        sorter.resetFlags(kTRUE,kTRUE,kTRUE,kTRUE);     // reset all flags for flags (0-28) ,reject,used,lepton
        Int_t nCandLep     = sorter.fill(HParticleTrackSorter::selectLeptons);   // fill only good leptons
        Int_t nCandLepBest = sorter.selectBest(Particle::kIsBestRKSorter,HParticleTrackSorter::kIsLeptonSorter);
        Int_t nCandHad     = sorter.fill(HParticleTrackSorter::selectHadrons);   // fill only good hadrons (already marked good leptons will be skipped)
        Int_t nCandHadBest = sorter.selectBest(Particle::kIsBestRKSorter,HParticleTrackSorter::kIsHadronSorter);
        //------------------------------------------------------------------------

        //------------------------------------------------------------------------
        // analylize marked tracks (kIsUsed) ....
    	  iter->Reset();
        HParticleCand* pcand;
        while((pcand = (HParticleCand*)iter->Next()) != NULL)
	  {
           // accept only objects marked as good
	     if(!pcand->isFlagBit(HParticleCand::kIsUsed) ) continue;

           // do other selection......
        }
        //------------------------------------------------------------------------

        // if you do not want to modify the flags
        // for the following tasks etc (needs call of
        // backupFlags() at the beginning of the eventloop)
        // sorter.restoreFlags();


    }
    //------------------------------------------------------------------------
    //At the end of program
    sorter.finalize();
 }

Function Members (Methods)

public:
HParticleTrackSorter()
HParticleTrackSorter(const HParticleTrackSorter&)
HParticleTrackSorter(TString name, TString title)
virtual~HParticleTrackSorter()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
voidbackupFlags(Bool_t onlyFlags = kTRUE)
voidbackupSetup()
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
voidcleanUp(Bool_t final = kTRUE)
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
Int_tfill(Bool_t (*)(HParticleCand*) function)
virtual voidTNamed::FillBuffer(char*& buffer)
Bool_tfinalize()
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
Float_tgetBetaLeptonCut()
vector<candidateSort*>&getCandidates()
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
Float_tgetMetaBoundary()
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
sorter_setup&getSetup()
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
Bool_tinit(HRecEvent* evt = 0)
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
HParticleTrackSorter&operator=(const HParticleTrackSorter&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTNamed::Print(Option_t* option = "") const
voidprintEvent(TString comment)
voidprintSetup()
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
voidresetFlags(Bool_t flag = kTRUE, Bool_t reject = kTRUE, Bool_t used = kTRUE, Bool_t lepton = kTRUE)
Bool_trestoreFlags(Bool_t onlyFlags = kTRUE)
Bool_trestoreSetup()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
Int_tselectBest(Particle::ESwitch byQuality, Int_t byParticle)
static Bool_tselectHadrons(HParticleCand* pcand = 0)
static Bool_tselectHadronsNoOuterFit(HParticleCand* pcand = 0)
static Bool_tselectLeptons(HParticleCand* pcand = 0)
static Bool_tselectLeptonsNoOuterFit(HParticleCand* pcand = 0)
voidsetBetaLeptonCut(Float_t cut = .9)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
static voidsetDebug(Bool_t debug = kTRUE)
voidsetDeltaSegCut(Float_t cut = 2.)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidsetIgnoreInnerMDC(Bool_t ignore = kTRUE)
voidsetIgnoreMETA(Bool_t ignore = kTRUE)
voidsetIgnoreOuterMDC(Bool_t ignore = kTRUE)
voidsetIgnorePreviousIndex(Bool_t ignore = kTRUE)
voidsetIgnoreRICH(Bool_t ignore = kTRUE)
voidsetIsFieldOn(Bool_t field = kTRUE)
voidsetMetaBoundary(Float_t savety = 3.5)
voidsetMETAQACut(Float_t cut = 3.)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
static voidsetPrintLevel(Int_t level)
voidsetRICHMatching(Particle::ERichMatch match, Float_t window = 4.)
virtual voidTNamed::SetTitle(const char* title = "")MENU
voidsetTOFMAXCut(Float_t cut = 60.)
virtual voidTObject::SetUniqueID(UInt_t uid)
voidsetUseBeta(Bool_t use = kTRUE)
voidsetUseFakeRejection(Bool_t use = kTRUE)
voidsetUseMETAQA(Bool_t use = kTRUE)
voidsetUserSort(Bool_t (*)(candidateSort*, candidateSort*) function)
voidsetUseYMatching(Bool_t use = kTRUE)
voidsetUseYMatchingScaling(Bool_t use = kTRUE)
virtual voidShowMembers(TMemberInspector&)
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
voidclear()
Int_tclearVector(vector<candidateSort*>&)
static Bool_tcmpIndex(candidateSort*, candidateSort*)
static Bool_tcmpQuality(candidateSort*, candidateSort*)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
Int_tfillAndSetFlags()
Int_tfillInput(vector<candidateSort*>&)
Int_tflagAccepted(vector<candidateSort*>&, Particle::ESwitch)
Int_tflagDouble(vector<candidateSort*>&, Particle::ESwitch)
Bool_tflagEmcClusters()
static Bool_tisDeltaSegOk(HParticleCand*)
voidTObject::MakeZombie()
voidprintCand(candidateSort*, Int_t, TString spacer = " ")
Bool_trejectIndex(candidateSort*, Particle::ESwitch, Int_t&)
Bool_trejectQuality(candidateSort*, Particle::ESwitch)
voidselection(Bool_t (*)(HParticleCand*) function)
Int_tsetFlagsDouble(vector<candidateSort*>&, Particle::ESwitch)

Data Members

protected:
vector<candidateSort*>all_candidates!
UInt_tcurrentEvent! find new event
static Float_tfBetaLepCut! lower beta cut for lepton selection (default 0.9)
static Float_tfDeltaSegCut! max delta in phi,theta [deg] between inner/outer seg used in B-Field off
HRecEvent*fEvent! pointer to local event under reconstruction
static Float_tfMETAQACut! meta qa (normed dx) cut (default 3.)
static Float_tfMetaBoundary! matching window when using Y matching with metacell [mm] (default 3): fabs(dy) < (halfcell+metaBoundary)
TStringTNamed::fNameobject identifier
static Float_tfRICHMDCWindow! matching window RICH/MDC in phi/theta (symmetric, degree)
static Float_tfTOFMAXCut! max tof [ns] allowed to match (when beta is used)
TStringTNamed::fTitleobject title
Int_tfill_Iteration! remember the number of fill() calls
TFile*fout!
vector<Int_t>index_InnerMDC!
vector<Int_t>index_OuterMDC!
vector<Int_t>index_RICH!
vector<Int_t>index_RPC!
vector<Int_t>index_SHOWER!
vector<Int_t>index_TOFClst!
vector<Int_t>index_TOFHit!
Bool_tisSimulation!
HIterator*iterParticleCandCat! iterator on HParticleCand
static Bool_tkDebug!
static Bool_tkIgnoreInnerMDC! switch to ignore InnerMDC hits for Double_t hit counting
static Bool_tkIgnoreMETA! switch to ignore META hits for Double_t hit counting
static Bool_tkIgnoreOuterMDC! switch to ignore OuterMDC hits for Double_t hit counting
static Bool_tkIgnorePreviousIndex! switch to ignore indices from previoius marked ued objects
static Bool_tkIgnoreRICH! switch to ignore RICH hits for Double_t hit counting
static Bool_tkIsFieldOn! switch selections accoording B-Field
static Int_tkSwitchIndex! switch to select sort by index (no setup)
static Int_tkSwitchParticle! switch to select leptons/hadrons (no setup)
static Int_tkSwitchQuality! switch to select sort by quality algorithms (no setup)
static Int_tkSwitchRICHMatching! switch to select RICH/MDC matching in lepton selection
static Bool_tkUseBeta! switch to use Beta (in lepton select use fBetaLepCut, in hadron beta>0) (default kTRUE)
static Bool_tkUseFakeRejection! switch to use fakerejection in build in select functions (default kTRUE)
static Bool_tkUseMETAQA! switch to use metaqa (normed dx) in build in select functions (default kTRUE)
static Bool_tkUseYMatching! switch to use Y matching to meta cell (default kTRUE)
static Bool_tkUseYMatchingScaling! switch to use 1/p scaling of Y matching to meta cell (default kTRUE)
TString*nameIndex!
TString*nameQuality!
TNtuple*nt!
vector<Int_t>old_flags! remember the old flags of HParticleCand for restoring
vector<Int_t>old_flags_emc! remember the old flags of HEmcCluster for restoring
HCategory*pEmcClusterCat! HEmcCluster category
HCategory*pParticleCandCat! HParticleCand category
static Bool_t (*)(candidateSort*, candidateSort*)pUserSort! user provided function pointer to sort algo
static Int_tprintLevel! higher -> more prints (1,2,3) (no setup)
Int_tselectBest_Iteration! remember the number of selectBest() calls
sorter_setupsetup! store copy of setup params local
sorter_setupsetup_backup! store a copy of the static setup parameters local to restore them later

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

HParticleTrackSorter(const HParticleTrackSorter& )
HParticleTrackSorter(TString name, TString title)
~HParticleTrackSorter(void)
void clear()
 initialize the member variables
Bool_t init(HRecEvent* evt = 0)
 get the pointer to the HParticleCand categegory and create the
 corresponding iterator. HRecEvent* evt == 0 (default) the current event
 will be used otherise the event provided.
Bool_t finalize(void)
 clean up the memory and
 write ntuple to file (if it exist)
Bool_t isDeltaSegOk(HParticleCand* )
 returns kTRUE if inner and outer segment
 agree in theta, phi inside fDeltaSegCut
Int_t clearVector(vector<candidateSort*>& )
 delete all candidate structs in vector
 from heap and call the clear function of
 vector afterwards.
Bool_t cmpIndex(candidateSort* , candidateSort* )
 sorts the candidate list ascending by the index
 of the detector hit of interest.
Bool_t cmpQuality(candidateSort* , candidateSort* )
 sorts the candidate list by the quality critera
 of interest (ascending or decending depending on
 the quantity). The best object is always the first.
Bool_t rejectIndex(candidateSort* , Particle::ESwitch , Int_t& )
 if function return kTRUE the Object will be rejected
 rejects candidates from the actual list, where the
 detector hit of interest is not defined.
Bool_t rejectQuality(candidateSort* , Particle::ESwitch )
 if function return kTRUE the Object will be rejected
 rejects the candidates from the actual list if the quality
 of interest does not match the mimnum requirement.
Int_t flagAccepted(vector<candidateSort*>& , Particle::ESwitch )
 flag all candidates which does satisfy the quality
 criteria from input with kIsAcceptedXXX bit. If kDebug
 is set and printLevel >=2 the statistics for the accepted
 objects is printed.
Int_t flagDouble(vector<candidateSort*>& , Particle::ESwitch )
 sort vector in ascending order by the particular index byindex. Loops
 over the vector and extract objects with same detetector index and marks them
 as Double_t hits in HParticleCand (kIsDoubleHitXXX bit). Non valid detecor
 hits (index -1) are not taken into account. If kDebug
 is set and printLevel >=2 the statistics for the accepted
 objects is printed.
Int_t setFlagsDouble(vector<candidateSort*>& , Particle::ESwitch )
 flag the HParticleCand objects with the rank of the Double_t hit criteria as output
 form the sorting algorithms. Expects as input a vector of candidates with the
 same hit index.
Bool_t flagEmcClusters()
 loop over EmcCluster cat and reset IsUsedInParticleCand.
 loop over all candidates and flag emc clusters used in
 selected candidates only
Int_t fillInput(vector<candidateSort*>& )
 loop over HParticleCand category and fill a vector of temporary objects
 which will be used for sorting and flagging of the objects in the end.
 The candidate objects are initialzied with values of interest in a well
 defined way, which makes the sorting and rejecting of objects later on easier.
void printCand(candidateSort* , Int_t , TString spacer = " ")
 print one candidate object and the flags which have been
 already set to HParticleCand
void printEvent(TString comment)
void printSetup()
 print seeting of this sorter:
 column 1 : backup
 column 2 : setup
 column 3 : actual
void resetFlags(Bool_t flag = kTRUE, Bool_t reject = kTRUE, Bool_t used = kTRUE, Bool_t lepton = kTRUE)
 reset all flags of HParticleCand by looping over the
 HParticleCand category. The flags kIsRejected, kIsUsed
 and kIsLepton are special for selection and handles independend
 from the other flags. The lower flags of objects marked
 with kIsUsed cand be only reste if used == kRTUE.
void selection(Bool_t (*)(HParticleCand*) function)
 loops over the HParticleCand category and marks all objects
 which does not fullfill the selection criteria with the reject flag.
 Objects marked as kIsUsed are skipped.
void cleanUp(Bool_t final = kTRUE)
 delete temporary candidate objects from
 heap and clear the candidate vector. clear
 all index vectors.
Int_t fillAndSetFlags()
 clean up the memory and index vectors and fill the
 candidate vector new. Flag the kIsAcceptedXXX criteria
 and kIsDoubleHitXXX criteria of the HParticleCand objects of
 the selection (skipp objects which are marked kIsUsed and
 kIsRejected) returns the number of candidates.
void backupFlags(Bool_t onlyFlags = kTRUE)
 backup the flags of HParticleCand objects. The flags cand be
 restored to the objects by calling restoreFlags. The flags
 which have been stored previously will be cleared.
Bool_t restoreFlags(Bool_t onlyFlags = kTRUE)
 restore the flags of HParticleCand objects since the last call of
 backupFlags(). Returns kFALSE if size of vector old_flags does
 not match the number of objects in HParticleCand category
void backupSetup()
 backup the setup of HParticleTrackSorter. The setup cand be
 restored to the objects by calling restoreSetup.
Bool_t restoreSetup()
 restore the setup of HParticleTrackSorter since the last call of
 backupSetup().
Int_t fill(Bool_t (*)(HParticleCand*) function)
 fill the input candidate vector. The kIsRejected flag and
 lower flags (below kIsLepton) is reseted for all objects
 not marked as kIsUsed. The filling is done twice once for
 all objects and second after the application of the user
 provide test function. Returns the number of candidates after
 the selection. If kDebug is set and printLevel >= 1 the number
 of candidates before and after selection will be printed.
Int_t selectBest(Particle::ESwitch byQuality, Int_t byParticle)
 perfomes the selection of the best tracks (with respect to the chosen quality
 criteria), which makes shure, that each detector hit is used only once. If
 In case Int_t byParticle == kIsLepton the RICH index
 is taken into account, otherwise not. For leptons the kIsLepton bit is flagged
 in addition. Individual detector hits can be ignored in the selection procedure with
 the setIgnoreXXX(kTRUE) functions (by default all hits are taken into account).
 Returns the number of selected best HParticleCand objects.
 if kDebug is set and  printLevel >= 1 the number of sected objects and
 the statistics of the rejection on Double_t hits i the snhgle detectors is printed.
 if printLevel >=3 the properties of the candidates (accepted and rejected) are
 printed.
void setRICHMatching(Particle::ERichMatch match, Float_t window = 4.)
 switch between the matching cut RICH-MDC inside the selectLeptons() function. The method
 is selected by the options defined in Particle::ERichMatch.
Bool_t selectLeptons(HParticleCand* pcand = 0)
 build in selection function for lepton candidates.
 Requires besides an RICH hit, RK + META and fitted
 inner+outer segment. The RICH-MDC matching cut depends on the
 settings of the matching method and window (set by
 HParticleTrackSorter::setRICHMatching . default is
 kUseRKRICHWindow, window = 4. degree)
Bool_t selectLeptonsNoOuterFit(HParticleCand* pcand = 0)
 build in selection function for lepton candidates.
 Requires besides an RICH hit, RK + META and fitted
 inner. Fit for outer segment not reuired. The
 RICH-MDC matching cut depends on the
 settings of the matching method and window (set by
 HParticleTrackSorter::setRICHMatching . default is
 kUseRKRICHWindow, window = 4. degree)
Bool_t selectHadrons(HParticleCand* pcand = 0)
 build in selection function for hadron candidates.
 Requires besides RK + META and fitted inner+outer MDC.
Bool_t selectHadronsNoOuterFit(HParticleCand* pcand = 0)
 build in selection function for hadron candidates.
 Requires besides RK + META and fitted inner MDC. Fit
 for outer MDC not required.
HParticleTrackSorter(const HParticleTrackSorter& )
void setDebug(Bool_t debug = kTRUE)
 setup selections
{ kDebug = debug;}
void setPrintLevel(Int_t level)
{ printLevel = level;}
void setIsFieldOn(Bool_t field = kTRUE)
{ kIsFieldOn = field; setup.kIsFieldOn = field;}
void setIgnoreRICH(Bool_t ignore = kTRUE)
{ kIgnoreRICH = ignore;setup.kIgnoreRICH = ignore;}
void setIgnoreInnerMDC(Bool_t ignore = kTRUE)
{ kIgnoreInnerMDC = ignore;setup.kIgnoreInnerMDC = ignore;}
void setIgnoreOuterMDC(Bool_t ignore = kTRUE)
{ kIgnoreOuterMDC = ignore;setup.kIgnoreOuterMDC = ignore;}
void setIgnoreMETA(Bool_t ignore = kTRUE)
{ kIgnoreMETA = ignore;setup.kIgnoreMETA = ignore;}
void setIgnorePreviousIndex(Bool_t ignore = kTRUE)
void setUseYMatching(Bool_t use = kTRUE)
void setUseYMatchingScaling(Bool_t use = kTRUE)
void setUseBeta(Bool_t use = kTRUE)
{ kUseBeta = use ;setup.kUseBeta = use ;}
void setUseFakeRejection(Bool_t use = kTRUE)
void setUseMETAQA(Bool_t use = kTRUE)
{ kUseMETAQA = use ;setup.kUseMETAQA = use ;}
void setUserSort(Bool_t (*)(candidateSort*, candidateSort*) function)
{ pUserSort = function;setup.pUserSort = function;}
void setMetaBoundary(Float_t savety = 3.5)
{ fMetaBoundary = savety;setup.fMetaBoundary = savety;}
void setBetaLeptonCut(Float_t cut = .9)
{ fBetaLepCut = cut; setup.fBetaLepCut = cut;}
void setMETAQACut(Float_t cut = 3.)
{ fMETAQACut = cut; setup.fMETAQACut = cut;}
void setTOFMAXCut(Float_t cut = 60.)
{ fTOFMAXCut = cut; setup.fTOFMAXCut = cut;}
void setDeltaSegCut(Float_t cut = 2.)
Float_t getMetaBoundary()
{return fMetaBoundary;}
Float_t getBetaLeptonCut()
{return fBetaLepCut;}
sorter_setup& getSetup()
{ return setup; }
vector < candidateSort *>& getCandidates()
{ return all_candidates;}