KaliVeda  1.12/06
Heavy-Ion Analysis Toolkit
List of all members | Public Types | Public Member Functions | Public Attributes | List of all members
KVIdentificationResult Class Reference

Full result of one attempted particle identification.

When we attempt to identify a reconstructed charged particle (KVReconstructedNucleus) using an identification telescope (KVIDTelescope), we call the KVIDTelescope::Identify() method of the telescope in question, and the results of the identification attempt are stored in the KVIdentificationResult object.

The informations stored are:

Note that, apart from GetIDType() and GetComment() methods, all other informations are public member variables which can be accessed directly.

Definition at line 38 of file KVIdentificationResult.h.

Public Types

enum  { deltaEpedestal_UNKNOWN , deltaEpedestal_YES , deltaEpedestal_NO }
 
using grid_infos = std::unordered_map< std::string, std::vector< TString > >
 
- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 

Public Member Functions

 KVIdentificationResult ()
 
 KVIdentificationResult (const KVIdentificationResult &id)
 
void AddFlag (std::string grid_name, TString flag)
 
void Clear (Option_t *opt="")
 Reset to initial values. More...
 
void Copy (TObject &) const
 Copy this to obj. More...
 
const Char_tGetComment () const
 
TString GetFlagWhichBegins (std::string grid_name, TString flag_beginning)
 
TString GetFlagWhichBegins_AnyGrid (TString flag_beginning, std::string &grid_name)
 
const Char_tGetGridName () const
 
const Char_tGetIDType () const
 
Bool_t HasFlag (std::string grid_name, TString flag)
 
Bool_t HasFlag_AnyGrid (TString flag, std::string &grid_name)
 
Bool_t HasFlagWhichBegins (std::string grid_name, TString flag_beginning)
 
Bool_t HasFlagWhichBegins_AnyGrid (TString flag_beginning, std::string &grid_name)
 
TString IdentifyingGridGetFlagWhichBegins (TString flag_beginning)
 
Bool_t IdentifyingGridHasFlag (TString flag)
 
Bool_t IdentifyingGridHasFlagWhichBegins (TString flag_beginning)
 
KVIdentificationResultoperator= (const KVIdentificationResult &i)
 
void Print (Option_t *opt="") const
 
void SetComment (const Char_t *c)
 
void SetGridName (const Char_t *n)
 
void SetIDType (const Char_t *t)
 
- Public Member Functions inherited from KVBase
 KVBase ()
 Default constructor. More...
 
 KVBase (const Char_t *name, const Char_t *title="")
 Ctor for object with given name and type. More...
 
 KVBase (const KVBase &)
 copy ctor More...
 
virtual ~ KVBase ()
 
const Char_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () const
 
const Char_tGetType () const
 
Bool_t HasLabel () const
 
virtual Bool_t IsCalled (const Char_t *name) const
 
Bool_t IsLabelled (const Char_t *l) const
 
virtual Bool_t IsType (const Char_t *typ) const
 
virtual void List ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator More...
 
Double_t ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const
 
void SetLabel (const Char_t *lab)
 
virtual void SetNumber (UInt_t num)
 
virtual void SetType (const Char_t *str)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 
virtual TObjectClone (const char *newname="") const
 
virtual Int_t Compare (const TObject *obj) const
 
virtual void FillBuffer (char *&buffer)
 
virtual const char * GetName () const
 
virtual const char * GetTitle () const
 
virtual ULong_t Hash () const
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 
TNamedoperator= (const TNamed &rhs)
 
virtual void SetName (const char *name)
 
virtual void SetNameTitle (const char *name, const char *title)
 
virtual void SetTitle (const char *title="")
 
virtual Int_t Sizeof () const
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 
virtual ~TObject ()
 
void AbstractMethod (const char *method) const
 
virtual void AppendPad (Option_t *option="")
 
virtual void Browse (TBrowser *b)
 
ULong_t CheckedHash ()
 
virtual const char * ClassName () const
 
virtual void Delete (Option_t *option="")
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 
virtual void Draw (Option_t *option="")
 
virtual void DrawClass () const
 
virtual TObjectDrawClone (Option_t *option="") const
 
virtual void Dump () const
 
virtual void Error (const char *method, const char *msgfmt,...) const
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 
Bool_t HasInconsistentHash () const
 
virtual void Info (const char *method, const char *msgfmt,...) const
 
virtual Bool_t InheritsFrom (const char *classname) const
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 
virtual void Inspect () const
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 
virtual Bool_t IsFolder () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 
virtual Bool_t Notify ()
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 
virtual void Paint (Option_t *option="")
 
virtual void Pop ()
 
virtual Int_t Read (const char *name)
 
virtual void RecursiveRemove (TObject *obj)
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 
virtual void SetDrawOption (Option_t *option="")
 
virtual void SetUniqueID (UInt_t uid)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 

Public Attributes

Int_t A
 A of particle found (if Aident==kTRUE) More...
 
Bool_t Aident
 = kTRUE if A of particle established More...
 
Int_t deltaEpedestal
 special code for handling particles which give no signal in deltaE More...
 
grid_infos flags
 
Bool_t IDattempted
 =kTRUE if identification was attempted More...
 
Int_t IDcode
 a general identification code for this type of identification More...
 
Bool_t IDOK
 general quality of identification, =kTRUE if acceptable identification made More...
 
Int_t IDquality
 specific quality code returned by identification procedure More...
 
Double_t PID
 = "real" Z if Zident==kTRUE and Aident==kFALSE, "real" A if Zident==Aident==kTRUE More...
 
TString Rejecting_Cut
 name of cut in grid which rejected particle for identification More...
 
Int_t Z
 Z of particle found (if Zident==kTRUE) More...
 
Bool_t Zident
 =kTRUE if Z of particle established More...
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 

Additional Inherited Members

- Static Public Member Functions inherited from KVBase
static Bool_t AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
 Comparison between two 64-bit floating-point values. More...
 
static void BackupFileWithDate (const Char_t *path)
 
static void CombineFiles (const Char_t *file1, const Char_t *file2, const Char_t *newfilename, Bool_t keep=kTRUE)
 
static void Deprecated (const char *method, const char *advice)
 
static Bool_t FindClassSourceFiles (const Char_t *class_name, KVString &imp_file, KVString &dec_file, const Char_t *dir_name=".")
 
static Bool_t FindExecutable (TString &exec, const Char_t *path="$(PATH)")
 
static const Char_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (const Char_t *dataset, const Char_t *type, const Char_t *defval)
 
static Double_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Double_t defval)
 
static const Char_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources. More...
 
static const Char_tgitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (const Char_t *base, const Char_t *uri="0")
 
static Bool_t OpenContextMenu (const char *method, TObject *obj, const char *alt_method_name="")
 
static void OpenTempFile (TString &base, std::ofstream &fp)
 
static void PrintSplashScreen ()
 Prints welcome message and infos on version etc. More...
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ifstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ofstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchKVFile (const Char_t *name, TString &fullpath, const Char_t *kvsubdir="")
 
static const Char_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 
- Protected Attributes inherited from KVBase
TString fLabel
 label for the object More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

#include <KVIdentificationResult.h>

Inheritance diagram for KVIdentificationResult:
Inheritance graph
[legend]

Member Typedef Documentation

◆ grid_infos

using KVIdentificationResult::grid_infos = std::unordered_map<std::string, std::vector<TString> >

Definition at line 52 of file KVIdentificationResult.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
deltaEpedestal_UNKNOWN 
deltaEpedestal_YES 
deltaEpedestal_NO 

Definition at line 55 of file KVIdentificationResult.h.

Constructor & Destructor Documentation

◆ KVIdentificationResult() [1/2]

KVIdentificationResult::KVIdentificationResult ( )
inline

Definition at line 61 of file KVIdentificationResult.h.

◆ KVIdentificationResult() [2/2]

KVIdentificationResult::KVIdentificationResult ( const KVIdentificationResult id)
inline

copy constructor

Definition at line 66 of file KVIdentificationResult.h.

Member Function Documentation

◆ AddFlag()

void KVIdentificationResult::AddFlag ( std::string  grid_name,
TString  flag 
)
inline

add informational flag for the given grid

Definition at line 111 of file KVIdentificationResult.h.

◆ Clear()

void KVIdentificationResult::Clear ( Option_t opt = "")
virtual

Reset to initial values.

Reimplemented from KVBase.

Definition at line 36 of file KVIdentificationResult.cpp.

◆ Copy()

void KVIdentificationResult::Copy ( TObject obj) const
virtual

Copy this to obj.

Reimplemented from KVBase.

Definition at line 12 of file KVIdentificationResult.cpp.

◆ GetComment()

const Char_t* KVIdentificationResult::GetComment ( ) const
inline

Give an explanatory comment for the identification procedure quality code

Definition at line 95 of file KVIdentificationResult.h.

◆ GetFlagWhichBegins()

TString KVIdentificationResult::GetFlagWhichBegins ( std::string  grid_name,
TString  flag_beginning 
)
inline

return the informational flag with name beginning with flag_beginning set for the given grid

Definition at line 137 of file KVIdentificationResult.h.

◆ GetFlagWhichBegins_AnyGrid()

TString KVIdentificationResult::GetFlagWhichBegins_AnyGrid ( TString  flag_beginning,
std::string &  grid_name 
)
inline

return the informational flag with name beginning with flag_beginning set for the any grid if found, grid_name contains name of grid info was set for

Definition at line 193 of file KVIdentificationResult.h.

◆ GetGridName()

const Char_t* KVIdentificationResult::GetGridName ( ) const
inline

Give name of grid (VARY_VARX) used for identification

Definition at line 105 of file KVIdentificationResult.h.

◆ GetIDType()

const Char_t* KVIdentificationResult::GetIDType ( ) const
inline

Gives type of identification (= type of KVIDTelescope)

Definition at line 85 of file KVIdentificationResult.h.

◆ HasFlag()

Bool_t KVIdentificationResult::HasFlag ( std::string  grid_name,
TString  flag 
)
inline

return true if informational flag with exact name set for the given grid

Definition at line 117 of file KVIdentificationResult.h.

◆ HasFlag_AnyGrid()

Bool_t KVIdentificationResult::HasFlag_AnyGrid ( TString  flag,
std::string &  grid_name 
)
inline

return true if informational flag with exact name set for any grid if true, grid_name contains name of grid info was set for

Definition at line 170 of file KVIdentificationResult.h.

◆ HasFlagWhichBegins()

Bool_t KVIdentificationResult::HasFlagWhichBegins ( std::string  grid_name,
TString  flag_beginning 
)
inline

return true if informational flag with name beginning with flag_beginning set for the given grid

Definition at line 125 of file KVIdentificationResult.h.

◆ HasFlagWhichBegins_AnyGrid()

Bool_t KVIdentificationResult::HasFlagWhichBegins_AnyGrid ( TString  flag_beginning,
std::string &  grid_name 
)
inline

return true if informational flag with name beginning with flag_beginning set for any grid if true, grid_name contains name of grid info was set for

Definition at line 182 of file KVIdentificationResult.h.

◆ IdentifyingGridGetFlagWhichBegins()

TString KVIdentificationResult::IdentifyingGridGetFlagWhichBegins ( TString  flag_beginning)
inline

return the informational flag with name beginning with flag_beginning set for last grid used for identification (the one whose name is returned by GetGridName())

Definition at line 163 of file KVIdentificationResult.h.

◆ IdentifyingGridHasFlag()

Bool_t KVIdentificationResult::IdentifyingGridHasFlag ( TString  flag)
inline

return true if informational flag with exact name set for last grid used for identification (the one whose name is returned by GetGridName())

Definition at line 149 of file KVIdentificationResult.h.

◆ IdentifyingGridHasFlagWhichBegins()

Bool_t KVIdentificationResult::IdentifyingGridHasFlagWhichBegins ( TString  flag_beginning)
inline

return true if informational flag with name beginning with flag_beginning set for last grid used for identification (the one whose name is returned by GetGridName())

Definition at line 156 of file KVIdentificationResult.h.

◆ operator=()

KVIdentificationResult& KVIdentificationResult::operator= ( const KVIdentificationResult i)
inline

Definition at line 74 of file KVIdentificationResult.h.

◆ Print()

void KVIdentificationResult::Print ( Option_t opt = "") const
virtual

Reimplemented from KVBase.

Definition at line 60 of file KVIdentificationResult.cpp.

◆ SetComment()

void KVIdentificationResult::SetComment ( const Char_t c)
inline

Set an explanatory comment for the identification procedure quality code

Definition at line 90 of file KVIdentificationResult.h.

◆ SetGridName()

void KVIdentificationResult::SetGridName ( const Char_t n)
inline

Set name of grid (VARY_VARX) used for identification

Definition at line 100 of file KVIdentificationResult.h.

◆ SetIDType()

void KVIdentificationResult::SetIDType ( const Char_t t)
inline

Set type of identification (= type of KVIDTelescope)

Definition at line 80 of file KVIdentificationResult.h.

Member Data Documentation

◆ A

Int_t KVIdentificationResult::A

A of particle found (if Aident==kTRUE)

Definition at line 47 of file KVIdentificationResult.h.

◆ Aident

Bool_t KVIdentificationResult::Aident

= kTRUE if A of particle established

Definition at line 44 of file KVIdentificationResult.h.

◆ deltaEpedestal

Int_t KVIdentificationResult::deltaEpedestal

special code for handling particles which give no signal in deltaE

Definition at line 49 of file KVIdentificationResult.h.

◆ flags

grid_infos KVIdentificationResult::flags

Definition at line 53 of file KVIdentificationResult.h.

◆ IDattempted

Bool_t KVIdentificationResult::IDattempted

=kTRUE if identification was attempted

Definition at line 40 of file KVIdentificationResult.h.

◆ IDcode

Int_t KVIdentificationResult::IDcode

a general identification code for this type of identification

Definition at line 42 of file KVIdentificationResult.h.

◆ IDOK

Bool_t KVIdentificationResult::IDOK

general quality of identification, =kTRUE if acceptable identification made

Definition at line 41 of file KVIdentificationResult.h.

◆ IDquality

Int_t KVIdentificationResult::IDquality

specific quality code returned by identification procedure

Definition at line 45 of file KVIdentificationResult.h.

◆ PID

Double_t KVIdentificationResult::PID

= "real" Z if Zident==kTRUE and Aident==kFALSE, "real" A if Zident==Aident==kTRUE

Definition at line 48 of file KVIdentificationResult.h.

◆ Rejecting_Cut

TString KVIdentificationResult::Rejecting_Cut

name of cut in grid which rejected particle for identification

Definition at line 50 of file KVIdentificationResult.h.

◆ Z

Int_t KVIdentificationResult::Z

Z of particle found (if Zident==kTRUE)

Definition at line 46 of file KVIdentificationResult.h.

◆ Zident

Bool_t KVIdentificationResult::Zident

=kTRUE if Z of particle established

Definition at line 43 of file KVIdentificationResult.h.


The documentation for this class was generated from the following files: