Fun4All module to simulate the Barrel PSTOF detector. More...

#include <coresoftware/blob/master/simulation/g4simulation/g4detectors/PHG4PSTOFSubsystem.h>

Inheritance diagram for PHG4PSTOFSubsystem:

Collaboration diagram for PHG4PSTOFSubsystem:

Public Member Functions
	PHG4PSTOFSubsystem (const std::string &name="PSTOF")
	constructor

	~PHG4PSTOFSubsystem (void) override
	destructor

int	InitRunSubsystem (PHCompositeNode *) override

int	process_event (PHCompositeNode *) override
	event processing

PHG4Detector *	GetDetector (void) const override
	accessors (reimplemented)

PHG4SteppingAction *	GetSteppingAction (void) const override
	return pointer to this subsystem stepping action

void	Print (const std::string &what="ALL") const override
	Print info (from SubsysReco)

Public Member Functions inherited from PHG4DetectorGroupSubsystem
	~PHG4DetectorGroupSubsystem () override

int	Init (PHCompositeNode *) final

int	InitRun (PHCompositeNode *) final

virtual int	InitSubsystem (PHCompositeNode *)

void	OverlapCheck (const bool chk=true)

bool	CheckOverlap () const

PHParametersContainer *	GetParamsContainer () const

void	set_double_param (const int detid, const std::string &name, const double dval)

double	get_double_param (const int detid, const std::string &name) const

void	set_int_param (const int detid, const std::string &name, const int ival)

int	get_int_param (const int detid, const std::string &name) const

void	set_string_param (const int detid, const std::string &name, const std::string &sval)

std::string	get_string_param (const int detid, const std::string &name) const

void	UseDB (const int i=1)

int	ReadDB () const

FILE_TYPE	get_filetype () const

void	UseCalibFiles (const FILE_TYPE ftyp)

int	SaveParamsToDB ()

int	ReadParamsFromDB (const std::string &name, const int issuper)

int	SaveParamsToFile (const FILE_TYPE ftyp)

int	ReadParamsFromFile (const std::string &name, const FILE_TYPE ftyp, const int issuper)

void	SetCalibrationFileDir (const std::string &calibdir)

void	UpdateParametersWithMacro ()

void	SetActive (const int detid, const int i)

void	SetActive (const int i=1)

void	SetAbsorberActive (const int detid, const int i)

void	SetAbsorberActive (const int i=1)

void	SetAbsorberTruth (const int detid, const int i)

void	SetAbsorberTruth (const int i=1)

void	SetSupportActive (const int detid, const int i=1)

void	SetSupportActive (const int i=1)

void	BlackHole (const int detid, const int i)

void	BlackHole (const int i=1)

void	SuperDetector (const std::string &name)

const std::string	SuperDetector () const

int	GetLayer () const

Public Member Functions inherited from PHG4Subsystem
	PHG4Subsystem (const std::string &name="Generic Subsystem")
	constructor

	~PHG4Subsystem (void) override
	destructor

virtual int	process_after_geant (PHCompositeNode *)
	event processing

virtual PHG4EventAction *	GetEventAction (void) const
	return pointer to this subsystem event action

virtual PHG4TrackingAction *	GetTrackingAction (void) const
	return pointer to this subsystem stepping action

virtual PHG4DisplayAction *	GetDisplayAction () const
	return pointer to this subsystem display setting

virtual PHG4StackingAction *	GetStackingAction () const

void	OverlapCheck (const bool chk=true)

bool	CheckOverlap () const

void	SetMotherSubsystem (PHG4Subsystem *subsys)

PHG4Subsystem *	GetMotherSubsystem () const

void	SetLogicalVolume (G4LogicalVolume *vol)

G4LogicalVolume *	GetLogicalVolume () const

virtual bool	CanBeMotherSubsystem () const

virtual void	AddProcesses (G4ParticleDefinition *)

virtual void	DefineMaterials ()

Public Member Functions inherited from SubsysReco
	~SubsysReco () override

virtual int	End (PHCompositeNode *)
	Called at the end of all processing.

virtual int	EndRun (const int)
	Called at the end of each run.

virtual int	Reset (PHCompositeNode *)
	Reset.

virtual int	ResetEvent (PHCompositeNode *)
	Clean up after each event.

Public Member Functions inherited from Fun4AllBase
virtual	~Fun4AllBase ()

virtual const std::string	Name () const
	Returns the name of this module.

virtual void	Name (const std::string &name)
	Sets the name of this module.

virtual void	Verbosity (const int ival)
	Sets the verbosity of this module (0 by default=quiet).

virtual void	Verbosity (enu_Verbosity ival)
	Sets the verbosity of this module (0 by default=quiet).

virtual int	Verbosity () const
	Gets the verbosity of this module.

Private Member Functions
void	SetDefaultParameters () override

Private Attributes
PHG4PSTOFDetector *	detector_ = nullptr
	detector geometry

PHG4SteppingAction *	steppingAction_ = nullptr
	particle tracking "stepping" action

Additional Inherited Members
Public Types inherited from PHG4DetectorGroupSubsystem
enum	FILE_TYPE { none = 0, xml = 1, root = 2 }

Protected Member Functions inherited from PHG4DetectorGroupSubsystem
	PHG4DetectorGroupSubsystem (const std::string &name="GenericSubsystem", const int lyr=0)

void	InitializeParameters ()

void	AddDetId (const int i)

std::pair< std::set< int > ::const_iterator, std::set < int >::const_iterator >	GetDetIds () const

void	set_default_double_param (const int detid, const std::string &name, const double dval)

void	set_default_int_param (const int detid, const std::string &name, const int ival)

void	set_default_string_param (const int detid, const std::string &name, const std::string &sval)

int	BeginRunExecuted () const

void	PrintDefaultParams () const

void	PrintMacroParams () const

Detailed Description

Fun4All module to simulate the Barrel PSTOF detector.

The detector is constructed and registered via PHG4PSTOFDetector

The PHG4SteppingAction needs to be written, but will provide the info for the hit time

See Also: PHG4PSTOFDetector; PHG4PSTOFSubsystem

Definition at line 36 of file PHG4PSTOFSubsystem.h.

View newest version in sPHENIX GitHub at line 36 of file PHG4PSTOFSubsystem.h

Constructor & Destructor Documentation

PHG4PSTOFSubsystem::PHG4PSTOFSubsystem ( const std::string & name = "PSTOF" )

constructor

Definition at line 32 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 32 of file PHG4PSTOFSubsystem.cc

References PHG4DetectorGroupSubsystem::InitializeParameters(), Fun4AllBase::Name(), and PHG4DetectorGroupSubsystem::SuperDetector().

Here is the call graph for this function:

PHG4PSTOFSubsystem::~PHG4PSTOFSubsystem ( void )

inlineoverride

destructor

Definition at line 43 of file PHG4PSTOFSubsystem.h.

View newest version in sPHENIX GitHub at line 43 of file PHG4PSTOFSubsystem.h

Member Function Documentation

PHG4Detector * PHG4PSTOFSubsystem::GetDetector ( void ) const

overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 114 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 114 of file PHG4PSTOFSubsystem.cc

References detector_.

PHG4SteppingAction * PHG4PSTOFSubsystem::GetSteppingAction ( void ) const

overridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 120 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 120 of file PHG4PSTOFSubsystem.cc

References steppingAction_.

int PHG4PSTOFSubsystem::InitRunSubsystem ( PHCompositeNode * topNode )

overridevirtual

creates the detector_ object and place it on the node tree, under "DETECTORS" node (or whatever) reates the stepping action and place it on the node tree, under "ACTIONS" node creates relevant hit nodes that will be populated by the stepping action and stored in the output DST

Reimplemented from PHG4DetectorGroupSubsystem.

Definition at line 41 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 41 of file PHG4PSTOFSubsystem.cc

References PHCompositeNode::addNode(), PHG4DetectorGroupSubsystem::CheckOverlap(), detector_, PHNodeIterator::findFirst(), PHG4DetectorGroupSubsystem::get_int_param(), PHG4DetectorGroupSubsystem::GetParamsContainer(), PHG4SteppingAction::Init(), Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), steppingAction_, PHG4PSTOFDetector::SuperDetector(), and PHG4DetectorGroupSubsystem::SuperDetector().

Here is the call graph for this function:

void PHG4PSTOFSubsystem::Print ( const std::string & what = "ALL" ) const

overridevirtual

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 100 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 100 of file PHG4PSTOFSubsystem.cc

References detector_, PHG4DetectorGroupSubsystem::GetParamsContainer(), PHG4PSTOFDetector::Print(), PHParametersContainer::Print(), PHG4DetectorGroupSubsystem::PrintDefaultParams(), and PHG4DetectorGroupSubsystem::PrintMacroParams().

Here is the call graph for this function:

int PHG4PSTOFSubsystem::process_event ( PHCompositeNode * topNode )

overridevirtual

event processing

get all relevant nodes from top nodes (namely hit list) and pass that to the stepping action

Reimplemented from SubsysReco.

Definition at line 89 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 89 of file PHG4PSTOFSubsystem.cc

References PHG4SteppingAction::SetInterfacePointers(), and steppingAction_.

Here is the call graph for this function:

void PHG4PSTOFSubsystem::SetDefaultParameters ( )

overrideprivatevirtual

Implements PHG4DetectorGroupSubsystem.

Definition at line 125 of file PHG4PSTOFSubsystem.cc.

View newest version in sPHENIX GitHub at line 125 of file PHG4PSTOFSubsystem.cc

References PHG4DetectorGroupSubsystem::set_default_double_param(), and PHG4DetectorGroupSubsystem::set_default_int_param().

Here is the call graph for this function:

Member Data Documentation

PHG4PSTOFDetector* PHG4PSTOFSubsystem::detector_ = nullptr

private

detector geometry

defives from PHG4Detector

Definition at line 72 of file PHG4PSTOFSubsystem.h.

View newest version in sPHENIX GitHub at line 72 of file PHG4PSTOFSubsystem.h

Referenced by GetDetector(), InitRunSubsystem(), and Print().

PHG4SteppingAction* PHG4PSTOFSubsystem::steppingAction_ = nullptr

private

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 76 of file PHG4PSTOFSubsystem.h.

View newest version in sPHENIX GitHub at line 76 of file PHG4PSTOFSubsystem.h

Referenced by GetSteppingAction(), InitRunSubsystem(), and process_event().

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

coresoftware/blob/master/simulation/g4simulation/g4detectors/PHG4PSTOFSubsystem.h
coresoftware/blob/master/simulation/g4simulation/g4detectors/PHG4PSTOFSubsystem.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation