Herd::Readers::GGSFitHitsReader Class Reference

CaloHits reader class. More...

#include <dataproviders/readers/event/GGSFitHitsReader.h>

Public Member Functions
	GGSFitHitsReader (std::shared_ptr< GGSTRootReader > ggsReader)
bool	IsFitHitsCollAvailable ()
	Checks if FIT hits are available in the simulation file. More...
RetrievalResult	GetFitHitsColl (ObjectWrapper &wrapper)
	Get the FIT Hits. More...
bool	IsFitParticleHitsCollAvailable ()
	Checks if FIT particle hits are available in the simulation file. More...
RetrievalResult	GetFitParticleHitsColl (ObjectWrapper &wrapper)
	Get the FIT Particle Hits. More...
std::vector< std::string >	FreeObjects (const std::vector< std::string > &objs, Memory::Status memStatus)
	Free the memory of unneeded objects. More...
void	SetFitGeoParamsColl (observer_ptr< FitGeoParamsColl > fitGeoParamsColl)
	Set the reference for the FIT geometric parameters. More...
void	SetSideDetectorFirstVolumeID (std::array< int, 4 > sideFitFirstVolumeID)
	Set the GGS volID of the first wafer for each side FIT detector. More...

Private Member Functions
bool	SetupFitReadout ()

Private Attributes
std::shared_ptr< GGSTRootReader >	m_ggsReader
GGSTHitsReader *	m_hitReader = nullptr
long long int	m_lastHitsReadEvent = std::numeric_limits<long long int>::max()
long long int	m_lastPartHitsReadEvent = std::numeric_limits<long long int>::max()
observer_ptr< FitGeoParamsColl >	m_fitGeoParamsColl = nullptr
int	m_topFitDetIndex = std::numeric_limits<int>::lowest()
int	m_sideFitDetIndex = std::numeric_limits<int>::lowest()
std::array< int, 4 >	m_sideFitFirstVolumeID {}
FitHitsColl	m_fitHitsColl
FitParticleHitsColl	m_fitParticleHitsColl

Detailed Description

CaloHits reader class.

Class for reading the CaloHits object from a GGS simulation file.

Constructor & Destructor Documentation

GGSFitHitsReader()

Herd::Readers::GGSFitHitsReader::GGSFitHitsReader ( std::shared_ptr< GGSTRootReader >  ggsReader )

inlineexplicit

Member Function Documentation

FreeObjects()

std::vector< std::string > Herd::Readers::GGSFitHitsReader::FreeObjects	(	const std::vector< std::string > &	objs,
		Memory::Status	memStatus
	)

Free the memory of unneeded objects.

Currently this method frees the memory of the provided objects if memStatus is EXHAUSTED. This reader frees the following objects:

• fitLayerHitsCollGGS
• fitParticleHitsCollGGS

Parameters

objs	The list of objects to be freed.
memStatus	The current memory occupation status.

Returns

a list of freed objects.

GetFitHitsColl()

RetrievalResult Herd::Readers::GGSFitHitsReader::GetFitHitsColl

(

ObjectWrapper &

wrapper

)

Get the FIT Hits.

Parameters

wrapper

A wrapper to the FitHitsColl object

Returns

RetrievalResult The result of the operation (SUCCESS or ERROR)

GetFitParticleHitsColl()

RetrievalResult Herd::Readers::GGSFitHitsReader::GetFitParticleHitsColl

(

ObjectWrapper &

wrapper

)

Get the FIT Particle Hits.

Parameters

wrapper

A wrapper to the FitParticleHitsColl object

Returns

RetrievalResult The result of the operation (SUCCESS or ERROR)

IsFitHitsCollAvailable()

bool Herd::Readers::GGSFitHitsReader::IsFitHitsCollAvailable

(

)

Checks if FIT hits are available in the simulation file.

Check the GGS reader for the presence of FIT hits

Returns

true

false

IsFitParticleHitsCollAvailable()

bool Herd::Readers::GGSFitHitsReader::IsFitParticleHitsCollAvailable

(

)

Checks if FIT particle hits are available in the simulation file.

Check the GGS reader for the presence of FIT particle hits

Returns

true

false

SetFitGeoParamsColl()

void Herd::Readers::GGSFitHitsReader::SetFitGeoParamsColl

(

observer_ptr< FitGeoParamsColl >

fitGeoParamsColl

)

Set the reference for the FIT geometric parameters.

Sets the FIT geometric parameters to be used for GGSID -> VolumeID conversion.

Parameters

fitGeoParamsColl

an observer_ptr to the geoparams collection.

SetSideDetectorFirstVolumeID()

void Herd::Readers::GGSFitHitsReader::SetSideDetectorFirstVolumeID ( std::array< int, 4 >  sideFitFirstVolumeID )

inline

Set the GGS volID of the first wafer for each side FIT detector.

Parameters

sideFitFirstVolumeID

an array containing the first GGS volumeID for side FIT layers.

SetupFitReadout()

bool Herd::Readers::GGSFitHitsReader::SetupFitReadout ( )

private

Member Data Documentation

m_fitGeoParamsColl

observer_ptr<FitGeoParamsColl> Herd::Readers::GGSFitHitsReader::m_fitGeoParamsColl = nullptr

private

m_fitHitsColl

FitHitsColl Herd::Readers::GGSFitHitsReader::m_fitHitsColl

private

m_fitParticleHitsColl

FitParticleHitsColl Herd::Readers::GGSFitHitsReader::m_fitParticleHitsColl

private

m_ggsReader

std::shared_ptr<GGSTRootReader> Herd::Readers::GGSFitHitsReader::m_ggsReader

private

m_hitReader

GGSTHitsReader* Herd::Readers::GGSFitHitsReader::m_hitReader = nullptr

private

m_lastHitsReadEvent

long long int Herd::Readers::GGSFitHitsReader::m_lastHitsReadEvent = std::numeric_limits<long long int>::max()

private

m_lastPartHitsReadEvent

long long int Herd::Readers::GGSFitHitsReader::m_lastPartHitsReadEvent = std::numeric_limits<long long int>::max()

private

m_sideFitDetIndex

int Herd::Readers::GGSFitHitsReader::m_sideFitDetIndex = std::numeric_limits<int>::lowest()

private

m_sideFitFirstVolumeID

std::array<int, 4> Herd::Readers::GGSFitHitsReader::m_sideFitFirstVolumeID {}

private

m_topFitDetIndex

int Herd::Readers::GGSFitHitsReader::m_topFitDetIndex = std::numeric_limits<int>::lowest()

private

---

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

• /builds/herd/HerdSoftware/include/analysis/dataproviders/readers/event/GGSFitHitsReader.h
• /builds/herd/HerdSoftware/src/analysis/dataproviders/readers/event/GGSFitHitsReader.cpp