Toolsets to do geometry operations. More...

#include <coresoftware/blob/master/offline/packages/PHField/PHFieldUtility.h>

Static Public Member Functions
static PHFieldConfig *	DefaultFieldConfig ()

static PHField *	GetFieldMapNode (const PHFieldConfig default_config=nullptr, PHCompositeNode topNode=nullptr, const int verbosity=0)
	Get transient PHField from DST nodes. If not found, make a new one based on default_config.

static PHFieldConfig *	GetFieldConfigNode (const PHFieldConfig default_config=nullptr, PHCompositeNode topNode=nullptr, const int verbosity=0)
	Get persistent PHGeomIOTGeo from DST nodes. If not found, make a new one.

static PHField *	BuildFieldMap (const PHFieldConfig *field_config, float inner_radius=0., float outer_radius=1.e10, float size_z=1.e10, const int verbosity=0)
	Build or build field map with a configuration object.

static std::string	GetDSTFieldMapNodeName ()
	DST node name for RunTime field map object.

static std::string	GetDSTConfigNodeName ()
	DST node name for persistent field configuration node.

Private Member Functions
	PHFieldUtility ()=delete

	~PHFieldUtility ()=delete

Detailed Description

Toolsets to do geometry operations.

Definition at line 11 of file PHFieldUtility.h.

View newest version in sPHENIX GitHub at line 11 of file PHFieldUtility.h

Constructor & Destructor Documentation

PHFieldUtility::PHFieldUtility ( )

privatedelete

PHFieldUtility::~PHFieldUtility ( )

privatedelete

Member Function Documentation

PHField * PHFieldUtility::BuildFieldMap	(	const PHFieldConfig *	field_config,
		float	inner_radius = `0.`,
		float	outer_radius = `1.e10`,
		float	size_z = `1.e10`,
		const int	verbosity = `0`
	)

static

Build or build field map with a configuration object.

Definition at line 28 of file PHFieldUtility.cc.

View newest version in sPHENIX GitHub at line 28 of file PHFieldUtility.cc

References assert, ckf::field, PHFieldConfig::Field3DCartesian, PHFieldConfig::get_field_config(), PHFieldConfig::get_field_mag_x(), PHFieldConfig::get_field_mag_y(), PHFieldConfig::get_field_mag_z(), PHFieldConfig::get_filename(), PHFieldConfig::get_magfield_rescale(), PHFieldConfig::identify(), G4CEMCALBEDO::inner_radius, PHFieldConfig::kField2D, PHFieldConfig::kField3DCylindrical, PHFieldConfig::kFieldUniform, G4HCALOUT::outer_radius, G4HCALOUT::size_z, and verbosity.

Referenced by GetFieldMapNode(), PHSimpleKFProp::InitRun(), main(), PHG4OHCalFieldSetup::PHG4OHCalFieldSetup(), and PHCASeeding::Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

PHFieldConfig * PHFieldUtility::DefaultFieldConfig ( )

static

Make a default PHFieldConfig as in default macro of pro.3 release Field map = /phenix/upgrades/decadal/fieldmaps/sPHENIX.2d.root Field Scale to 1.4/1.5 default field configuration object. Caller assumes ownership

Make a default PHFieldConfig Field map = /phenix/upgrades/decadal/fieldmaps/sPHENIX.2d.root Field Scale to 1.4/1.5 default field configuration object. Caller assumes ownership

Definition at line 89 of file PHFieldUtility.cc.

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

References PHFieldConfig::Field3DCartesian.

Referenced by GetFieldConfigNode(), and main().

Here is the caller graph for this function:

static std::string PHFieldUtility::GetDSTConfigNodeName ( )

inlinestatic

DST node name for persistent field configuration node.

Definition at line 45 of file PHFieldUtility.h.

View newest version in sPHENIX GitHub at line 45 of file PHFieldUtility.h

Referenced by GetFieldConfigNode(), and PHG4OHCalDetector::PHG4OHCalDetector().

Here is the caller graph for this function:

static std::string PHFieldUtility::GetDSTFieldMapNodeName ( )

inlinestatic

DST node name for RunTime field map object.

Definition at line 38 of file PHFieldUtility.h.

View newest version in sPHENIX GitHub at line 38 of file PHFieldUtility.h

Referenced by GetFieldMapNode().

Here is the caller graph for this function:

PHFieldConfig * PHFieldUtility::GetFieldConfigNode	(	const PHFieldConfig *	default_config = `nullptr`,
		PHCompositeNode *	topNode = `nullptr`,
		const int	verbosity = `0`
	)

static

Get persistent PHGeomIOTGeo from DST nodes. If not found, make a new one.

Get persistent PHFieldConfig from DST nodes. If not found, make a new one based on default_config

Parameters

[in]	default_config	default configuraiton if not on DST. If nullptr, use DefaultFieldConfig() as the default
[in]	topNode	you know who....

Definition at line 136 of file PHFieldUtility.cc.

View newest version in sPHENIX GitHub at line 136 of file PHFieldUtility.cc

References assert, PHObject::CloneMe(), DefaultFieldConfig(), ckf::field, PHNodeIterator::findFirst(), GetDSTConfigNodeName(), PHFieldConfig::identify(), Fun4AllServer::instance(), PHWHERE, and Fun4AllServer::topNode().

Referenced by GetFieldMapNode().

Here is the call graph for this function:

Here is the caller graph for this function:

PHField * PHFieldUtility::GetFieldMapNode	(	const PHFieldConfig *	default_config = `nullptr`,
		PHCompositeNode *	topNode = `nullptr`,
		const int	verbosity = `0`
	)

static

Get transient PHField from DST nodes. If not found, make a new one based on default_config.

Get transient PHField from DST nodes. If not found, make a new one based on default_config

Parameters

[in]	default_config	default configuraiton if not on DST. If nullptr, use DefaultFieldConfig() as the default
[in]	topNode	you know who....

Definition at line 102 of file PHFieldUtility.cc.

View newest version in sPHENIX GitHub at line 102 of file PHFieldUtility.cc

References assert, BuildFieldMap(), ckf::field, PHNodeIterator::findFirst(), GetDSTFieldMapNodeName(), GetFieldConfigNode(), Fun4AllServer::instance(), PHWHERE, and Fun4AllServer::topNode().

Referenced by PHG4Reco::InitField(), TpcPrototypeUnpacker::InitField(), FieldMapReadBack::InitRun(), PHGenFitTrackProjection::InitRun(), TpcPrototypeGenFitTrkFinder::InitRun(), SVReco::InitRun(), GenFitTrackProp::InitRun(), PHRaveVertexing::InitRun(), BDiJetModule::InitRun(), PHG4TrackFastSim::InitRun(), TpcPrototypeGenFitTrkFitter::InitRun(), PHGenFitTrkFitter::InitRun(), TrackProjectorPid::TrackProjectorPid(), and TrackProjectorPlaneECAL::TrackProjectorPlaneECAL().

Here is the call graph for this function:

Here is the caller graph for this function:

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

coresoftware/blob/master/offline/packages/PHField/PHFieldUtility.h
coresoftware/blob/master/offline/packages/PHField/PHFieldUtility.cc

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation