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

Handles a set of Tassan-Got functional-based identifications (KVTGID objects) for use by a KVIDTelescope.

IdentZ and IdentA are, respectively, Z and A identification procedures. Their purpose is to retrieve the correct KVTGID identification object from the manager's list, and then use KVTGID::GetIdentification.

Status code for last identification with IdentZ and IdentA can be obtained using GetStatus/GetStatusString.

1 KVTGIDManager::kStatus_noTGID "no KVTGID for requested identification",
2 KVTGIDManager::kStatus_OutOfIDRange "point to identify outside of identification range of function",
3 KVTGIDManager::kStatus_ZtooSmall "IdentA called with Z<1",
4 KVTGIDManager::kStatus_ZtooLarge "IdentA called with Z larger than max Z defined for KVTGIDZA isotopic identification object"

Definition at line 40 of file KVTGIDManager.h.

Public Types

enum  ETGIDMStatus {
  kStatus_OK , kStatus_noTGID , kStatus_OutOfIDRange , kStatus_ZtooSmall ,
  kStatus_ZtooLarge , kCurrentStatus
}
 status codes for IdentZ/IdentA More...
 

Public Member Functions

 KVTGIDManager ()
 Default constructor. More...
 
virtual ~ KVTGIDManager ()
 
virtual void AddTGID (KVTGID *)
 
Double_t GetIDmax () const
 
const KVListGetListOfIDFunctions () const
 
virtual Int_t GetStatus () const
 
virtual const Char_tGetStatusString (ETGIDMStatus s=kCurrentStatus) const
 
virtual KVTGIDGetTGID (const Char_t *idt_name, const Char_t *id_type, const Char_t *grid_type)
 
KVTGIDGetTGID (const Char_t *name)
 Retrieve the identification object with name. More...
 
virtual KVTGIDGridGetTGIDGrid (const Char_t *idt_name, const Char_t *id_type, const Char_t *grid_type, Double_t xmax, Double_t xmin=0., Int_t ID_min=0, Int_t ID_max=0, Int_t npoints=100, Bool_t logscale=kFALSE)
 
virtual KVTGIDGridGetTGIDGrid (const Char_t *tgid_name, Double_t xmax, Double_t xmin=0., Int_t ID_min=0, Int_t ID_max=0, Int_t npoints=100, Bool_t logscale=kFALSE)
 
virtual KVTGIDGridGetTGIDGrid (KVTGID *tgid, Double_t xmax, Double_t xmin=0., Int_t ID_min=0, Int_t ID_max=0, Int_t npoints=100, Bool_t logscale=kFALSE)
 
const Char_tGetTGIDName (const Char_t *idt_name, const Char_t *id_type, const Char_t *grid_type)
 
virtual Double_t IdentA (const Char_t *, Double_t, Double_t, Double_t &funLTG, const Char_t *grid_type, Int_t Z)
 
virtual Double_t IdentZ (const Char_t *, Double_t, Double_t, Double_t &funLTG, const Char_t *grid_type)
 
virtual void RemoveAllTGID ()
 Delete all identification objects. More...
 
virtual void RemoveTGID (const Char_t *name)
 Delete the identification object with name. More...
 
void SetStatus (ETGIDMStatus s)
 

Protected Attributes

Double_t fID_max
 maximum ID of all TGID objects More...
 
KVList fIDList
 KVTGID objects for identifications. More...
 
Int_t fStatus
 transient member used to hold status of last call to IdentZ/IdentA More...
 

#include <KVTGIDManager.h>

Inheritance diagram for KVTGIDManager:
Inheritance graph
[legend]

Member Enumeration Documentation

◆ ETGIDMStatus

status codes for IdentZ/IdentA

Enumerator
kStatus_OK 
kStatus_noTGID 
kStatus_OutOfIDRange 
kStatus_ZtooSmall 
kStatus_ZtooLarge 
kCurrentStatus 

Definition at line 49 of file KVTGIDManager.h.

Constructor & Destructor Documentation

◆ KVTGIDManager()

KVTGIDManager::KVTGIDManager ( )

Default constructor.

Definition at line 20 of file KVTGIDManager.cpp.

◆ ~ KVTGIDManager()

virtual KVTGIDManager::~ KVTGIDManager ( )
virtual

Member Function Documentation

◆ AddTGID()

void KVTGIDManager::AddTGID ( KVTGID _tgid)
virtual

Add an identification object to the list. It will be deleted when the KVTGIDManager is deleted.

Reimplemented in KVRTGIDManager.

Definition at line 43 of file KVTGIDManager.cpp.

◆ GetIDmax()

Double_t KVTGIDManager::GetIDmax ( ) const
inline

Definition at line 75 of file KVTGIDManager.h.

◆ GetListOfIDFunctions()

const KVList& KVTGIDManager::GetListOfIDFunctions ( ) const
inline

Definition at line 71 of file KVTGIDManager.h.

◆ GetStatus()

virtual Int_t KVTGIDManager::GetStatus ( void  ) const
inlinevirtual

Definition at line 98 of file KVTGIDManager.h.

◆ GetStatusString()

const Char_t * KVTGIDManager::GetStatusString ( ETGIDMStatus  s = kCurrentStatus) const
virtual

Returns explanatory message for status code 's' If no code argument is given, the status string corresponds to the current value of GetStatus(), i.e. only valid if an identification has just been performed

Definition at line 384 of file KVTGIDManager.cpp.

◆ GetTGID() [1/2]

KVTGID * KVTGIDManager::GetTGID ( const Char_t idt_name,
const Char_t id_type,
const Char_t grid_type 
)
virtual

Retrieve the identification object using: idt_name = name of ID telescope id_type = type of identification ("Z", "A", "A_for_Z=3", etc.) grid_type = type of identification grid ("GG", "PG1", etc.)

Reimplemented in KVRTGIDManager.

Definition at line 108 of file KVTGIDManager.cpp.

◆ GetTGID() [2/2]

KVTGID * KVTGIDManager::GetTGID ( const Char_t name)

Retrieve the identification object with name.

Definition at line 57 of file KVTGIDManager.cpp.

◆ GetTGIDGrid() [1/3]

KVTGIDGrid * KVTGIDManager::GetTGIDGrid ( const Char_t idt_name,
const Char_t id_type,
const Char_t grid_type,
Double_t  xmax,
Double_t  xmin = 0.,
Int_t  ID_min = 0,
Int_t  ID_max = 0,
Int_t  npoints = 100,
Bool_t  logscale = kFALSE 
)
virtual

Generates and returns a pointer to a KVIDGrid object permitting to visualise the effective identification lines represented by the Tassan-Got functional of ID telescope "idt_name", of identification type "id_type", and identification grid type "grid_type". The KVIDGrid object must be deleted by the user. See KVTGID::MakeIDGrid for meaning of other arguments.

Definition at line 359 of file KVTGIDManager.cpp.

◆ GetTGIDGrid() [2/3]

KVTGIDGrid * KVTGIDManager::GetTGIDGrid ( const Char_t tgid_name,
Double_t  xmax,
Double_t  xmin = 0.,
Int_t  ID_min = 0,
Int_t  ID_max = 0,
Int_t  npoints = 100,
Bool_t  logscale = kFALSE 
)
virtual

Generates and returns a pointer to a KVIDGrid object permitting to visualise the effective identification lines represented by the Tassan-Got functional "tgid_name". The KVIDGrid object must be deleted by the user. See KVTGID::MakeIDGrid for meaning of other arguments.

Definition at line 336 of file KVTGIDManager.cpp.

◆ GetTGIDGrid() [3/3]

KVTGIDGrid * KVTGIDManager::GetTGIDGrid ( KVTGID tgid,
Double_t  xmax,
Double_t  xmin = 0.,
Int_t  ID_min = 0,
Int_t  ID_max = 0,
Int_t  npoints = 100,
Bool_t  logscale = kFALSE 
)
virtual

Generates and returns a pointer to a KVIDGrid object permitting to visualise the effective identification lines represented by the Tassan-Got functional "tgid". The KVIDGrid object must be deleted by the user. See KVTGID::MakeIDGrid for meaning of other arguments.

Definition at line 311 of file KVTGIDManager.cpp.

◆ GetTGIDName()

const Char_t * KVTGIDManager::GetTGIDName ( const Char_t idt_name,
const Char_t id_type,
const Char_t grid_type 
)

Return unique name for KVTGID object using: idt_name = name of ID telescope id_type = type of identification ("Z", "A", "A_for_Z=3", etc.) grid_type = type of identification grid ("GG", "PG1", etc.)

Definition at line 128 of file KVTGIDManager.cpp.

◆ IdentA()

Double_t KVTGIDManager::IdentA ( const Char_t idtelescope_name,
Double_t  id_map_X,
Double_t  id_map_Y,
Double_t funLTG,
const Char_t grid_type,
Int_t  Z 
)
virtual

Get A identification (we already know Z) for ID telescope idt using grid "grid_type". The "signal_type" argument is passed to GetIDMapX/Y(signal_type), in case "grid_type" and "signal_type" are not exactly the same.

funLTG is the ABSOLUTE value of the Tassan-Got function for the Z and the calculated A i.e. in an ideal world it should equal zero. This gives an idea of the quality of the identification. funLTG = 0 -> identification parfaite funLTG = -1 -> no identification

Definition at line 225 of file KVTGIDManager.cpp.

◆ IdentZ()

Double_t KVTGIDManager::IdentZ ( const Char_t idtelescope_name,
Double_t  id_map_X,
Double_t  id_map_Y,
Double_t funLTG,
const Char_t grid_type 
)
virtual

Identification in Z of particle for ID telescope idt using Tassan-Got functional corresponding to grid of type "grid_type". The "signal_type" argument is passed to GetIDMapX/Y(signal_type), in case "grid_type" and "signal_type" are not exactly the same.

funLTG gives distance to identification line (absolute value of LTG function for the Z we find) funLTG = 0 -> identification parfaite funLTG = -1 -> no identification If the point to identify is outside of the range of the identification for this 'grid_type' (not between Zmin and Zmax) then we return -1 and funLTG=-1. if no identification of the required type exists, we return -1. and funLTG=-1.

Definition at line 154 of file KVTGIDManager.cpp.

◆ RemoveAllTGID()

void KVTGIDManager::RemoveAllTGID ( )
virtual

Delete all identification objects.

Reimplemented in KVRTGIDManager.

Definition at line 92 of file KVTGIDManager.cpp.

◆ RemoveTGID()

void KVTGIDManager::RemoveTGID ( const Char_t name)
virtual

Delete the identification object with name.

Reimplemented in KVRTGIDManager.

Definition at line 69 of file KVTGIDManager.cpp.

◆ SetStatus()

void KVTGIDManager::SetStatus ( ETGIDMStatus  s)
inline

Definition at line 102 of file KVTGIDManager.h.

Member Data Documentation

◆ fID_max

Double_t KVTGIDManager::fID_max
protected

maximum ID of all TGID objects

Definition at line 43 of file KVTGIDManager.h.

◆ fIDList

KVList KVTGIDManager::fIDList
protected

KVTGID objects for identifications.

Definition at line 42 of file KVTGIDManager.h.

◆ fStatus

Int_t KVTGIDManager::fStatus
protected

transient member used to hold status of last call to IdentZ/IdentA

Definition at line 44 of file KVTGIDManager.h.


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