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

Inheritance diagram for PHG4DetectorSubsystem:

Collaboration diagram for PHG4DetectorSubsystem:

Public Types
enum	FILE_TYPE { none = 0 , xml = 1 , root = 2 }

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 }

Public Member Functions
virtual	~PHG4DetectorSubsystem ()

int	Init (PHCompositeNode *) final

int	InitRun (PHCompositeNode *) final

virtual int	InitRunSubsystem (PHCompositeNode *)

virtual int	InitSubsystem (PHCompositeNode *)

void	OverlapCheck (const bool chk=true)

bool	CheckOverlap () const

PHParameters *	GetParams () const

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

double	get_double_param (const std::string &name) const

void	set_vdouble_param (const std::string &name, const std::vector< double > vdval)

void	set_vdouble_param (const std::string &name, const double dvals[], const unsigned int n)

std::vector< double >	get_vdouble_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

FILE_TYPE	get_filetype () const

void	UseCalibFiles (const FILE_TYPE ftyp)

int	SaveParamsToDB ()

int	ReadParamsFromDB (const std::string &name, 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	SuperDetector (const std::string &name)

const std::string	SuperDetector () const

int	GetLayer () const

virtual void	SetDefaultParameters ()=0

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

virtual	~PHG4Subsystem (void)
	destructor More...

virtual int	process_after_geant (PHCompositeNode *)
	event processing More...

virtual PHG4Detector *	GetDetector (void) const
	return pointer to created detector object More...

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

virtual PHG4SteppingAction *	GetSteppingAction (void) const
	return pointer to this subsystem stepping action More...

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

void	OverlapCheck (const bool chk=true)

bool	CheckOverlap () const

PHParameters *	GetParams ()

Public Member Functions inherited from SubsysReco
virtual	~SubsysReco ()

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

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

virtual int	process_event (PHCompositeNode *)

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

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

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

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

Protected Member Functions
	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_vdouble_param (const std::string &name, const std::vector< 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

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

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

Additional Inherited Members
Protected Attributes inherited from PHG4Subsystem
bool	overlapcheck

PHParameters *	params

Protected Attributes inherited from Fun4AllBase
std::string	ThisName

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

Detailed Description

Definition at line 13 of file PHG4DetectorSubsystem.h.

Member Enumeration Documentation

◆ FILE_TYPE

enum PHG4DetectorSubsystem::FILE_TYPE

Enumerator
none
xml
root

Definition at line 17 of file PHG4DetectorSubsystem.h.

Constructor & Destructor Documentation

◆ ~PHG4DetectorSubsystem()

virtual PHG4DetectorSubsystem::~PHG4DetectorSubsystem ( )

inlinevirtual

Definition at line 19 of file PHG4DetectorSubsystem.h.

◆ PHG4DetectorSubsystem()

PHG4DetectorSubsystem::PHG4DetectorSubsystem	(	const std::string &	name = `"GenericSubsystem"`,
		const int	lyr = `0`
	)

protected

Definition at line 22 of file PHG4DetectorSubsystem.cc.

References Fun4AllBase::Name(), and PHG4Subsystem::params.

Here is the call graph for this function:

Member Function Documentation

◆ BeginRunExecuted()

int PHG4DetectorSubsystem::BeginRunExecuted ( ) const

inlineprotected

Definition at line 82 of file PHG4DetectorSubsystem.h.

Referenced by PHG4BNLTargetCoilSubsystem::Print(), PHG4CylinderSubsystem::Print(), PHG4PolyconSubsystem::Print(), PHG4TargetCoilSubsystem::Print(), and PHG4TargetCoilV2Subsystem::Print().

Here is the caller graph for this function:

◆ BlackHole()

void PHG4DetectorSubsystem::BlackHole ( const int i = 1 )

Definition at line 476 of file PHG4DetectorSubsystem.cc.

◆ CheckOverlap()

bool PHG4DetectorSubsystem::CheckOverlap ( ) const

inline

Definition at line 34 of file PHG4DetectorSubsystem.h.

Referenced by PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4EMCalSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), PHG4TargetCoilV2Subsystem::InitRunSubsystem(), and SQG4DipoleMagnetSubsystem::InitRunSubsystem().

Here is the caller graph for this function:

◆ get_double_param()

double PHG4DetectorSubsystem::get_double_param ( const std::string & name ) const

Definition at line 201 of file PHG4DetectorSubsystem.cc.

References PHParameters::get_double_param(), and PHG4Subsystem::params.

Referenced by PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), and PHG4TargetCoilV2Subsystem::InitRunSubsystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_filetype()

