Identification code structure for INDRA data (obsolete)

Id: KVINDRACodes.h,v 1.4 2009/04/06 15:05:55 franklan Exp

Author:

Author: franklan

Describes the identification and calibration status of reconstructed particles. Based on the codes figuring in veda_6.incl of the old VEDA programme.

GetVedaIDCode()  -  returns ID code in VEDA format (0 = gamma, 2 = id CsI/Phoswich, etc.)
GetVedaECode()   -  returns energy calibration code in VEDA format (1 =  calibration sans probleme, etc.)
 
GetIDStatus()    -  returns a string describing the identification status
                    e.g. if GetVedaIDCode()=0 then GetIDStatus()="gamma"
GetEStatus()     -  returns a string describing the calibration status
                    e.g. if GetVedaECode()=0 then GetEStatus()="Aucun appel a une routine de calibration effectuee"

WARNING: the methods GetIDCode() and GetECode() return the new bit-mask status codes defined in class KVINDRACodeMask.

If you prefer to use these masks, the best way to test the status of the particles is by using KVINDRACodeMask::TestIDCode and KVINDRACodeMask::TestECode

e.g. to test if a particle was identified using CsI R-L you have three choices (supposing the particle is referenced by KVINDRAReconNuc* part):

EITHER   if( part->GetCodes().GetVedaIDCode() == 2 ) { ... }
OR       if( part->GetCodes().TestIDCode( kIDCode2 ) ) { ... }
OR       if( part->GetCodes().TestIDCode( kIDCode_CsI ) ) { ... ]

Obviously, the third method is to be preferred (it is immediately clear what the instruction means)!!

Definition at line 41 of file KVINDRACodes.h.

Public Types
enum	{ kIsoRes = BIT(14) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Member Functions
	KVINDRACodes ()

virtual	~ KVINDRACodes ()

void	Clear (Option_t *opt="")
	resets all id subcodes. More...

UChar_t	GetCodeIndex (UShort_t)

UChar_t	GetECode ()
	Returns energy calibration code in the form of EVedaCodes or EIDCodes bitmask. More...

const Char_t *	GetEStatus ()
	Give an explanation for the calibration code. More...

UShort_t	GetIDCode ()
	Returns identification code in the form of EVedaCodes or EIDCodes bitmask. More...

const Char_t *	GetIDStatus ()
	Give an explanation for the ID code. More...

UChar_t	GetVedaECode ()
	Returns VEDA6 energy calibration code. More...

UChar_t	GetVedaIDCode ()
	Returns VEDA6 identification code. More...

void	SetECode (UChar_t)
	Set E code - the argument given is one of the EVedaCodes or EIDCodes bitmasks. More...

void	SetIDCode (UShort_t)
	Set ID code - the argument given is one of the EVedaCodes or EIDCodes bitmasks. More...

void	SetVedaECode (UChar_t)
	Set E code - the argument given is the old VEDA6 code number. More...

void	SetVedaIDCode (UChar_t)
	Set ID code - the argument given is the old VEDA6 code number. More...

Public Member Functions inherited from KVINDRACodeMask
	KVINDRACodeMask ()

virtual	~ KVINDRACodeMask ()

	ClassDef (KVINDRACodeMask, 1)

void	Copy (TObject &object) const

UChar_t	GetEMask ()

UShort_t	GetIDMask ()

Bool_t	IsNull () const

Bool_t	operator& (KVINDRACodeMask &msk)

void	SetEMask (UChar_t codes)

void	SetIDMask (UShort_t codes)

Bool_t	TestECode (UChar_t code)

Bool_t	TestIDCode (UShort_t code)

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 TObject *	Clone (const char *newname="") const

virtual Int_t	Compare (const TObject *obj) 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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual const char *	GetName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

virtual ULong_t	Hash () const

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

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") 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)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual void	Print (Option_t *option="") const

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

Static Public Member Functions
static UChar_t	VedaECodeToBitmask (UChar_t veda_e_code)

static UShort_t	VedaIDCodeToBitmask (UChar_t veda_id_code)

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)

Static Private Attributes
static Char_t	fCodeGenCalib [8][120]

static Char_t	fCodeGenIdent [14][120]

static UChar_t	fEBits [16]

