KLMDigit Class Reference

KLM digit (class representing a digitized hit in RPCs or scintillators). More...

#include <KLMDigit.h>

Inheritance diagram for KLMDigit:

Collaboration diagram for KLMDigit:

Public Types
enum	EAppendStatus {   c_DontAppend = 0 ,   c_Append = 1 }
	Enum for return state of addBGDigit function. More...

Public Member Functions
	KLMDigit ()
	Constructor.
	KLMDigit (const KLMSimHit *simHit)
	Constructor for scintillator simulation. More...
	KLMDigit (const KLMSimHit *simHit, int strip)
	Constructor for RPC simulation. More...
	~KLMDigit ()
	Destructor.
unsigned int	getUniqueChannelID () const override
	Get unique channel identifier.
EAppendStatus	addBGDigit (const DigitBase *bg) override
	The pile-up method.
int	getSubdetector () const
	Get subdetector number. More...
void	setSubdetector (int subdetector)
	Set subdetector number. More...
int	getSection () const
	Get section number. More...
void	setSection (int section)
	Set section number. More...
int	getSector () const
	Get sector number. More...
void	setSector (int sector)
	Set sector number. More...
int	getLayer () const
	Get layer number. More...
void	setLayer (int layer)
	Set layer number. More...
int	getPlane () const
	Get plane number. More...
void	setPlane (int plane)
	Set plane number. More...
int	getStrip () const
	Get strip number. More...
void	setStrip (int strip)
	Set strip number. More...
int	getLastStrip () const
	Get last strip number (for multi-strip digits). More...
void	setLastStrip (int lastStrip)
	Set last strip number (for multi-strip digits). More...
bool	isMultiStrip () const
	Determine whether this digit is a multi-strip one or not.
bool	inRPC () const
	Determine whether the hit is in RPC or scintillator. More...
bool	isPhiReadout () const
	Whether BKLM digit is in phi or z plane. More...
uint16_t	getCharge () const
	Get charge. More...
void	setCharge (uint16_t charge)
	Set charge. More...
uint16_t	getCTime () const
	Get CTIME. More...
void	setCTime (uint16_t ctime)
	Set CTIME. More...
uint16_t	getTDC () const
	Get TDC. More...
void	setTDC (uint16_t tdc)
	Set TDC. More...
float	getTime () const
	Get hit time. More...
void	setTime (float time)
	Set hit time. More...
float	getEnergyDeposit () const
	Get energy deposit. More...
void	setEnergyDeposit (float eDep)
	Set energy deposit. More...
float	getNPhotoelectrons () const
	Get number of photoelectrons. More...
void	setNPhotoelectrons (float nPhotoelectrons)
	Set number of photoelectrons. More...
int	getNGeneratedPhotoelectrons () const
	Get generated number of photoelectrons. More...
void	setNGeneratedPhotoelectrons (int nPhotoelectrons)
	Set generated number of photoelectrons. More...
bool	isGood () const
	Whether hit could be used late (if it passed discriminator threshold) More...
int	getFitStatus () const
	Get fit status. More...
void	setFitStatus (int s)
	Set fit status. More...
float	getMCTime () const
	Get MC time. More...
void	setMCTime (float time)
	Set MC time. More...
float	getSiPMMCTime () const
	Get SiPM MC time. More...
void	setSiPMMCTime (float time)
	Set SiPM MC time. More...
virtual void	adjustAppendedBGDigit ()
	Virtual method for possible modification of BG digit which is just appended to simulation store array.
void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching). More...
void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow). More...
void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...
template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array. More...
template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object. More...
template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array. More...
template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation. More...
template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation. More...
template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation. More...
template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array. More...
template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array. More...
template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array. More...
virtual std::string	getName () const
	Return a short name that describes this object, e.g. More...
virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format. More...
std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...
std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.
int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Protected Member Functions
	ClassDefOverride (Belle2::KLMDigit, 1)
	Class version.
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Protected Attributes
const KLMElementNumbers *	m_ElementNumbers
	Element numbers.
int	m_Subdetector
	ROOT streamer. More...
int	m_Section
	Number of section.
int	m_Sector
	Number of sector.
int	m_Layer
	Number of layer.
int	m_Plane
	Number of plane.
int	m_Strip
	Number of strip.
int	m_LastStrip
	Number of last strip (for multi-strip digits). More...
uint16_t	m_Charge
	Charge (integral of ADC signal).
uint16_t	m_CTime
	CTIME (time provided by B2TT).
uint16_t	m_TDC
	TDC (time provided by ASIC).
float	m_Time
	Time of the hit.
float	m_EnergyDeposit
	Energy deposition.
float	m_NPhotoelectrons
	Number of photoelectrons.
int	m_NGeneratedPhotoelectrons
	Generated number of photoelectrons (MC only).
int	m_FitStatus
	Fit status.
float	m_MCTime
	MC time.
float	m_SiPMMCTime
	MC time at SiPM.

Private Member Functions
	ClassDef (DigitBase, 2)
	ClassDef.

Private Attributes
DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.
int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Detailed Description

KLM digit (class representing a digitized hit in RPCs or scintillators).

Definition at line 29 of file KLMDigit.h.

Member Enumeration Documentation

EAppendStatus

enum EAppendStatus

inherited

Enum for return state of addBGDigit function.

Enumerator
c_DontAppend	do not append BG digit to digits
c_Append	append BG digit to digits

Definition at line 32 of file DigitBase.h.

Constructor & Destructor Documentation

KLMDigit() [1/2]

KLMDigit ( const KLMSimHit *  simHit )

explicit

Constructor for scintillator simulation.

Parameters

[in]

simHit

Simulation hit.

Definition at line 39 of file KLMDigit.cc.

                                          :
  m_ElementNumbers(&(KLMElementNumbers::Instance())),
  m_Subdetector(simHit->getSubdetector()),
  m_Section(simHit->getSection()),
  m_Sector(simHit->getSector()),
  m_Layer(simHit->getLayer()),
  m_Plane(simHit->getPlane()),
  m_Strip(simHit->getStrip()),
  m_LastStrip(0),
  m_Charge(0),
  m_CTime(0),
  m_TDC(0),
  m_Time(simHit->getTime() + simHit->getPropagationTime()),
  m_EnergyDeposit(simHit->getEnergyDeposit()),
  m_NPhotoelectrons(0),
  m_NGeneratedPhotoelectrons(0),
  m_FitStatus(0),
  m_MCTime(simHit->getTime()),
  m_SiPMMCTime(0)
{
}

KLMDigit() [2/2]

KLMDigit	(	const KLMSimHit *	simHit,
		int	strip
	)

Constructor for RPC simulation.

Parameters

[in]	simHit	Simulation hit.
[in]	strip	Strip.

Definition at line 61 of file KLMDigit.cc.

Member Function Documentation

addRelationTo() [1/2]

void addRelationTo ( const RelationsInterface< BASE > *  object, float  weight = 1.0, const std::string &  namedRelation = ""  ) const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

addRelationTo() [2/2]

void addRelationTo ( const TObject *  object, float  weight = 1.0, const std::string &  namedRelation = ""  ) const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

copyRelations()

void copyRelations ( const RelationsInterface< BASE > *  sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

getCharge()

uint16_t getCharge ( void  ) const

inline

Get charge.

Returns

Charge.

Definition at line 222 of file KLMDigit.h.

    {
      return m_Charge;
    }

getCTime()

uint16_t getCTime ( ) const

inline

Get CTIME.

Returns

CTIME.

Definition at line 240 of file KLMDigit.h.

getEnergyDeposit()

float getEnergyDeposit ( ) const

inline

Get energy deposit.

Returns

Energy deposit.

Definition at line 294 of file KLMDigit.h.

getFitStatus()

int getFitStatus ( ) const

inline

Get fit status.

Returns

Fit status.

Definition at line 357 of file KLMDigit.h.

getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note

: You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also

Particle::getInfoHTML() for a more complex example.

HTML for some utility functions.

Use getInfo() to get a raw text version of this output.

Reimplemented in RecoTrack, TRGSummary, TrackFitResult, Track, SoftwareTriggerResult, PIDLikelihood, MCParticle, Cluster, and Particle.

Definition at line 362 of file RelationsObject.h.

getLastStrip()

int getLastStrip ( ) const

inline

Get last strip number (for multi-strip digits).

Returns

Last strip number.

Definition at line 180 of file KLMDigit.h.

getLayer()

int getLayer ( ) const

inline

Get layer number.

Returns

Layer number.

Definition at line 126 of file KLMDigit.h.

getMCTime()

float getMCTime ( ) const

inline

Get MC time.

Returns

MC time.

Definition at line 375 of file KLMDigit.h.

getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

getNGeneratedPhotoelectrons()

int getNGeneratedPhotoelectrons ( ) const

inline

Get generated number of photoelectrons.

Returns

Number of photoelectrons.

Definition at line 330 of file KLMDigit.h.

getNPhotoelectrons()

float getNPhotoelectrons ( ) const

inline

Get number of photoelectrons.

Returns

Number of photoelectrons.

Definition at line 312 of file KLMDigit.h.

getPlane()

int getPlane ( ) const

inline

Get plane number.

Returns

Plane number.

Definition at line 144 of file KLMDigit.h.

getRelated()

T* getRelated ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

getRelatedFrom()

FROM* getRelatedFrom ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

getRelatedFromWithWeight()

std::pair<FROM*, float> getRelatedFromWithWeight ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

getRelatedTo()

TO* getRelatedTo ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

getRelatedToWithWeight()

std::pair<TO*, float> getRelatedToWithWeight ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

getRelatedWithWeight()

std::pair<T*, float> getRelatedWithWeight ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

getRelationsFrom()

RelationVector<FROM> getRelationsFrom ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 212 of file RelationsObject.h.

getRelationsTo()

RelationVector<TO> getRelationsTo ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 197 of file RelationsObject.h.

getRelationsWith()

RelationVector<T> getRelationsWith ( const std::string &  name = "", const std::string &  namedRelation = ""  ) const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 230 of file RelationsObject.h.

getSection()

int getSection ( ) const

inline

Get section number.

Returns

Section number.

Definition at line 90 of file KLMDigit.h.

getSector()

int getSector ( ) const

inline

Get sector number.

Returns

Sector number.

Definition at line 108 of file KLMDigit.h.

getSiPMMCTime()

float getSiPMMCTime ( ) const

inline

Get SiPM MC time.

Returns

SiPM MC yime.

Definition at line 393 of file KLMDigit.h.

getStrip()

int getStrip ( ) const

inline

Get strip number.

Returns

Strip number.

Definition at line 162 of file KLMDigit.h.

getSubdetector()

int getSubdetector ( ) const

inline

Get subdetector number.

Returns

Subdetector number.

Definition at line 72 of file KLMDigit.h.

getTDC()

uint16_t getTDC ( ) const

inline

Get TDC.

Returns

TDC.

Definition at line 258 of file KLMDigit.h.

getTime()

float getTime ( ) const

inline

Get hit time.

Returns

Hit time.

Definition at line 276 of file KLMDigit.h.

inRPC()

bool inRPC ( ) const

inline

Determine whether the hit is in RPC or scintillator.

Returns

Whether hit is in RPC (true) or scintillator (false).

Definition at line 206 of file KLMDigit.h.

isGood()

bool isGood ( ) const

inline

Whether hit could be used late (if it passed discriminator threshold)

Returns

True if could be used.

Definition at line 348 of file KLMDigit.h.

isPhiReadout()

bool isPhiReadout

(

)

const

Whether BKLM digit is in phi or z plane.

Returns

True if the digit is in phi plane, false otherwise.

Definition at line 110 of file KLMDigit.cc.

setCharge()

void setCharge ( uint16_t  charge )

inline

Set charge.

Parameters

[in]

charge

Charge.

Definition at line 231 of file KLMDigit.h.

setCTime()

void setCTime ( uint16_t  ctime )

inline

Set CTIME.

Parameters

[in]

ctime

CTime

Definition at line 249 of file KLMDigit.h.

setEnergyDeposit()

void setEnergyDeposit ( float  eDep )

inline

Set energy deposit.

Parameters

[in]

eDep

Energy deposit.

Definition at line 303 of file KLMDigit.h.

setFitStatus()

void setFitStatus ( int  s )

inline

Set fit status.

Parameters

[in]

s

Fit status.

Definition at line 366 of file KLMDigit.h.

setLastStrip()

void setLastStrip ( int  lastStrip )

inline

Set last strip number (for multi-strip digits).

Parameters

[in]

lastStrip

Last strip number.

Definition at line 189 of file KLMDigit.h.

setLayer()

void setLayer ( int  layer )

inline

Set layer number.

Parameters

[in]

layer

Layer number.

Definition at line 135 of file KLMDigit.h.

setMCTime()

void setMCTime ( float  time )

inline

Set MC time.

Parameters

[in]

time

MC time.

Definition at line 384 of file KLMDigit.h.

setNGeneratedPhotoelectrons()

void setNGeneratedPhotoelectrons ( int  nPhotoelectrons )

inline

Set generated number of photoelectrons.

Parameters

[in]

nPhotoelectrons

Number of photoelectrons.

Definition at line 339 of file KLMDigit.h.

setNPhotoelectrons()

void setNPhotoelectrons ( float  nPhotoelectrons )

inline

Set number of photoelectrons.

Parameters

[in]

nPhotoelectrons

Number of photoelectrons.

Definition at line 321 of file KLMDigit.h.

setPlane()

void setPlane ( int  plane )

inline

Set plane number.

Parameters

[in]

plane

Plane number.

Definition at line 153 of file KLMDigit.h.

setSection()

void setSection ( int  section )

inline

Set section number.

Parameters

[in]

section

Section number.

Definition at line 99 of file KLMDigit.h.

setSector()

void setSector ( int  sector )

inline

Set sector number.

Parameters

[in]

sector

Sector number.

Definition at line 117 of file KLMDigit.h.

setSiPMMCTime()

void setSiPMMCTime ( float  time )

inline

Set SiPM MC time.

Parameters

[in]

time

Time.

Definition at line 402 of file KLMDigit.h.

setStrip()

void setStrip ( int  strip )

inline

Set strip number.

Parameters

[in]

strip

Strip number.

Definition at line 171 of file KLMDigit.h.

setSubdetector()

void setSubdetector ( int  subdetector )

inline

Set subdetector number.

Parameters

[in]

subdetector

Subdetector number.

Definition at line 81 of file KLMDigit.h.

setTDC()

void setTDC ( uint16_t  tdc )

inline

Set TDC.

Parameters

[in]

tdc

TDC.

Definition at line 267 of file KLMDigit.h.

setTime()

void setTime ( float  time )

inline

Set hit time.

Parameters

[in]

time

hit time.

Definition at line 285 of file KLMDigit.h.

Member Data Documentation

m_LastStrip

int m_LastStrip

protected

Number of last strip (for multi-strip digits).

If m_LastStrip equals 0, then this is a single-strip digit.

Definition at line 434 of file KLMDigit.h.

m_Subdetector

int m_Subdetector

protected

ROOT streamer.

Number of subdetector.

Definition at line 413 of file KLMDigit.h.

---

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

• klm/dataobjects/include/KLMDigit.h
• klm/dataobjects/src/KLMDigit.cc