BmnRoot
Loading...
Searching...
No Matches
BmnFHCal Class Reference

#include <BmnFHCal.h>

Inheritance diagram for BmnFHCal:
[legend]
Collaboration diagram for BmnFHCal:
[legend]

Public Member Functions

 BmnFHCal ()
 
 BmnFHCal (const char *name, Bool_t active)
 
virtual ~BmnFHCal ()
 
virtual void Initialize () override
 
virtual Bool_t ProcessHits (FairVolume *vol=nullptr) override
 
virtual void EndOfEvent () override
 
virtual void BeginEvent () override
 
virtual void Register () override
 
virtual TClonesArray * GetCollection (Int_t iColl) const override
 
virtual void Print (Option_t *) const override
 
virtual void Reset () override
 
virtual void ConstructGeometry () override
 
virtual Bool_t CheckIfSensitive (std::string name) override
 
BmnFHCalPointAddHit (BmnFHCalPoint *point)
 
void UpdateHit (BmnFHCalPoint &existing, const BmnFHCalPoint &update)
 
BmnFHCalPointGetHit (uint32_t address)
 
int GetSurfaceMCTrack (int start_track_id)
 
 BmnFHCal ()
 
 BmnFHCal (const char *name, Bool_t active)
 
virtual ~BmnFHCal ()
 
virtual void Initialize () override
 
virtual Bool_t ProcessHits (FairVolume *vol=nullptr) override
 
virtual void EndOfEvent () override
 
virtual void BeginEvent () override
 
virtual void Register () override
 
virtual TClonesArray * GetCollection (Int_t iColl) const override
 
virtual void Print (Option_t *) const override
 
virtual void Reset () override
 
virtual void ConstructGeometry () override
 
virtual Bool_t CheckIfSensitive (std::string name) override
 
BmnFHCalPointAddHit (BmnFHCalPoint *point)
 
void UpdateHit (BmnFHCalPoint &existing, const BmnFHCalPoint &update)
 
BmnFHCalPointGetHit (uint32_t address)
 
int GetSurfaceMCTrack (int start_track_id)
 

Detailed Description

Definition at line 16 of file BmnFHCal.h.

Constructor & Destructor Documentation

◆ BmnFHCal() [1/4]

BmnFHCal::BmnFHCal ( )

Default constructor

Definition at line 17 of file BmnFHCal.cxx.

◆ BmnFHCal() [2/4]

BmnFHCal::BmnFHCal ( const char *  name,
Bool_t  active 
)

Standard constructor.

Parameters
nameDetector name
activeSensitivity flag

Definition at line 26 of file BmnFHCal.cxx.

◆ ~BmnFHCal() [1/2]

BmnFHCal::~BmnFHCal ( )
virtual

Destructor

Definition at line 35 of file BmnFHCal.cxx.

◆ BmnFHCal() [3/4]

BmnFHCal::BmnFHCal ( )

Default constructor

◆ BmnFHCal() [4/4]

BmnFHCal::BmnFHCal ( const char *  name,
Bool_t  active 
)

Standard constructor.

Parameters
nameDetector name
activeSensitivity flag

◆ ~BmnFHCal() [2/2]

virtual BmnFHCal::~BmnFHCal ( )
virtual

Destructor

Member Function Documentation

◆ AddHit() [1/2]

BmnFHCalPoint * BmnFHCal::AddHit ( BmnFHCalPoint point)

Adds the hit to hits collection.

Parameters
pointBmnFHCalPoint
Returns
Pointer to the hit

Definition at line 237 of file BmnFHCal.cxx.

Referenced by ProcessHits().

◆ AddHit() [2/2]

BmnFHCalPoint * BmnFHCal::AddHit ( BmnFHCalPoint point)

Adds the hit to hits collection.

Parameters
pointBmnFHCalPoint
Returns
Pointer to the hit

◆ BeginEvent() [1/2]

void BmnFHCal::BeginEvent ( )
overridevirtual

Called at the beginning of each event

Definition at line 55 of file BmnFHCal.cxx.

◆ BeginEvent() [2/2]

virtual void BmnFHCal::BeginEvent ( )
overridevirtual

Called at the beginning of each event

◆ CheckIfSensitive() [1/2]

Bool_t BmnFHCal::CheckIfSensitive ( std::string  name)
overridevirtual

Checks whether a volume is sensitive based on its name.

Parameters
nameVolume name
Returns
kTRUE if the volume is sensitive, otherwise kFALSE

Definition at line 230 of file BmnFHCal.cxx.

References BmnFHCalGeoPar::SensitiveVolume_name.

Referenced by ProcessHits().

◆ CheckIfSensitive() [2/2]

virtual Bool_t BmnFHCal::CheckIfSensitive ( std::string  name)
overridevirtual

Checks whether a volume is sensitive based on its name.

Parameters
nameVolume name
Returns
kTRUE if the volume is sensitive, otherwise kFALSE

◆ ConstructGeometry() [1/2]

void BmnFHCal::ConstructGeometry ( )
overridevirtual

Constructs geometry from files

Definition at line 188 of file BmnFHCal.cxx.

References BmnFHCalGeoPar::GetGeoPassiveNodes(), and BmnFHCalGeoPar::GetGeoSensitiveNodes().

◆ ConstructGeometry() [2/2]

virtual void BmnFHCal::ConstructGeometry ( )
overridevirtual

Constructs geometry from files

◆ EndOfEvent() [1/2]

void BmnFHCal::EndOfEvent ( )
overridevirtual

