Runs G4 as a subsystem. More...

#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/simulation/g4main/PHG4Reco.h>

Inheritance diagram for PHG4Reco:

Collaboration diagram for PHG4Reco:

Public Member Functions
	PHG4Reco (const std::string &name="PHG4RECO")
	constructor More...

virtual	~PHG4Reco ()
	destructor More...

int	Init (PHCompositeNode *)
	full initialization More...

int	InitRun (PHCompositeNode *topNode)

int	process_event (PHCompositeNode *)
	event processing method More...

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

int	End (PHCompositeNode *)
	end of run method More...

void	Print (const std::string &what=std::string()) const
	print info More...

void	registerSubsystem (PHG4Subsystem *subsystem)
	register subsystem More...

int	ApplyCommand (const std::string &cmd)
	interface to G4 cmd interpreter More...

int	StartGui ()
	start the gui More...

int	InitField (PHCompositeNode *topNode)

void	set_field (const float tesla)
	set default magnetic field strength with a constant magnetic field. Only valid if set_field_map() is not used. If available, Field map setting on DST take higher priority. More...

void	set_field_map (const std::string &fmap, const PHFieldConfig::FieldConfigTypes dim)

void	set_field_map ()

void	set_field_rescale (const float rescale)
	set default scaling factor for input magnetic field map. If available, Field map setting on DST take higher priority. More...

void	set_optical_photon (bool b)
	speed-up options setters More...

void	set_energy_threshold (double t)

void	set_zero_field_line (double z)

void	save_DST_geometry (bool b)
	Save geometry from Geant4 to DST. More...

void	SetWorldSizeX (const double sx)

void	SetWorldSizeY (const double sy)

void	SetWorldSizeZ (const double sz)

double	GetWorldSizeX () const

double	GetWorldSizeY () const

double	GetWorldSizeZ () const

void	SetWorldShape (const std::string &s)

void	SetWorldMaterial (const std::string &s)

void	SetPhysicsList (const std::string &s)

void	set_rapidity_coverage (const double eta)

int	setupInputEventNodeReader (PHCompositeNode *)

void	setGeneratorAction (G4VUserPrimaryGeneratorAction *action)

PHG4Subsystem *	getSubsystem (const std::string &name)

void	Dump_GDML (const std::string &filename)

void	G4Verbosity (const int i)

Public Member Functions inherited from SubsysReco
virtual	~SubsysReco ()

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

virtual int	Reset (PHCompositeNode *)
	Reset. More...

Public Member Functions inherited from Fun4AllBase
virtual	~Fun4AllBase ()

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

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

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

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

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

Static Public Member Functions
static void	G4Seed (const unsigned int i)

Protected Types
typedef std::list< PHG4Subsystem * >	SubsystemList
	list of subsystems More...

Protected Member Functions
int	InitUImanager ()

void	DefineMaterials ()

void	DefineRegions ()

Protected Member Functions inherited from SubsysReco
	SubsysReco (const std::string &name="NONAME")

Protected Member Functions inherited from Fun4AllBase
	Fun4AllBase (const std::string &name="NONAME")

Protected Attributes
float	magfield

float	magfield_rescale

double	WorldSize [3]

G4TBMagneticFieldSetup *	field_
	magnetic field More...

G4RunManager *	runManager_
	pointer to geant run manager More...

PHG4UIsession *	uisession_
	pointer to geant ui session More...

PHG4PhenixDetector *	detector_
	pointer to detector More...

PHG4PhenixEventAction *	eventAction_
	pointer to main event action More...

PHG4PhenixSteppingAction *	steppingAction_
	pointer to main stepping action More...

PHG4PhenixTrackingAction *	trackingAction_
	pointer to main tracking action More...

PHG4PrimaryGeneratorAction *	generatorAction_
	event generator (read from PHG4INEVENT node) More...

SubsystemList	subsystems_

G4VisManager *	visManager

double	_eta_coverage

PHFieldConfig::FieldConfigTypes	mapdim

std::string	fieldmapfile

std::string	worldshape

std::string	worldmaterial

std::string	physicslist

bool	save_DST_geometry_

PHTimeServer::timer	_timer
	module timer. More...

bool	optical_photon_
	speed up options More...

double	energy_threshold_

double	zero_field_line_

Protected Attributes inherited from Fun4AllBase
std::string	ThisName

int	verbosity
	The verbosity level. 0 means not verbose at all. More...

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 }

Detailed Description

Runs G4 as a subsystem.

Definition at line 36 of file PHG4Reco.h.

Member Typedef Documentation

◆ SubsystemList

typedef std::list<PHG4Subsystem *> PHG4Reco::SubsystemList

protected

list of subsystems

Definition at line 167 of file PHG4Reco.h.

Constructor & Destructor Documentation

◆ PHG4Reco()

PHG4Reco::PHG4Reco ( const std::string & name = "PHG4RECO" )

constructor

Definition at line 116 of file PHG4Reco.cc.

References WorldSize.

◆ ~PHG4Reco()

PHG4Reco::~PHG4Reco ( void )

virtual

destructor

Definition at line 153 of file PHG4Reco.cc.

References field_, gui_thread, runManager_, subsystems_, uisession_, and visManager.

Member Function Documentation

◆ ApplyCommand()

int PHG4Reco::ApplyCommand ( const std::string & cmd )

interface to G4 cmd interpreter

Definition at line 568 of file PHG4Reco.cc.

References submit_bnl::cmd, InitUImanager(), and UImanager.

Here is the call graph for this function:

◆ DefineMaterials()

void PHG4Reco::DefineMaterials ( )

protected

ePHENIX TPC - Jin Huang jhuan.nosp@m.g@bn.nosp@m.l.gov Ref: B. Yu et al. A gem based tpc for the legs experiment. In Nuclear Science Symposium Conference Record, 2005 IEEE, volume 2, pages 924-928, 2005. doi:10.1109/NSSMIC.2005.1596405.

Definition at line 753 of file PHG4Reco.cc.

References Fun4AllBase::verbosity.

Referenced by Init().

Here is the caller graph for this function:

◆ DefineRegions()

void PHG4Reco::DefineRegions ( )

protected

Definition at line 1368 of file PHG4Reco.cc.

Referenced by Init().

Here is the caller graph for this function:

◆ Dump_GDML()

void PHG4Reco::Dump_GDML ( const std::string & filename )

Definition at line 562 of file PHG4Reco.cc.

References detector_, PHG4GDMLUtility::Dump_GDML(), and PHG4PhenixDetector::GetPhysicalVolume().

Referenced by InitRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ End()

int PHG4Reco::End ( PHCompositeNode * )

virtual

end of run method

Reimplemented from SubsysReco.

Definition at line 674 of file PHG4Reco.cc.

◆ G4Seed()

void PHG4Reco::G4Seed ( const unsigned int i )

static

Definition at line 727 of file PHG4Reco.cc.

Referenced by Init().

Here is the caller graph for this function:

◆ G4Verbosity()

void PHG4Reco::G4Verbosity ( const int i )

Definition at line 1405 of file PHG4Reco.cc.

References runManager_.

◆ getSubsystem()

PHG4Subsystem * PHG4Reco::getSubsystem ( const std::string & name )

Definition at line 1386 of file PHG4Reco.cc.

References subsystems_, and Fun4AllBase::verbosity.

◆ GetWorldSizeX()

double PHG4Reco::GetWorldSizeX ( ) const

inline

Definition at line 110 of file PHG4Reco.h.

References WorldSize.

◆ GetWorldSizeY()

double PHG4Reco::GetWorldSizeY ( ) const

inline

Definition at line 111 of file PHG4Reco.h.

References WorldSize.

◆ GetWorldSizeZ()

double PHG4Reco::GetWorldSizeZ ( ) const

inline

Definition at line 112 of file PHG4Reco.h.

References WorldSize.

◆ Init()

int PHG4Reco::Init ( PHCompositeNode * topNode )

virtual

full initialization

Reimplemented from SubsysReco.

Definition at line 170 of file PHG4Reco.cc.

References DefineMaterials(), DefineRegions(), G4Seed(), PHWHERE, physicslist, runManager_, subsystems_, uisession_, and Fun4AllBase::verbosity.

Here is the call graph for this function:

◆ InitField()

int PHG4Reco::InitField ( PHCompositeNode * topNode )

Definition at line 268 of file PHG4Reco.cc.

References Fun4AllReturnCodes::EVENT_OK, field_, fieldmapfile, PHFieldUtility::GetFieldMapNode(), magfield, magfield_rescale, mapdim, Fun4AllBase::Verbosity(), and Fun4AllBase::verbosity.

Referenced by InitRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitRun()

int PHG4Reco::InitRun ( PHCompositeNode * )

virtual

