Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHG4SpacalSubsystem Class Reference

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

+ Inheritance diagram for PHG4SpacalSubsystem:
+ Collaboration diagram for PHG4SpacalSubsystem:

Public Member Functions

 PHG4SpacalSubsystem (const std::string &name="PHG4SpacalSubsystem", const int layer=0)
 constructor
 
 ~PHG4SpacalSubsystem () override
 destructor
 
int InitRunSubsystem (PHCompositeNode *) override
 init
 
int process_event (PHCompositeNode *) override
 event processing
 
PHG4DetectorGetDetector () const override
 accessors (reimplemented)
 
PHG4SteppingActionGetSteppingAction () const override
 return pointer to this subsystem stepping action
 
PHG4DisplayActionGetDisplayAction () const override
 return pointer to this subsystem display setting
 
void Print (const std::string &what="ALL") const override
 
void CosmicSetup (const int i)
 
int CosmicSetup () const
 
- Public Member Functions inherited from PHG4DetectorSubsystem
 ~PHG4DetectorSubsystem () override
 
int Init (PHCompositeNode *) final
 
int InitRun (PHCompositeNode *) final
 
virtual int InitSubsystem (PHCompositeNode *)
 
void OverlapCheck (const bool chk=true)
 
bool CheckOverlap () const
 
PHParametersGetParams () const
 
void set_double_param (const std::string &name, const double dval)
 
double get_double_param (const std::string &name) const
 
void set_int_param (const std::string &name, const int ival)
 
int get_int_param (const std::string &name) const
 
void set_string_param (const std::string &name, const std::string &sval)
 
std::string get_string_param (const std::string &name) const
 
void UseDB (const int i=1)
 
int ReadDB () const
 
void UseCDB (const std::string &domain)
 
FILE_TYPE get_filetype () const
 
void UseCalibFiles (const FILE_TYPE ftyp)
 
int ReadParamsFromCDB (const std::string &domain)
 
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 i=1)
 
void SetAbsorberActive (const int i=1)
 
void SetAbsorberTruth (const int i=1)
 
void BlackHole (const int i=1)
 
void SetSupportActive (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 PHG4EventActionGetEventAction (void) const
 return pointer to this subsystem event action
 
virtual PHG4TrackingActionGetTrackingAction (void) const
 return pointer to this subsystem stepping action
 
virtual PHG4StackingActionGetStackingAction () const
 
void OverlapCheck (const bool chk=true)
 
bool CheckOverlap () const
 
void SetMotherSubsystem (PHG4Subsystem *subsys)
 
PHG4SubsystemGetMotherSubsystem () 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

PHG4SpacalDetectordetector_ = nullptr
 detector geometry
 
PHG4SpacalSteppingActionsteppingAction_ = nullptr
 particle tracking "stepping" action
 
PHG4DisplayActionm_DisplayAction = nullptr
 display attribute setting
 
int m_CosmicSetupFlag = 0
 
std::string m_HitNodeName
 
std::string m_AbsorberNodeName
 

Additional Inherited Members

- Public Types inherited from PHG4DetectorSubsystem
enum  FILE_TYPE { none = 0, xml = 1, root = 2 }
 
- Protected Member Functions inherited from PHG4DetectorSubsystem
 PHG4DetectorSubsystem (const std::string &name="GenericSubsystem", const int lyr=0)
 
void InitializeParameters ()
 
void set_default_double_param (const std::string &name, const double dval)
 
void set_default_int_param (const std::string &name, const int ival)
 
void set_default_string_param (const std::string &name, const std::string &sval)
 
int BeginRunExecuted () const
 

Detailed Description

Definition at line 25 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 25 of file PHG4SpacalSubsystem.h

Constructor & Destructor Documentation

PHG4SpacalSubsystem::PHG4SpacalSubsystem ( const std::string &  name = "PHG4SpacalSubsystem",
const int  layer = 0 
)

constructor

Definition at line 40 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 40 of file PHG4SpacalSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

+ Here is the call graph for this function:

PHG4SpacalSubsystem::~PHG4SpacalSubsystem ( )
override

destructor

Definition at line 47 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 47 of file PHG4SpacalSubsystem.cc

References m_DisplayAction.

Member Function Documentation

void PHG4SpacalSubsystem::CosmicSetup ( const int  i)
inline

Definition at line 60 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 60 of file PHG4SpacalSubsystem.h

References i, and m_CosmicSetupFlag.

int PHG4SpacalSubsystem::CosmicSetup ( ) const
inline

Definition at line 61 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 61 of file PHG4SpacalSubsystem.h

References m_CosmicSetupFlag.

Referenced by InitRunSubsystem().

+ Here is the caller graph for this function:

PHG4Detector * PHG4SpacalSubsystem::GetDetector ( void  ) const
overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 169 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 169 of file PHG4SpacalSubsystem.cc

References detector_.

PHG4DisplayAction* PHG4SpacalSubsystem::GetDisplayAction ( ) const
inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 55 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 55 of file PHG4SpacalSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* PHG4SpacalSubsystem::GetSteppingAction ( void  ) const
inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 53 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 53 of file PHG4SpacalSubsystem.h

References steppingAction_.

int PHG4SpacalSubsystem::InitRunSubsystem ( PHCompositeNode topNode)
overridevirtual

init

called during InitRun (the original InitRun does common setup and calls this one) creates the detector object ceates the stepping action creates relevant hit nodes that will be populated by the stepping action and stored in the output DST

Reimplemented from PHG4DetectorSubsystem.

Definition at line 53 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 53 of file PHG4SpacalSubsystem.cc

References PHG4HitContainer::AddLayer(), PHCompositeNode::addNode(), assert, PHG4DetectorSubsystem::CheckOverlap(), CosmicSetup(), PHG4SpacalDetector::CosmicSetup(), detector_, truth_tracking_gsf_refitting::filePath, PHNodeIterator::findFirst(), PHG4SpacalDetector::get_geom(), PHG4DetectorSubsystem::get_int_param(), PHParameters::get_int_param(), PHG4SpacalSteppingAction::get_light_collection_model(), PHG4DetectorSubsystem::GetLayer(), PHG4DetectorSubsystem::GetParams(), PHG4SpacalSteppingAction::InitWithNode(), PHG4CylinderGeom_Spacalv1::kFullProjective_2DTaper, PHG4CylinderGeom_Spacalv1::kFullProjective_2DTaper_SameLengthFiberPerTower, PHG4CylinderGeom_Spacalv1::kFullProjective_2DTaper_Tilted, PHG4CylinderGeom_Spacalv1::kFullProjective_2DTaper_Tilted_SameLengthFiberPerTower, PHG4CylinderGeom_Spacalv1::kNonProjective, LightCollectionModel::load_data_file(), m_AbsorberNodeName, m_DisplayAction, m_HitNodeName, Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), PHG4SpacalDetector::SetAbsorberActive(), PHG4SpacalDetector::SetActive(), PHG4SpacalDisplayAction::SetGeom(), PHG4SpacalSteppingAction::SetHitNodeName(), steppingAction_, PHG4DetectorSubsystem::SuperDetector(), PHG4SpacalDetector::SuperDetector(), PHG4Detector::topNode(), and Fun4AllBase::Verbosity().

+ Here is the call graph for this function:

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

Print out some info about this module.

Parameters
whatcan be used to specify what to print exactly.

Reimplemented from SubsysReco.

Definition at line 175 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 175 of file PHG4SpacalSubsystem.cc

References detector_, and PHG4SpacalDetector::Print().

+ Here is the call graph for this function:

int PHG4SpacalSubsystem::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 156 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 156 of file PHG4SpacalSubsystem.cc

References PHG4SpacalSteppingAction::SetInterfacePointers(), and steppingAction_.

+ Here is the call graph for this function:

void PHG4SpacalSubsystem::SetDefaultParameters ( )
overrideprivatevirtual

Implements PHG4DetectorSubsystem.

Definition at line 181 of file PHG4SpacalSubsystem.cc.

View newest version in sPHENIX GitHub at line 181 of file PHG4SpacalSubsystem.cc

References PHG4CylinderGeom_Spacalv1::kNonProjective, PHG4DetectorSubsystem::set_default_double_param(), PHG4DetectorSubsystem::set_default_int_param(), and PHG4DetectorSubsystem::set_default_string_param().

+ Here is the call graph for this function:

Member Data Documentation

PHG4SpacalDetector* PHG4SpacalSubsystem::detector_ = nullptr
private

detector geometry

defives from PHG4Detector

Definition at line 69 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 69 of file PHG4SpacalSubsystem.h

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

std::string PHG4SpacalSubsystem::m_AbsorberNodeName
private

Definition at line 82 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 82 of file PHG4SpacalSubsystem.h

Referenced by InitRunSubsystem().

int PHG4SpacalSubsystem::m_CosmicSetupFlag = 0
private

Definition at line 79 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 79 of file PHG4SpacalSubsystem.h

Referenced by CosmicSetup().

PHG4DisplayAction* PHG4SpacalSubsystem::m_DisplayAction = nullptr
private

display attribute setting

derives from PHG4DisplayAction

Definition at line 77 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 77 of file PHG4SpacalSubsystem.h

Referenced by GetDisplayAction(), InitRunSubsystem(), and ~PHG4SpacalSubsystem().

std::string PHG4SpacalSubsystem::m_HitNodeName
private

Definition at line 81 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 81 of file PHG4SpacalSubsystem.h

Referenced by InitRunSubsystem().

PHG4SpacalSteppingAction* PHG4SpacalSubsystem::steppingAction_ = nullptr
private

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 73 of file PHG4SpacalSubsystem.h.

View newest version in sPHENIX GitHub at line 73 of file PHG4SpacalSubsystem.h

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


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