Called at the end of each event

Definition at line 136 of file BmnFHCal.cxx.

References Print(), and Reset().

◆ EndOfEvent() [2/2]

virtual void BmnFHCal::EndOfEvent ( )
overridevirtual

Called at the end of each event

◆ GetCollection() [1/2]

TClonesArray * BmnFHCal::GetCollection ( Int_t  iColl) const
overridevirtual

Accessor to the hit collection

Parameters
iCollIndex of the collection
Returns
Pointer to the hit collection

Definition at line 149 of file BmnFHCal.cxx.

References BmnFHCalPoint::GetAddress(), and i.

◆ GetCollection() [2/2]

virtual TClonesArray * BmnFHCal::GetCollection ( Int_t  iColl) const
overridevirtual

Accessor to the hit collection

Parameters
iCollIndex of the collection
Returns
Pointer to the hit collection

◆ GetHit() [1/2]

BmnFHCalPoint * BmnFHCal::GetHit ( uint32_t  address)

Retrieves a hit from the collection based on the detector address.

Parameters
addressDetector address of the hit
Returns
Pointer to the retrieved hit, or nullptr if not found

Definition at line 61 of file BmnFHCal.cxx.

References i.

Referenced by ProcessHits().

◆ GetHit() [2/2]

BmnFHCalPoint * BmnFHCal::GetHit ( uint32_t  address)

Retrieves a hit from the collection based on the detector address.

Parameters
addressDetector address of the hit
Returns
Pointer to the retrieved hit, or nullptr if not found

◆ GetSurfaceMCTrack() [1/2]

int BmnFHCal::GetSurfaceMCTrack ( int  start_track_id)

Determines the surface-level Monte Carlo track ID associated with the given starting track ID.

Parameters
start_track_idInitial track ID to trace back to the surface MC track
Returns
Surface-level MC track ID

Definition at line 277 of file BmnFHCal.cxx.

Referenced by ProcessHits().

◆ GetSurfaceMCTrack() [2/2]

int BmnFHCal::GetSurfaceMCTrack ( int  start_track_id)

Determines the surface-level Monte Carlo track ID associated with the given starting track ID.

Parameters
start_track_idInitial track ID to trace back to the surface MC track
Returns
Surface-level MC track ID

◆ Initialize() [1/2]

void BmnFHCal::Initialize ( )
overridevirtual

Initializes detector and FairRun

Definition at line 49 of file BmnFHCal.cxx.

◆ Initialize() [2/2]

virtual void BmnFHCal::Initialize ( )
overridevirtual

Initializes detector and FairRun

◆ Print() [1/2]

void BmnFHCal::Print ( Option_t *  ) const
overridevirtual

Screen output of hit collection

Definition at line 168 of file BmnFHCal.cxx.

References i, and BmnFHCalPoint::Print().

Referenced by EndOfEvent().

◆ Print() [2/2]

virtual void BmnFHCal::Print ( Option_t *  ) const
overridevirtual

Screen output of hit collection

◆ ProcessHits() [1/2]

Bool_t BmnFHCal::ProcessHits ( FairVolume *  vol = nullptr)
overridevirtual

Processes hits and creates BmnFHCalPoints.

Parameters
volPointer to the active volume
Returns
kTRUE if the volume is sensitive and a hit is processed, otherwise kFALSE

Definition at line 80 of file BmnFHCal.cxx.

References AddHit(), CheckIfSensitive(), GetHit(), BmnFHCalAddress::GetInfoString(), GetSurfaceMCTrack(), kFHCAL, and UpdateHit().

◆ ProcessHits() [2/2]

virtual Bool_t BmnFHCal::ProcessHits ( FairVolume *  vol = nullptr)
overridevirtual

Processes hits and creates BmnFHCalPoints.

Parameters
volPointer to the active volume
Returns
kTRUE if the volume is sensitive and a hit is processed, otherwise kFALSE

◆ Register() [1/2]

void BmnFHCal::Register ( )
overridevirtual

Registers the hit collection in the ROOT manager

Definition at line 143 of file BmnFHCal.cxx.

◆ Register() [2/2]

virtual void BmnFHCal::Register ( )
overridevirtual

Registers the hit collection in the ROOT manager

◆ Reset() [1/2]

void BmnFHCal::Reset ( )
overridevirtual

Clears the hit collection

Definition at line 182 of file BmnFHCal.cxx.

Referenced by EndOfEvent().

◆ Reset() [2/2]

virtual void BmnFHCal::Reset ( )
overridevirtual

Clears the hit collection

◆ UpdateHit() [1/2]

void BmnFHCal::UpdateHit ( BmnFHCalPoint existing,
const BmnFHCalPoint update 
)

Updates an existing hit by merging information from a new hit, weighting position, momentum, time, and length according to their energy loss.

Parameters
existingReference to the existing BmnFHCalPoint hit, which will be updated
updateReference to the new BmnFHCalPoint hit, providing additional information

Definition at line 244 of file BmnFHCal.cxx.

References BmnFHCalPoint::GetAddress().

Referenced by ProcessHits().

◆ UpdateHit() [2/2]

void BmnFHCal::UpdateHit ( BmnFHCalPoint existing,
const BmnFHCalPoint update 
)

Updates an existing hit by merging information from a new hit, weighting position, momentum, time, and length according to their energy loss.

Parameters
existingReference to the existing BmnFHCalPoint hit, which will be updated
updateReference to the new BmnFHCalPoint hit, providing additional information

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