Called for first event when run number is known. Typically this is where you may want to fetch data from database, because you know the run number.

Reimplemented from SubsysReco.

Definition at line 322 of file PHG4Reco.cc.

Here is the call graph for this function:

◆ InitUImanager()

int PHG4Reco::InitUImanager ( )

protected

Definition at line 588 of file PHG4Reco.cc.

References UImanager, and visManager.

Referenced by ApplyCommand(), and StartGui().

Here is the caller graph for this function:

◆ Print()

void PHG4Reco::Print ( const std::string & what = std::string() ) const

virtual

print info

Reimplemented from SubsysReco.

Definition at line 679 of file PHG4Reco.cc.

References subsystems_.

◆ process_event()

int PHG4Reco::process_event ( PHCompositeNode * topNode )

virtual

event processing method

Reimplemented from SubsysReco.

Definition at line 602 of file PHG4Reco.cc.

References _timer, Fun4AllReturnCodes::ABORTEVENT, generatorAction_, PHTimeServer::timer::get(), PHG4InEvent::identify(), PHWHERE, PHTimer::restart(), runManager_, PHG4PrimaryGeneratorAction::SetInEvent(), PHTimer::stop(), subsystems_, and Fun4AllBase::Verbosity().

Here is the call graph for this function:

◆ registerSubsystem()

void PHG4Reco::registerSubsystem ( PHG4Subsystem * subsystem )

inline

register subsystem

Definition at line 63 of file PHG4Reco.h.

References subsystems_.

◆ ResetEvent()

int PHG4Reco::ResetEvent ( PHCompositeNode * topNode )

virtual

Clean up after each event.

Reimplemented from SubsysReco.

Definition at line 663 of file PHG4Reco.cc.

References subsystems_.

◆ save_DST_geometry()

void PHG4Reco::save_DST_geometry ( bool b )

inline

Save geometry from Geant4 to DST.

Definition at line 106 of file PHG4Reco.h.

References save_DST_geometry_.

◆ set_energy_threshold()

void PHG4Reco::set_energy_threshold ( double t )

inline

Definition at line 102 of file PHG4Reco.h.

References energy_threshold_.

◆ set_field()

void PHG4Reco::set_field ( const float tesla )

inline

set default magnetic field strength with a constant magnetic field. Only valid if set_field_map() is not used. If available, Field map setting on DST take higher priority.

Definition at line 77 of file PHG4Reco.h.

References magfield.

◆ set_field_map() [1/2]

void PHG4Reco::set_field_map ( )

Set the magnetic field maps/strengths. This will be the default setting method in E1039. It takes the parameter values from recoConsts. Thus you can change parameters by calling recoConsts::set_DoubleFlag() etc. beforehand.

Definition at line 309 of file PHG4Reco.cc.

References PHFlag::get_CharFlag(), PHFlag::get_DoubleFlag(), recoConsts::instance(), PHFieldConfig::RegionalConst, and Fun4AllBase::verbosity.

Here is the call graph for this function:

◆ set_field_map() [2/2]

void PHG4Reco::set_field_map	(	const std::string &	fmap,
		const PHFieldConfig::FieldConfigTypes	dim
	)

inline

Set default field map. If available, Field map setting on DST take higher priority.

Parameters

[in]	fmap	Field map ROOT file
[in]	dim	Field map format. See PHFieldConfig::FieldConfigTypes for available formats.

Definition at line 85 of file PHG4Reco.h.

References fieldmapfile, and mapdim.

◆ set_field_rescale()

void PHG4Reco::set_field_rescale ( const float rescale )

inline

set default scaling factor for input magnetic field map. If available, Field map setting on DST take higher priority.

Definition at line 98 of file PHG4Reco.h.

References magfield_rescale.

◆ set_optical_photon()

void PHG4Reco::set_optical_photon ( bool b )

inline

speed-up options setters

Definition at line 101 of file PHG4Reco.h.

References optical_photon_.

◆ set_rapidity_coverage()

void PHG4Reco::set_rapidity_coverage ( const double eta )

Definition at line 721 of file PHG4Reco.cc.

References _eta_coverage, and PHG4Utils::SetPseudoRapidityCoverage().

Here is the call graph for this function:

◆ set_zero_field_line()

void PHG4Reco::set_zero_field_line ( double z )

inline

Definition at line 103 of file PHG4Reco.h.

References zero_field_line_.

◆ setGeneratorAction()

void PHG4Reco::setGeneratorAction ( G4VUserPrimaryGeneratorAction * action )

