#include <BmnNdet.h>

Inheritance diagram for BmnNdet:

Collaboration diagram for BmnNdet:

Public Member Functions
	BmnNdet ()

	BmnNdet (const char *name, Bool_t active)

virtual	~BmnNdet ()

virtual void	Initialize ()

virtual Bool_t	ProcessHits (FairVolume *vol=nullptr)

bool	FinaliseTrackProcessing (BmnNdetPoint *point)

virtual void	EndOfEvent ()

virtual void	BeginEvent ()

virtual void	Register ()

virtual TClonesArray *	GetCollection (Int_t iColl) const

virtual void	Print (Option_t *) const

virtual void	Reset ()

virtual void	ConstructGeometry ()

virtual Bool_t	CheckIfSensitive (std::string name)

virtual Bool_t	CheckIfVacuum ()

Int_t	FindHitIndex (int trackID, uint32_t address)

BmnNdetPoint *	GetHit (int trackID, uint32_t address)

BmnNdetPoint *	AddHit (BmnNdetPoint *point)

void	RemoveHit (Int_t index)

int	GetSurfacePoint (int start_track_id)

	BmnNdet ()

	BmnNdet (const char *name, Bool_t active)

virtual	~BmnNdet ()

virtual void	Initialize ()

virtual Bool_t	ProcessHits (FairVolume *vol=nullptr)

bool	FinaliseTrackProcessing (BmnNdetPoint *point)

virtual void	EndOfEvent ()

virtual void	BeginEvent ()

virtual void	Register ()

virtual TClonesArray *	GetCollection (Int_t iColl) const

virtual void	Print (Option_t *) const

virtual void	Reset ()

virtual void	ConstructGeometry ()

virtual Bool_t	CheckIfSensitive (std::string name)

virtual Bool_t	CheckIfVacuum ()

Int_t	FindHitIndex (int trackID, uint32_t address)

BmnNdetPoint *	GetHit (int trackID, uint32_t address)

BmnNdetPoint *	AddHit (BmnNdetPoint *point)

void	RemoveHit (Int_t index)

int	GetSurfacePoint (int start_track_id)

Detailed Description

Definition at line 17 of file BmnNdet.h.

Constructor & Destructor Documentation

◆ BmnNdet() [1/4]

BmnNdet::BmnNdet ( )

Default constructor

Definition at line 17 of file BmnNdet.cxx.

◆ BmnNdet() [2/4]

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

Standard constructor.

Parameters

name	Detector name
active	Sensitivity flag

Definition at line 26 of file BmnNdet.cxx.

◆ ~BmnNdet() [1/2]

BmnNdet::~BmnNdet ( )

virtual

Destructor

Definition at line 35 of file BmnNdet.cxx.

◆ BmnNdet() [3/4]

BmnNdet::BmnNdet ( )

Default constructor

◆ BmnNdet() [4/4]

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

Standard constructor.

Parameters

name	Detector name
active	Sensitivity flag

◆ ~BmnNdet() [2/2]

virtual BmnNdet::~BmnNdet ( )

virtual

Destructor

Member Function Documentation

◆ AddHit() [1/2]

BmnNdetPoint * BmnNdet::AddHit ( BmnNdetPoint * point )

Adds the hit to hits collection.

Parameters

point BmnNdetPoint

Returns: Pointer to the hit

Definition at line 302 of file BmnNdet.cxx.

Referenced by ProcessHits().

◆ AddHit() [2/2]

BmnNdetPoint * BmnNdet::AddHit ( BmnNdetPoint * point )

Adds the hit to hits collection.

Parameters

point BmnNdetPoint

Returns: Pointer to the hit

◆ BeginEvent() [1/2]

void BmnNdet::BeginEvent ( )

virtual

Called at the beginning of each event

Definition at line 57 of file BmnNdet.cxx.

◆ BeginEvent() [2/2]

virtual void BmnNdet::BeginEvent ( )

virtual

Called at the beginning of each event

◆ CheckIfSensitive() [1/2]

Bool_t BmnNdet::CheckIfSensitive ( std::string name )

virtual

Checks whether a volume is sensitive based on its name.

Parameters

name	Volume name

Returns: kTRUE if the volume is sensitive, otherwise kFALSE

Definition at line 289 of file BmnNdet.cxx.

References BmnNdetGeoPar::fEnvelopeVolumeName, BmnNdetGeoPar::SensitiveVolume_name_NICA, and BmnNdetGeoPar::SensitiveVolume_name_VETO.

Referenced by ProcessHits().

◆ CheckIfSensitive() [2/2]

virtual Bool_t BmnNdet::CheckIfSensitive ( std::string name )

virtual