FILE_TYPE PHG4DetectorSubsystem::get_filetype ( ) const

inline

Definition at line 51 of file PHG4DetectorSubsystem.h.

Referenced by InitRun().

Here is the caller graph for this function:

◆ get_int_param()

int PHG4DetectorSubsystem::get_int_param ( const std::string & name ) const

Definition at line 223 of file PHG4DetectorSubsystem.cc.

References PHParameters::get_int_param(), and PHG4Subsystem::params.

Referenced by PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4EMCalSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), PHG4TargetCoilV2Subsystem::InitRunSubsystem(), and SQG4DipoleMagnetSubsystem::InitRunSubsystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_string_param()

string PHG4DetectorSubsystem::get_string_param ( const std::string & name ) const

Definition at line 245 of file PHG4DetectorSubsystem.cc.

References PHParameters::get_string_param(), and PHG4Subsystem::params.

Here is the call graph for this function:

◆ get_vdouble_param()

std::vector< double > PHG4DetectorSubsystem::get_vdouble_param ( const std::string & name ) const

Definition at line 171 of file PHG4DetectorSubsystem.cc.

References PHParameters::get_vdouble_param(), and PHG4Subsystem::params.

Here is the call graph for this function:

◆ GetLayer()

int PHG4DetectorSubsystem::GetLayer ( ) const

inline

Definition at line 69 of file PHG4DetectorSubsystem.h.

Referenced by PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), PHG4TargetCoilV2Subsystem::InitRunSubsystem(), and SQG4DipoleMagnetSubsystem::InitRunSubsystem().

Here is the caller graph for this function:

◆ GetParams()

PHParameters* PHG4DetectorSubsystem::GetParams ( ) const

inline

Definition at line 36 of file PHG4DetectorSubsystem.h.

References PHG4Subsystem::params.

Here is the caller graph for this function:

◆ Init()

int PHG4DetectorSubsystem::Init ( PHCompositeNode * )

finalvirtual

Called during initialization, i.e. registered via Fun4AllServer::registerSubsystem(). Typically this is where you can book histograms, and e.g. register them to Fun4AllServer (so they can be output to file using Fun4AllServer::dumpHistos() method).

Reimplemented from SubsysReco.

Definition at line 45 of file PHG4DetectorSubsystem.cc.

References InitSubsystem(), Fun4AllBase::Name(), PHG4Subsystem::params, and PHParameters::set_name().

Here is the call graph for this function:

◆ InitializeParameters()

void PHG4DetectorSubsystem::InitializeParameters ( )

protected

Definition at line 342 of file PHG4DetectorSubsystem.cc.

References PHG4Subsystem::params, set_default_int_param(), PHParameters::set_double_param(), PHParameters::set_int_param(), PHParameters::set_string_param(), PHParameters::set_vdouble_param(), and SetDefaultParameters().

Referenced by PHG4BlockSubsystem::PHG4BlockSubsystem(), PHG4BNLTargetCoilSubsystem::PHG4BNLTargetCoilSubsystem(), PHG4CollimatorSubsystem::PHG4CollimatorSubsystem(), PHG4CylinderSubsystem::PHG4CylinderSubsystem(), PHG4EMCalSubsystem::PHG4EMCalSubsystem(), PHG4PolyconSubsystem::PHG4PolyconSubsystem(), PHG4SquareTubeSubsystem::PHG4SquareTubeSubsystem(), PHG4TargetCoilSubsystem::PHG4TargetCoilSubsystem(), PHG4TargetCoilV2Subsystem::PHG4TargetCoilV2Subsystem(), and SQG4DipoleMagnetSubsystem::SQG4DipoleMagnetSubsystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitRun()

int PHG4DetectorSubsystem::InitRun ( PHCompositeNode * )

finalvirtual

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 54 of file PHG4DetectorSubsystem.cc.

References PHCompositeNode::addNode(), PHParametersContainer::AddPHParameters(), PHParameters::FillFrom(), PHNodeIterator::findFirst(), get_filetype(), InitRunSubsystem(), PHParameters::Name(), Fun4AllBase::Name(), none, PHG4Subsystem::params, PHWHERE, PdbParameterMapContainer::print(), ReadDB(), ReadParamsFromDB(), PHParameters::SaveToNodeTree(), SuperDetector(), UpdateParametersWithMacro(), and Fun4AllBase::Verbosity().

Here is the call graph for this function:

◆ InitRunSubsystem()

virtual int PHG4DetectorSubsystem::InitRunSubsystem ( PHCompositeNode * )

inlinevirtual

Reimplemented in SQG4DipoleMagnetSubsystem, PHG4TargetCoilV2Subsystem, PHG4TargetCoilSubsystem, PHG4SquareTubeSubsystem, PHG4PolyconSubsystem, PHG4EMCalSubsystem, PHG4CylinderSubsystem, PHG4CollimatorSubsystem, PHG4BNLTargetCoilSubsystem, and PHG4BlockSubsystem.

Definition at line 30 of file PHG4DetectorSubsystem.h.

Referenced by InitRun().

Here is the caller graph for this function:

◆ InitSubsystem()

virtual int PHG4DetectorSubsystem::InitSubsystem ( PHCompositeNode * )

inlinevirtual

Definition at line 31 of file PHG4DetectorSubsystem.h.

Referenced by Init().

Here is the caller graph for this function:

◆ OverlapCheck()

void PHG4DetectorSubsystem::OverlapCheck ( const bool chk = true )

inline

Definition at line 33 of file PHG4DetectorSubsystem.h.

◆ ReadDB()

int PHG4DetectorSubsystem::ReadDB ( ) const

inline

Definition at line 50 of file PHG4DetectorSubsystem.h.

Referenced by InitRun().

Here is the caller graph for this function:

◆ ReadParamsFromDB()

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

Definition at line 389 of file PHG4DetectorSubsystem.cc.

References PHG4Subsystem::params, and PHParameters::ReadFromDB().

Referenced by InitRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveParamsToDB()

int PHG4DetectorSubsystem::SaveParamsToDB ( )

Definition at line 370 of file PHG4DetectorSubsystem.cc.

References PHG4Subsystem::params, PHParameters::WriteToDB(), and PHParametersContainer::WriteToDB().

Here is the call graph for this function:

◆ set_default_double_param()

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

protected

Definition at line 273 of file PHG4DetectorSubsystem.cc.

◆ set_default_int_param()

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

protected

Definition at line 310 of file PHG4DetectorSubsystem.cc.

Referenced by InitializeParameters().

Here is the caller graph for this function:

◆ set_default_string_param()

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

protected

Definition at line 326 of file PHG4DetectorSubsystem.cc.

◆ set_default_vdouble_param()

void PHG4DetectorSubsystem::set_default_vdouble_param	(	const std::string &	name,
		const std::vector< double > &	dval
	)

protected

Definition at line 289 of file PHG4DetectorSubsystem.cc.

◆ set_double_param()

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

Definition at line 155 of file PHG4DetectorSubsystem.cc.

◆ set_int_param()

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

Definition at line 207 of file PHG4DetectorSubsystem.cc.

◆ set_string_param()

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

Definition at line 229 of file PHG4DetectorSubsystem.cc.

◆ set_vdouble_param() [1/2]

void PHG4DetectorSubsystem::set_vdouble_param	(	const std::string &	name,
		const double	dvals[],
		const unsigned int	n
	)

Definition at line 193 of file PHG4DetectorSubsystem.cc.

References set_vdouble_param().

Here is the call graph for this function:

◆ set_vdouble_param() [2/2]

void PHG4DetectorSubsystem::set_vdouble_param	(	const std::string &	name,
		const std::vector< double >	vdval
	)

Definition at line 177 of file PHG4DetectorSubsystem.cc.

Referenced by set_vdouble_param().

Here is the caller graph for this function:

◆ SetAbsorberActive()

void PHG4DetectorSubsystem::SetAbsorberActive ( const int i = 1 )

Definition at line 470 of file PHG4DetectorSubsystem.cc.

◆ SetAbsorberTruth()

void PHG4DetectorSubsystem::SetAbsorberTruth ( const int i = 1 )

Definition at line 482 of file PHG4DetectorSubsystem.cc.

◆ SetActive()

void PHG4DetectorSubsystem::SetActive ( const int i = 1 )

Definition at line 464 of file PHG4DetectorSubsystem.cc.

◆ SetCalibrationFileDir()

void PHG4DetectorSubsystem::SetCalibrationFileDir ( const std::string & calibdir )

inline

Definition at line 58 of file PHG4DetectorSubsystem.h.

◆ SetDefaultParameters()

virtual void PHG4DetectorSubsystem::SetDefaultParameters ( )

pure virtual

Referenced by InitializeParameters().

Here is the caller graph for this function:

◆ SuperDetector() [1/2]

const std::string PHG4DetectorSubsystem::SuperDetector ( ) const

inline

Definition at line 67 of file PHG4DetectorSubsystem.h.

Referenced by InitRun(), PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4EMCalSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), PHG4TargetCoilV2Subsystem::InitRunSubsystem(), and SQG4DipoleMagnetSubsystem::InitRunSubsystem().

Here is the caller graph for this function:

◆ SuperDetector() [2/2]

void PHG4DetectorSubsystem::SuperDetector ( const std::string & name )

Definition at line 148 of file PHG4DetectorSubsystem.cc.

◆ UpdateParametersWithMacro()

void PHG4DetectorSubsystem::UpdateParametersWithMacro ( )

Definition at line 251 of file PHG4DetectorSubsystem.cc.

References PHG4Subsystem::params, PHParameters::set_double_param(), PHParameters::set_int_param(), PHParameters::set_string_param(), and PHParameters::set_vdouble_param().

Referenced by InitRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UseCalibFiles()

void PHG4DetectorSubsystem::UseCalibFiles ( const FILE_TYPE ftyp )

inline

Definition at line 53 of file PHG4DetectorSubsystem.h.

◆ UseDB()

void PHG4DetectorSubsystem::UseDB ( const int i = 1 )

inline

Definition at line 49 of file PHG4DetectorSubsystem.h.

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

/dev/shm/kenichi/update-github-e1039-doc/e1039-core/simulation/g4detectors/PHG4DetectorSubsystem.h
/dev/shm/kenichi/update-github-e1039-doc/e1039-core/simulation/g4detectors/PHG4DetectorSubsystem.cc

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FILE_TYPE

Constructor & Destructor Documentation

◆ ~PHG4DetectorSubsystem()

◆ PHG4DetectorSubsystem()

Member Function Documentation

◆ BeginRunExecuted()

◆ BlackHole()

◆ CheckOverlap()

◆ get_double_param()

◆ get_filetype()

◆ get_int_param()

◆ get_string_param()

◆ get_vdouble_param()

◆ GetLayer()

◆ GetParams()

◆ Init()

◆ InitializeParameters()

◆ InitRun()

◆ InitRunSubsystem()

◆ InitSubsystem()

◆ OverlapCheck()

◆ ReadDB()

◆ ReadParamsFromDB()

◆ SaveParamsToDB()

◆ set_default_double_param()

◆ set_default_int_param()

◆ set_default_string_param()

◆ set_default_vdouble_param()

◆ set_double_param()

◆ set_int_param()

◆ set_string_param()

◆ set_vdouble_param() [1/2]

◆ set_vdouble_param() [2/2]

◆ SetAbsorberActive()

◆ SetAbsorberTruth()

◆ SetActive()

◆ SetCalibrationFileDir()

◆ SetDefaultParameters()

◆ SuperDetector() [1/2]

◆ SuperDetector() [2/2]

◆ UpdateParametersWithMacro()

◆ UseCalibFiles()

◆ UseDB()