Definition at line 712 of file PHG4Reco.cc.

References runManager_.

◆ SetPhysicsList()

void PHG4Reco::SetPhysicsList ( const std::string & s )

inline

Definition at line 115 of file PHG4Reco.h.

References physicslist.

◆ setupInputEventNodeReader()

int PHG4Reco::setupInputEventNodeReader ( PHCompositeNode * topNode )

Definition at line 694 of file PHG4Reco.cc.

References PHCompositeNode::addNode(), PHNodeIterator::findFirst(), generatorAction_, and runManager_.

Referenced by InitRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetWorldMaterial()

void PHG4Reco::SetWorldMaterial ( const std::string & s )

inline

Definition at line 114 of file PHG4Reco.h.

References worldmaterial.

◆ SetWorldShape()

void PHG4Reco::SetWorldShape ( const std::string & s )

inline

Definition at line 113 of file PHG4Reco.h.

References worldshape.

◆ SetWorldSizeX()

void PHG4Reco::SetWorldSizeX ( const double sx )

inline

Definition at line 107 of file PHG4Reco.h.

References WorldSize.

◆ SetWorldSizeY()

void PHG4Reco::SetWorldSizeY ( const double sy )

inline

Definition at line 108 of file PHG4Reco.h.

References WorldSize.

◆ SetWorldSizeZ()

void PHG4Reco::SetWorldSizeZ ( const double sz )

inline

Definition at line 109 of file PHG4Reco.h.

References WorldSize.

◆ StartGui()

int PHG4Reco::StartGui ( )

start the gui

Definition at line 576 of file PHG4Reco.cc.

References g4guithread(), gui_thread, and InitUImanager().

Here is the call graph for this function:

Member Data Documentation

◆ _eta_coverage

double PHG4Reco::_eta_coverage

protected

Definition at line 173 of file PHG4Reco.h.

Referenced by set_rapidity_coverage().

◆ _timer

PHTimeServer::timer PHG4Reco::_timer

protected

module timer.

Definition at line 183 of file PHG4Reco.h.

Referenced by process_event().

◆ detector_

PHG4PhenixDetector* PHG4Reco::detector_

protected

pointer to detector

Definition at line 152 of file PHG4Reco.h.

Referenced by Dump_GDML(), and InitRun().

◆ energy_threshold_

double PHG4Reco::energy_threshold_

protected

Definition at line 187 of file PHG4Reco.h.

Referenced by InitRun(), and set_energy_threshold().

◆ eventAction_

PHG4PhenixEventAction* PHG4Reco::eventAction_

protected

pointer to main event action

Definition at line 155 of file PHG4Reco.h.

Referenced by InitRun().

◆ field_

G4TBMagneticFieldSetup* PHG4Reco::field_

protected

magnetic field

Definition at line 143 of file PHG4Reco.h.

Referenced by InitField(), InitRun(), and ~PHG4Reco().

◆ fieldmapfile

std::string PHG4Reco::fieldmapfile

protected

Definition at line 175 of file PHG4Reco.h.

Referenced by InitField(), and set_field_map().

◆ generatorAction_

PHG4PrimaryGeneratorAction* PHG4Reco::generatorAction_

protected

event generator (read from PHG4INEVENT node)

Definition at line 164 of file PHG4Reco.h.

Referenced by process_event(), and setupInputEventNodeReader().

◆ magfield

float PHG4Reco::magfield

protected

Definition at line 138 of file PHG4Reco.h.

Referenced by InitField(), and set_field().

◆ magfield_rescale

float PHG4Reco::magfield_rescale

protected

Definition at line 139 of file PHG4Reco.h.

Referenced by InitField(), and set_field_rescale().

◆ mapdim

PHFieldConfig::FieldConfigTypes PHG4Reco::mapdim

protected

Definition at line 174 of file PHG4Reco.h.

Referenced by InitField(), and set_field_map().

◆ optical_photon_

bool PHG4Reco::optical_photon_

protected

speed up options

Definition at line 186 of file PHG4Reco.h.

Referenced by InitRun(), and set_optical_photon().

◆ physicslist

std::string PHG4Reco::physicslist

protected

Definition at line 178 of file PHG4Reco.h.

Referenced by Init(), and SetPhysicsList().

◆ runManager_

G4RunManager* PHG4Reco::runManager_

protected

pointer to geant run manager

Definition at line 146 of file PHG4Reco.h.