Checks whether a volume is sensitive based on its name.

Parameters

name	Volume name

Returns: kTRUE if the volume is sensitive, otherwise kFALSE

◆ CheckIfVacuum() [1/2]

Bool_t BmnNdet::CheckIfVacuum ( )

virtual

Checks whether current volume is vacuum

Returns: kTRUE if the volume is vacuum, otherwise kFALSE

Definition at line 297 of file BmnNdet.cxx.

Referenced by ProcessHits().

◆ CheckIfVacuum() [2/2]

virtual Bool_t BmnNdet::CheckIfVacuum ( )

virtual

Checks whether current volume is vacuum

Returns: kTRUE if the volume is vacuum, otherwise kFALSE

◆ ConstructGeometry() [1/2]

void BmnNdet::ConstructGeometry ( )

virtual

Constructs geometry from files

Definition at line 244 of file BmnNdet.cxx.

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

◆ ConstructGeometry() [2/2]

virtual void BmnNdet::ConstructGeometry ( )

virtual

Constructs geometry from files

◆ EndOfEvent() [1/2]

void BmnNdet::EndOfEvent ( )

virtual

Called at the end of each event

Definition at line 197 of file BmnNdet.cxx.

References Print(), and Reset().

◆ EndOfEvent() [2/2]

virtual void BmnNdet::EndOfEvent ( )

virtual

Called at the end of each event

◆ FinaliseTrackProcessing() [1/2]

bool BmnNdet::FinaliseTrackProcessing ( BmnNdetPoint * point )

Removes zero-energy hits

Parameters

point Pointer to the hit

Returns: true if the track has non zero impact, otherwise removes it from collection and returns false

Definition at line 183 of file BmnNdet.cxx.

References FindHitIndex(), BmnNdetPoint::GetAddress(), BmnNdetAddress::GetInfoString(), and RemoveHit().

Referenced by ProcessHits().

◆ FinaliseTrackProcessing() [2/2]

bool BmnNdet::FinaliseTrackProcessing ( BmnNdetPoint * point )

Removes zero-energy hits

Parameters

point Pointer to the hit

Returns: true if the track has non zero impact, otherwise removes it from collection and returns false

◆ FindHitIndex() [1/2]

Int_t BmnNdet::FindHitIndex	(	int	trackID,
		uint32_t	address
	)

Retrieves the hit index corresponding to a specific address and trackID.

Parameters

trackID	trackID
address	BmnNdetAddress

Returns: index of the hit if found, otherwise -1

Definition at line 62 of file BmnNdet.cxx.

References i.

Referenced by FinaliseTrackProcessing(), and GetHit().

◆ FindHitIndex() [2/2]

Int_t BmnNdet::FindHitIndex	(	int	trackID,
		uint32_t	address
	)

Retrieves the hit index corresponding to a specific address and trackID.

Parameters

trackID	trackID
address	BmnNdetAddress

Returns: index of the hit if found, otherwise -1

◆ GetCollection() [1/2]

TClonesArray * BmnNdet::GetCollection ( Int_t iColl ) const

virtual

Accessor to the hit collection

Parameters

iColl Index of the collection

Returns: Pointer to the hit collection

Definition at line 214 of file BmnNdet.cxx.

◆ GetCollection() [2/2]

virtual TClonesArray * BmnNdet::GetCollection ( Int_t iColl ) const

virtual

Accessor to the hit collection

Parameters

iColl Index of the collection

Returns: Pointer to the hit collection

◆ GetHit() [1/2]

BmnNdetPoint * BmnNdet::GetHit	(	int	trackID,
		uint32_t	address
	)

Retrieves the hit corresponding to a specific address and trackID.

Parameters

trackID	trackID
address	BmnNdetAddress

Returns: Pointer to the hit if found, otherwise nullptr

Definition at line 76 of file BmnNdet.cxx.

References FindHitIndex().

Referenced by ProcessHits().

◆ GetHit() [2/2]

BmnNdetPoint * BmnNdet::GetHit	(	int	trackID,
		uint32_t	address
	)

Retrieves the hit corresponding to a specific address and trackID.

Parameters

trackID	trackID
address	BmnNdetAddress

Returns: Pointer to the hit if found, otherwise nullptr

◆ GetSurfacePoint() [1/2]

int BmnNdet::GetSurfacePoint ( int start_track_id )

Returns index of surface point.

Parameters

start track index

Definition at line 319 of file BmnNdet.cxx.

References BmnNdetGeo::FromOutside, and i.

Referenced by ProcessHits().

◆ GetSurfacePoint() [2/2]

int BmnNdet::GetSurfacePoint ( int start_track_id )

Returns index of surface point.

Parameters

