PsdHits reader class. More...

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

Classes
struct	PsdIDVolInfo

Public Types
enum	DetectorType : int { DetectorType::NONE = -1, DetectorType::TILES = 0, DetectorType::BARS = 1 }

Public Member Functions
	GGSPsdHitsReader (std::shared_ptr< GGSTRootReader > ggsReader)

bool	IsPsdHitsCollAvailable ()
	Get the PSD Hits. More...

RetrievalResult	GetPsdHitsColl (ObjectWrapper &wrapper)
	Checks if PSD particle hits are available in the simulation file. More...

bool	IsPsdParticleHitsCollAvailable ()
	Checks if PSD particle hits are available in the simulation file. More...

RetrievalResult	GetPsdParticleHitsColl (ObjectWrapper &wrapper)
	Get the PSD Particle Hits. More...

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

void	SetPsdGeoParamsColl (observer_ptr< PsdGeoParamsColl > psdGeoParamsColl)
	Set the reference for the PSD geometric parameters. More...

void	SetFileName (const std::string &fileName)
	Set the name of the input file. More...

void	SetPsdType (DetectorType type)
	Set the Psd Type (BARS or TILES) More...

Private Types
enum	SidePsdSegmentation : int { SidePsdSegmentation::NONE = -1, SidePsdSegmentation::H = 0, SidePsdSegmentation::V = 1 }

Private Member Functions
bool	SetupPsdReadout (bool getParticleHits)

PsdIDVolInfo	SidePsdHitIDLayerSideFromGGSID (int iGGSPsdID, SidePsdSegmentation sidePsdSegmentation)

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()

bool	m_readPsdParticleHits = false

DetectorType	m_type = DetectorType::NONE

observer_ptr< PsdGeoParamsColl >	m_psdGeoParamsColl = nullptr

int	m_topPsdDetIndex = std::numeric_limits<int>::lowest()

std::vector< int >	m_sidePsdDetIndexes

PsdHitsColl	m_psdHitsColl

PsdParticleHitsColl	m_psdParticleHitsColl

std::string	m_fileName

Detailed Description

PsdHits reader class.

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

Member Enumeration Documentation

◆ DetectorType

enum Herd::Readers::GGSPsdHitsReader::DetectorType : int

strong

Enumerator
NONE
TILES
BARS

◆ SidePsdSegmentation

enum Herd::Readers::GGSPsdHitsReader::SidePsdSegmentation : int

strongprivate

Enumerator
NONE
H
V

Constructor & Destructor Documentation

◆ GGSPsdHitsReader()

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

inlineexplicit

Member Function Documentation

◆ FreeObjects()

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

◆ GetPsdHitsColl()

RetrievalResult Herd::Readers::GGSPsdHitsReader::GetPsdHitsColl ( ObjectWrapper & wrapper )

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

Check the GGS reader for the presence of PSD particle hits

Returns: true; false

◆ GetPsdParticleHitsColl()

RetrievalResult Herd::Readers::GGSPsdHitsReader::GetPsdParticleHitsColl ( ObjectWrapper & wrapper )

Get the PSD Particle Hits.

Parameters

wrapper A wrapper to the PsdParticleHitsColl object

Returns: RetrievalResult The result of the operation (SUCCESS or ERROR)

◆ IsPsdHitsCollAvailable()

bool Herd::Readers::GGSPsdHitsReader::IsPsdHitsCollAvailable ( )

Get the PSD Hits.

Parameters

wrapper A wrapper to the PsdHitsColl object

Returns: RetrievalResult The result of the operation (SUCCESS or ERROR)

◆ IsPsdParticleHitsCollAvailable()

bool Herd::Readers::GGSPsdHitsReader::IsPsdParticleHitsCollAvailable ( )

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

Check the GGS reader for the presence of PSD particle hits

Returns: true; false

◆ SetFileName()

void Herd::Readers::GGSPsdHitsReader::SetFileName ( const std::string & fileName )

inline

Set the name of the input file.

Parameters

fileName

◆ SetPsdGeoParamsColl()

void Herd::Readers::GGSPsdHitsReader::SetPsdGeoParamsColl ( observer_ptr< PsdGeoParamsColl > psdGeoParamsColl )

Set the reference for the PSD geometric parameters.

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

Parameters

psdGeoParamsColl an observer_ptr to the geoparams collection.

◆ SetPsdType()

void Herd::Readers::GGSPsdHitsReader::SetPsdType ( GGSPsdHitsReader::DetectorType type )

Set the Psd Type (BARS or TILES)

Parameters

type

◆ SetupPsdReadout()

bool Herd::Readers::GGSPsdHitsReader::SetupPsdReadout ( bool getParticleHits )

private

◆ SidePsdHitIDLayerSideFromGGSID()

GGSPsdHitsReader::PsdIDVolInfo Herd::Readers::GGSPsdHitsReader::SidePsdHitIDLayerSideFromGGSID	(	int	iGGSPsdID,
		GGSPsdHitsReader::SidePsdSegmentation	sidePsdSegmentation
	)

private

Member Data Documentation

◆ m_fileName

std::string Herd::Readers::GGSPsdHitsReader::m_fileName

private

◆ m_ggsReader

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

private

◆ m_hitReader

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

private

◆ m_lastHitsReadEvent

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

private

◆ m_lastPartHitsReadEvent

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

private

◆ m_psdGeoParamsColl

observer_ptr<PsdGeoParamsColl> Herd::Readers::GGSPsdHitsReader::m_psdGeoParamsColl = nullptr

private

◆ m_psdHitsColl

PsdHitsColl Herd::Readers::GGSPsdHitsReader::m_psdHitsColl

private

◆ m_psdParticleHitsColl

PsdParticleHitsColl Herd::Readers::GGSPsdHitsReader::m_psdParticleHitsColl

private

◆ m_readPsdParticleHits

bool Herd::Readers::GGSPsdHitsReader::m_readPsdParticleHits = false

private

◆ m_sidePsdDetIndexes

std::vector<int> Herd::Readers::GGSPsdHitsReader::m_sidePsdDetIndexes

private

◆ m_topPsdDetIndex

int Herd::Readers::GGSPsdHitsReader::m_topPsdDetIndex = std::numeric_limits<int>::lowest()

private

◆ m_type

DetectorType Herd::Readers::GGSPsdHitsReader::m_type = DetectorType::NONE

private

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

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ DetectorType

◆ SidePsdSegmentation

Constructor & Destructor Documentation

◆ GGSPsdHitsReader()

Member Function Documentation

◆ FreeObjects()

◆ GetPsdHitsColl()

◆ GetPsdParticleHitsColl()

◆ IsPsdHitsCollAvailable()

◆ IsPsdParticleHitsCollAvailable()

◆ SetFileName()

◆ SetPsdGeoParamsColl()

◆ SetPsdType()

◆ SetupPsdReadout()

◆ SidePsdHitIDLayerSideFromGGSID()

Member Data Documentation

◆ m_fileName

◆ m_ggsReader

◆ m_hitReader

◆ m_lastHitsReadEvent

◆ m_lastPartHitsReadEvent

◆ m_psdGeoParamsColl

◆ m_psdHitsColl

◆ m_psdParticleHitsColl

◆ m_readPsdParticleHits

◆ m_sidePsdDetIndexes

◆ m_topPsdDetIndex

◆ m_type