static UChar_t	fECodes [8] = { 0, 1, 2, 3, 11, 15, 4, 5 }

static UShort_t	fIDBits [16]

static UChar_t	fIDCodes [14]

Friends
class	KVINDRAReconNuc

Additional Inherited Members
Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

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 TObject
	kOnlyPrepStep

#include <KVINDRACodes.h>

Inheritance diagram for KVINDRACodes:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kIsoRes

Definition at line 55 of file KVINDRACodes.h.

Constructor & Destructor Documentation

◆ KVINDRACodes()

KVINDRACodes::KVINDRACodes ( )

Definition at line 102 of file KVINDRACodes.cpp.

◆ ~ KVINDRACodes()

virtual KVINDRACodes::~ KVINDRACodes ( )

inlinevirtual

Definition at line 60 of file KVINDRACodes.h.

Member Function Documentation

◆ Clear()

void KVINDRACodes::Clear ( Option_t * opt = "" )

virtual

resets all id subcodes.

Reimplemented from KVINDRACodeMask.

Definition at line 281 of file KVINDRACodes.cpp.

◆ GetCodeIndex()

UChar_t KVINDRACodes::GetCodeIndex ( UShort_t mask )

Argument is a bit-mask representing particle ID or E code Returns the number of the bit which is set to 1 (right-most bit is 0). Result is corresponding index in arrays fCodeGenIdent, fIDCodes, etc.

Definition at line 186 of file KVINDRACodes.cpp.

◆ GetECode()

UChar_t KVINDRACodes::GetECode ( )

Returns energy calibration code in the form of EVedaCodes or EIDCodes bitmask.

Definition at line 243 of file KVINDRACodes.cpp.

◆ GetEStatus()

const Char_t * KVINDRACodes::GetEStatus ( )

Give an explanation for the calibration code.

Definition at line 124 of file KVINDRACodes.cpp.

◆ GetIDCode()

UShort_t KVINDRACodes::GetIDCode ( )

Returns identification code in the form of EVedaCodes or EIDCodes bitmask.

Definition at line 231 of file KVINDRACodes.cpp.

◆ GetIDStatus()

const Char_t * KVINDRACodes::GetIDStatus ( )

Give an explanation for the ID code.

Definition at line 112 of file KVINDRACodes.cpp.

◆ GetVedaECode()

UChar_t KVINDRACodes::GetVedaECode ( )

Returns VEDA6 energy calibration code.

Definition at line 219 of file KVINDRACodes.cpp.

◆ GetVedaIDCode()

UChar_t KVINDRACodes::GetVedaIDCode ( )

Returns VEDA6 identification code.

Definition at line 207 of file KVINDRACodes.cpp.

◆ SetECode()

void KVINDRACodes::SetECode ( UChar_t icod )

Set E code - the argument given is one of the EVedaCodes or EIDCodes bitmasks.

Definition at line 172 of file KVINDRACodes.cpp.

◆ SetIDCode()

void KVINDRACodes::SetIDCode ( UShort_t icod )

Set ID code - the argument given is one of the EVedaCodes or EIDCodes bitmasks.

Definition at line 160 of file KVINDRACodes.cpp.

◆ SetVedaECode()

void KVINDRACodes::SetVedaECode ( UChar_t icod )

Set E code - the argument given is the old VEDA6 code number.

Definition at line 148 of file KVINDRACodes.cpp.

◆ SetVedaIDCode()

void KVINDRACodes::SetVedaIDCode ( UChar_t icod )

Set ID code - the argument given is the old VEDA6 code number.

Definition at line 136 of file KVINDRACodes.cpp.

◆ VedaECodeToBitmask()

UChar_t KVINDRACodes::VedaECodeToBitmask ( UChar_t veda_e_code )

static

Static method Returns bitmask equivalent for old VEDA ID code

Definition at line 269 of file KVINDRACodes.cpp.

◆ VedaIDCodeToBitmask()

UShort_t KVINDRACodes::VedaIDCodeToBitmask ( UChar_t veda_id_code )

static

Static method Returns bitmask equivalent for old VEDA ID code

Definition at line 256 of file KVINDRACodes.cpp.

Friends And Related Function Documentation

◆ KVINDRAReconNuc

friend class KVINDRAReconNuc

friend

Definition at line 43 of file KVINDRACodes.h.