Referenced by G4Verbosity(), Init(), InitRun(), process_event(), setGeneratorAction(), setupInputEventNodeReader(), and ~PHG4Reco().

◆ save_DST_geometry_

bool PHG4Reco::save_DST_geometry_

protected

Definition at line 180 of file PHG4Reco.h.

Referenced by InitRun(), and save_DST_geometry().

◆ steppingAction_

PHG4PhenixSteppingAction* PHG4Reco::steppingAction_

protected

pointer to main stepping action

Definition at line 158 of file PHG4Reco.h.

Referenced by InitRun().

◆ subsystems_

SubsystemList PHG4Reco::subsystems_

protected

Definition at line 168 of file PHG4Reco.h.

Referenced by getSubsystem(), Init(), InitRun(), Print(), process_event(), registerSubsystem(), ResetEvent(), and ~PHG4Reco().

◆ trackingAction_

PHG4PhenixTrackingAction* PHG4Reco::trackingAction_

protected

pointer to main tracking action

Definition at line 161 of file PHG4Reco.h.

Referenced by InitRun().

◆ uisession_

PHG4UIsession* PHG4Reco::uisession_

protected

pointer to geant ui session

Definition at line 149 of file PHG4Reco.h.

Referenced by Init(), InitRun(), and ~PHG4Reco().

◆ visManager

G4VisManager* PHG4Reco::visManager

protected

Definition at line 171 of file PHG4Reco.h.

Referenced by InitUImanager(), and ~PHG4Reco().

◆ worldmaterial

std::string PHG4Reco::worldmaterial

protected

Definition at line 177 of file PHG4Reco.h.

Referenced by InitRun(), and SetWorldMaterial().

◆ worldshape

std::string PHG4Reco::worldshape

protected

Definition at line 176 of file PHG4Reco.h.

Referenced by InitRun(), and SetWorldShape().

◆ WorldSize

double PHG4Reco::WorldSize[3]

protected

Definition at line 140 of file PHG4Reco.h.

Referenced by GetWorldSizeX(), GetWorldSizeY(), GetWorldSizeZ(), InitRun(), PHG4Reco(), SetWorldSizeX(), SetWorldSizeY(), and SetWorldSizeZ().

◆ zero_field_line_

double PHG4Reco::zero_field_line_

protected

Definition at line 188 of file PHG4Reco.h.

Referenced by InitRun(), and set_zero_field_line().

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

/dev/shm/kenichi/update-github-e1039-doc/e1039-core/simulation/g4main/PHG4Reco.h
/dev/shm/kenichi/update-github-e1039-doc/e1039-core/simulation/g4main/PHG4Reco.cc

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SubsystemList

Constructor & Destructor Documentation

◆ PHG4Reco()

◆ ~PHG4Reco()

Member Function Documentation

◆ ApplyCommand()

◆ DefineMaterials()

◆ DefineRegions()

◆ Dump_GDML()

◆ End()

◆ G4Seed()

◆ G4Verbosity()

◆ getSubsystem()

◆ GetWorldSizeX()

◆ GetWorldSizeY()

◆ GetWorldSizeZ()

◆ Init()

◆ InitField()

◆ InitRun()

◆ InitUImanager()

◆ Print()

◆ process_event()

◆ registerSubsystem()

◆ ResetEvent()

◆ save_DST_geometry()

◆ set_energy_threshold()

◆ set_field()

◆ set_field_map() [1/2]

◆ set_field_map() [2/2]

◆ set_field_rescale()

◆ set_optical_photon()

◆ set_rapidity_coverage()

◆ set_zero_field_line()

◆ setGeneratorAction()

◆ SetPhysicsList()

◆ setupInputEventNodeReader()

◆ SetWorldMaterial()

◆ SetWorldShape()

◆ SetWorldSizeX()

◆ SetWorldSizeY()

◆ SetWorldSizeZ()

◆ StartGui()

Member Data Documentation

◆ _eta_coverage

◆ _timer

◆ detector_

◆ energy_threshold_

◆ eventAction_

◆ field_

◆ fieldmapfile

◆ generatorAction_

◆ magfield

◆ magfield_rescale

◆ mapdim

◆ optical_photon_

◆ physicslist

◆ runManager_

◆ save_DST_geometry_

◆ steppingAction_

◆ subsystems_

◆ trackingAction_

◆ uisession_

◆ visManager

◆ worldmaterial

◆ worldshape

◆ WorldSize

◆ zero_field_line_