start track index

◆ Initialize() [1/2]

void BmnNdet::Initialize ( )

virtual

Initialises detector and FairRun

Definition at line 49 of file BmnNdet.cxx.

◆ Initialize() [2/2]

virtual void BmnNdet::Initialize ( )

virtual

Initialises detector and FairRun

◆ Print() [1/2]

void BmnNdet::Print ( Option_t * ) const

virtual

Screen output of hit collection

Definition at line 224 of file BmnNdet.cxx.

References i.

Referenced by EndOfEvent().

◆ Print() [2/2]

virtual void BmnNdet::Print ( Option_t * ) const

virtual

Screen output of hit collection

◆ ProcessHits() [1/2]

Bool_t BmnNdet::ProcessHits ( FairVolume * vol = nullptr )

virtual

Processes hits and creates BmnNdetPoints.

Parameters

vol	Pointer to the active volume

Returns: kTRUE if the volume is sensitive and a hit is processed, otherwise kFALSE

Definition at line 93 of file BmnNdet.cxx.

References AddHit(), CheckIfSensitive(), CheckIfVacuum(), FinaliseTrackProcessing(), BmnNdetGeo::GetAddressFromPath(), BmnNdetGeo::GetArmFromPath(), GetBirkQCF(), BmnNdetGeo::GetEnteredFace(), GetHit(), BmnNdetAddress::GetInfoString(), GetSurfacePoint(), kNDET, BmnNdetPoint::SetAddress(), and BmnNdetCell::SurfaceMCPoint.

◆ ProcessHits() [2/2]

virtual Bool_t BmnNdet::ProcessHits ( FairVolume * vol = nullptr )

virtual

Processes hits and creates BmnNdetPoints.

Parameters

vol	Pointer to the active volume

Returns: kTRUE if the volume is sensitive and a hit is processed, otherwise kFALSE

◆ Register() [1/2]

void BmnNdet::Register ( )

virtual

Registers the hit collection in the ROOT manager

Definition at line 204 of file BmnNdet.cxx.

◆ Register() [2/2]

virtual void BmnNdet::Register ( )

virtual

Registers the hit collection in the ROOT manager

◆ RemoveHit() [1/2]

void BmnNdet::RemoveHit ( Int_t index )

Remove hit from hits collection by index.

Parameters

index hit index

Definition at line 309 of file BmnNdet.cxx.

Referenced by FinaliseTrackProcessing().

◆ RemoveHit() [2/2]

void BmnNdet::RemoveHit ( Int_t index )

Remove hit from hits collection by index.

Parameters

index hit index

◆ Reset() [1/2]

void BmnNdet::Reset ( )

virtual

Clears the hit collection

Definition at line 237 of file BmnNdet.cxx.

Referenced by EndOfEvent().

◆ Reset() [2/2]

virtual void BmnNdet::Reset ( )

virtual

Clears the hit collection

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

detectors/ndet/BmnNdet.h
install/include/BmnNdet.h
detectors/ndet/BmnNdet.cxx
detectors/ndet/BmnNdet_simple_allHits_timeCut_12x12cm_9mods_15sect.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BmnNdet() [1/4]

◆ BmnNdet() [2/4]

◆ ~BmnNdet() [1/2]

◆ BmnNdet() [3/4]

◆ BmnNdet() [4/4]

◆ ~BmnNdet() [2/2]

Member Function Documentation

◆ AddHit() [1/2]

◆ AddHit() [2/2]

◆ BeginEvent() [1/2]

◆ BeginEvent() [2/2]

◆ CheckIfSensitive() [1/2]

◆ CheckIfSensitive() [2/2]

◆ CheckIfVacuum() [1/2]

◆ CheckIfVacuum() [2/2]

◆ ConstructGeometry() [1/2]

◆ ConstructGeometry() [2/2]

◆ EndOfEvent() [1/2]

◆ EndOfEvent() [2/2]

◆ FinaliseTrackProcessing() [1/2]

◆ FinaliseTrackProcessing() [2/2]

◆ FindHitIndex() [1/2]

◆ FindHitIndex() [2/2]

◆ GetCollection() [1/2]

◆ GetCollection() [2/2]

◆ GetHit() [1/2]

◆ GetHit() [2/2]

◆ GetSurfacePoint() [1/2]

◆ GetSurfacePoint() [2/2]

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Print() [1/2]

◆ Print() [2/2]

◆ ProcessHits() [1/2]

◆ ProcessHits() [2/2]

◆ Register() [1/2]

◆ Register() [2/2]

◆ RemoveHit() [1/2]

◆ RemoveHit() [2/2]

◆ Reset() [1/2]

◆ Reset() [2/2]