Member Data Documentation

◆ fCodeGenCalib

Char_t KVINDRACodes::fCodeGenCalib

staticprivate

Initial value:

= {
   "Aucun appel a une routine de calibration effectuee",
   "Calibration sans probleme (toute les routines ont retourne le code 1)",
   "Warning : Une des routines a retourne un code different de 1",
   "Warning specifique au CSI : E_CsI > E_Max du CsI",
   "Detecteur en panne (CHIO ou SI): perte d'energie dans ce detecteur calcule par Veda",
   "Rejet : Une des routines a retourne un code de rejet.",
   "One or more detectors hit by more than one particle, energy loss calculated for this detector",
   "Coherency test of energy losses reveals presence of other particles"
}

Definition at line 47 of file KVINDRACodes.h.

◆ fCodeGenIdent

Char_t KVINDRACodes::fCodeGenIdent

staticprivate

Initial value:

= {
   "gamma",
   "neutron (seulement couronnes 2 a 9)",
   "part. ident. dans CsI ou Phoswich (OK + 8Be)",
   "fragment identifie dans Si-CsI ou fragment ident. dans Si75-SiLi ou SiLi-CsI",
   "fragment identifie dans ChIo-Si/ChIo-CsI ou fragment ou part. identifie dans ChIo-Si75",
   "fragment non-ident. (montee de Bragg)(Z min.) ou stoppe dans Chio (Z min)",
   "frag. cree par la coherence CsI  (stoppe ds Si.)",
   "frag. cree par la coherence ChIo (stoppe ds ChIo)",
   "multiple comptage dans ChIo avec arret: - dans les siliciums (cour. 2-9); - dans les CsI (cour. 10-17)",
   "ident. incomplete dans CsI ou Phoswich (Z.min)",
   "ident. 'entre les lignes' dans CsI",
   "ident. Z=2 due a l'inversion CHIO (Argon)",
   "Particule restee non identifiee (a rejeter)",
   "frag. ou part. rejete"
}

Definition at line 46 of file KVINDRACodes.h.

◆ fEBits

UChar_t KVINDRACodes::fEBits

staticprivate

Initial value:

= {
   kECode0,
   kECode1,
   kECode2,
   kECode3,
   kECode4,
   kECode5,
   0,
   0,
   0,
   0,
   0,
   kECode11,
   0,
   0,
   0,
   kECode15
}

Definition at line 51 of file KVINDRACodes.h.

◆ fECodes

UChar_t KVINDRACodes::fECodes = { 0, 1, 2, 3, 11, 15, 4, 5 }

staticprivate

Definition at line 49 of file KVINDRACodes.h.

◆ fIDBits

UShort_t KVINDRACodes::fIDBits

staticprivate

Initial value:

= {
   kIDCode0,
   kIDCode1,
   kIDCode2,
   kIDCode3,
   kIDCode4,
   kIDCode5,
   kIDCode6,
   kIDCode7,
   kIDCode8,
   kIDCode9,
   kIDCode10,
   kIDCode11,
   0,
   0,
   kIDCode14,
   kIDCode15
}

Definition at line 50 of file KVINDRACodes.h.

◆ fIDCodes

UChar_t KVINDRACodes::fIDCodes

staticprivate

Initial value:

=

{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 14, 15 }

Definition at line 48 of file KVINDRACodes.h.

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

kaliveda.doxygen/KVIndra/identification/KVINDRACodes.h
kaliveda.doxygen/KVIndra/identification/KVINDRACodes.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ KVINDRACodes()

◆ ~ KVINDRACodes()

Member Function Documentation

◆ Clear()

◆ GetCodeIndex()

◆ GetECode()

◆ GetEStatus()

◆ GetIDCode()

◆ GetIDStatus()

◆ GetVedaECode()

◆ GetVedaIDCode()

◆ SetECode()

◆ SetIDCode()

◆ SetVedaECode()

◆ SetVedaIDCode()

◆ VedaECodeToBitmask()

◆ VedaIDCodeToBitmask()

Friends And Related Function Documentation

◆ KVINDRAReconNuc

Member Data Documentation

◆ fCodeGenCalib

◆ fCodeGenIdent

◆ fEBits

◆ fECodes

◆ fIDBits

◆ fIDCodes