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

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

+ Inheritance diagram for PHG4BlockSubsystem:
+ Collaboration diagram for PHG4BlockSubsystem:

Public Member Functions

 PHG4BlockSubsystem (const std::string &name="BLOCK", const int layer=0)
 constructor
 
 ~PHG4BlockSubsystem () override
 destructor
 
int InitRunSubsystem (PHCompositeNode *) override
 InitRunSubsystem.
 
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 set_color (const double red, const double green, const double blue, const double alpha=1.)
 
bool CanBeMotherSubsystem () const override
 
- 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 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.
 
void Print (const std::string &="ALL") const override
 
- 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

PHG4BlockDetectorm_Detector
 detector geometry
 
PHG4SteppingActionm_SteppingAction
 particle tracking "stepping" action
 
PHG4DisplayActionm_DisplayAction
 display attribute setting
 
std::array< double, 4 > m_ColorArray
 Color setting if we want to override the default.
 

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 17 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 17 of file PHG4BlockSubsystem.h

Constructor & Destructor Documentation

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

constructor

Definition at line 31 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 31 of file PHG4BlockSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters(), and m_ColorArray.

+ Here is the call graph for this function:

PHG4BlockSubsystem::~PHG4BlockSubsystem ( )
override

destructor

Definition at line 42 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 42 of file PHG4BlockSubsystem.cc

References m_DisplayAction.

Member Function Documentation

bool PHG4BlockSubsystem::CanBeMotherSubsystem ( ) const
inlineoverridevirtual

Reimplemented from PHG4Subsystem.

Definition at line 58 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 58 of file PHG4BlockSubsystem.h

PHG4Detector * PHG4BlockSubsystem::GetDetector ( void  ) const
overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 134 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 134 of file PHG4BlockSubsystem.cc

References m_Detector.

PHG4DisplayAction* PHG4BlockSubsystem::GetDisplayAction ( ) const
inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 46 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 46 of file PHG4BlockSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* PHG4BlockSubsystem::GetSteppingAction ( void  ) const
inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 44 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 44 of file PHG4BlockSubsystem.h

References m_SteppingAction.

int PHG4BlockSubsystem::InitRunSubsystem ( PHCompositeNode topNode)
overridevirtual

InitRunSubsystem.

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 PHG4DetectorSubsystem.

Definition at line 48 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 48 of file PHG4BlockSubsystem.cc

References PHG4HitContainer::AddLayer(), PHG4BlockGeomContainer::AddLayerGeom(), PHCompositeNode::addNode(), PHG4DetectorSubsystem::CheckOverlap(), PHNodeIterator::findFirst(), PHG4DetectorSubsystem::get_double_param(), PHG4DetectorSubsystem::get_int_param(), PHG4DetectorSubsystem::GetLayer(), PHG4DetectorSubsystem::GetParams(), m_ColorArray, m_Detector, m_DisplayAction, m_SteppingAction, Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), PHG4BlockDisplayAction::SetColor(), PHG4BlockDetector::SuperDetector(), PHG4DetectorSubsystem::SuperDetector(), and PHG4Detector::topNode().

+ Here is the call graph for this function:

int PHG4BlockSubsystem::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 121 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 121 of file PHG4BlockSubsystem.cc

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

+ Here is the call graph for this function:

void PHG4BlockSubsystem::set_color ( const double  red,
const double  green,
const double  blue,
const double  alpha = 1. 
)
inline

Definition at line 48 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 48 of file PHG4BlockSubsystem.h

References alpha, Acts::Test::blue, Acts::Test::green, m_ColorArray, and Acts::Test::red.

void PHG4BlockSubsystem::SetDefaultParameters ( )
overrideprivatevirtual

Implements PHG4DetectorSubsystem.

Definition at line 139 of file PHG4BlockSubsystem.cc.

View newest version in sPHENIX GitHub at line 139 of file PHG4BlockSubsystem.cc

References 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

std::array<double, 4> PHG4BlockSubsystem::m_ColorArray
private

Color setting if we want to override the default.

Definition at line 75 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 75 of file PHG4BlockSubsystem.h

Referenced by InitRunSubsystem(), PHG4BlockSubsystem(), and set_color().

PHG4BlockDetector* PHG4BlockSubsystem::m_Detector
private

detector geometry

defines from PHG4Detector

Definition at line 65 of file PHG4BlockSubsystem.h.

View newest version in sPHENIX GitHub at line 65 of file PHG4BlockSubsystem.h

Referenced by GetDetector(), and InitRunSubsystem().

PHG4DisplayAction* PHG4BlockSubsystem::m_DisplayAction
private

display attribute setting

derives from PHG4DisplayAction

Definition at line 73 of file PHG4BlockSubsystem.h.

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

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

PHG4SteppingAction* PHG4BlockSubsystem::m_SteppingAction
private

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 69 of file PHG4BlockSubsystem.h.

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

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


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