EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHG4TruthSubsystem Class Reference

#include <fun4all_coresoftware/blob/master/simulation/g4simulation/g4main/PHG4TruthSubsystem.h>

+ Inheritance diagram for PHG4TruthSubsystem:
+ Collaboration diagram for PHG4TruthSubsystem:

Public Member Functions

 PHG4TruthSubsystem (const std::string &name="TRUTH")
 constructor
 
 ~PHG4TruthSubsystem (void) override
 destructor
 
int InitRun (PHCompositeNode *) override
 init
 
int process_event (PHCompositeNode *) override
 event processing
 
int process_after_geant (PHCompositeNode *) override
 event processing
 
int ResetEvent (PHCompositeNode *) override
 Clean up after each event.
 
PHG4EventActionGetEventAction (void) const override
 accessors (reimplemented)
 
PHG4TrackingActionGetTrackingAction (void) const override
 return pointer to this subsystem stepping action
 
void SetSaveOnlyEmbeded (bool b=true)
 only save the G4 truth information that is associated with the embedded particle
 
- Public Member Functions inherited from PHG4Subsystem
 PHG4Subsystem (const std::string &name="Generic Subsystem")
 constructor
 
 ~PHG4Subsystem (void) override
 destructor
 
virtual PHG4DetectorGetDetector (void) const
 return pointer to created detector object
 
virtual PHG4SteppingActionGetSteppingAction (void) const
 return pointer to this subsystem stepping action
 
virtual PHG4DisplayActionGetDisplayAction () const
 return pointer to this subsystem display setting
 
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 Init (PHCompositeNode *)
 
virtual int Reset (PHCompositeNode *)
 Reset.
 
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 Attributes

PHG4TruthEventActionm_EventAction
 
PHG4TruthTrackingActionm_TrackingAction
 
bool m_SaveOnlyEmbededFlag
 only save the G4 truth information that is associated with the embedded particle
 

Additional Inherited Members

- Public Types inherited from Fun4AllBase
enum  enu_Verbosity {
  VERBOSITY_QUIET = 0, VERBOSITY_SOME = 1, VERBOSITY_MORE = 2, VERBOSITY_EVEN_MORE = 3,
  VERBOSITY_A_LOT = 4, VERBOSITY_MAX = INT_MAX - 10
}
 
- Protected Member Functions inherited from SubsysReco
 SubsysReco (const std::string &name="NONAME")
 

Detailed Description

Definition at line 16 of file PHG4TruthSubsystem.h.

View newest version in sPHENIX GitHub at line 16 of file PHG4TruthSubsystem.h

Constructor & Destructor Documentation

PHG4TruthSubsystem::PHG4TruthSubsystem ( const std::string &  name = "TRUTH")

constructor

Definition at line 30 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 30 of file PHG4TruthSubsystem.cc

PHG4TruthSubsystem::~PHG4TruthSubsystem ( void  )
inlineoverride

destructor

Definition at line 23 of file PHG4TruthSubsystem.h.

View newest version in sPHENIX GitHub at line 23 of file PHG4TruthSubsystem.h

Member Function Documentation

PHG4EventAction * PHG4TruthSubsystem::GetEventAction ( void  ) const
overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 151 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 151 of file PHG4TruthSubsystem.cc

References m_EventAction.

PHG4TrackingAction * PHG4TruthSubsystem::GetTrackingAction ( void  ) const
overridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 159 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 159 of file PHG4TruthSubsystem.cc

References m_TrackingAction.

int PHG4TruthSubsystem::InitRun ( PHCompositeNode topNode)
overridevirtual

init

Reimplemented from SubsysReco.

Definition at line 39 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 39 of file PHG4TruthSubsystem.cc

References PHCompositeNode::addNode(), PHNodeIterator::findFirst(), m_EventAction, and m_TrackingAction.

+ Here is the call graph for this function:

int PHG4TruthSubsystem::process_after_geant ( PHCompositeNode topNode)
overridevirtual

event processing

Reimplemented from PHG4Subsystem.

Definition at line 89 of file PHG4TruthSubsystem.cc.

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

References PHG4TruthInfoContainer::delete_particle(), PHG4TruthInfoContainer::delete_vtx(), PHG4TruthInfoContainer::GetParticleRange(), PHG4TruthInfoContainer::GetVtxRange(), PHG4TruthInfoContainer::isEmbeded(), m_SaveOnlyEmbededFlag, and Fun4AllBase::Verbosity().

+ Here is the call graph for this function:

int PHG4TruthSubsystem::process_event ( PHCompositeNode topNode)
overridevirtual

event processing

Reimplemented from SubsysReco.

Definition at line 62 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 62 of file PHG4TruthSubsystem.cc

References Fun4AllReturnCodes::EVENT_OK, exit(), m_EventAction, m_TrackingAction, PHWHERE, PHG4TruthEventAction::SetInterfacePointers(), and PHG4TruthTrackingAction::SetInterfacePointers().

+ Here is the call graph for this function:

int PHG4TruthSubsystem::ResetEvent ( PHCompositeNode topNode)
overridevirtual

Clean up after each event.

Reimplemented from SubsysReco.

Definition at line 143 of file PHG4TruthSubsystem.cc.

View newest version in sPHENIX GitHub at line 143 of file PHG4TruthSubsystem.cc

References m_EventAction, m_TrackingAction, PHG4TruthEventAction::ResetEvent(), and PHG4TruthTrackingAction::ResetEvent().

+ Here is the call graph for this function:

void PHG4TruthSubsystem::SetSaveOnlyEmbeded ( bool  b = true)
inline

only save the G4 truth information that is associated with the embedded particle

Definition at line 44 of file PHG4TruthSubsystem.h.

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

References m_SaveOnlyEmbededFlag.

Member Data Documentation

PHG4TruthEventAction* PHG4TruthSubsystem::m_EventAction
private

Definition at line 44 of file PHG4TruthSubsystem.h.

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

Referenced by GetEventAction(), InitRun(), process_event(), and ResetEvent().

bool PHG4TruthSubsystem::m_SaveOnlyEmbededFlag
private

only save the G4 truth information that is associated with the embedded particle

Definition at line 52 of file PHG4TruthSubsystem.h.

View newest version in sPHENIX GitHub at line 52 of file PHG4TruthSubsystem.h

Referenced by process_after_geant(), and SetSaveOnlyEmbeded().

PHG4TruthTrackingAction* PHG4TruthSubsystem::m_TrackingAction
private

Definition at line 49 of file PHG4TruthSubsystem.h.

View newest version in sPHENIX GitHub at line 49 of file PHG4TruthSubsystem.h

Referenced by GetTrackingAction(), InitRun(), process_event(), and ResetEvent().


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