Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
pandora::PandoraSettings Class Reference

PandoraSettings class. More...

#include "PandoraSettings.h"

Collaboration diagram for pandora::PandoraSettings:
Collaboration graph
[legend]

Public Member Functions

 PandoraSettings (const Pandora *const pPandora)
 Constructor.
 
 ~PandoraSettings ()
 Destructor.
 
bool IsMonitoringEnabled () const
 Whether monitoring is enabled.
 
bool ShouldDisplayAlgorithmInfo () const
 Whether to display algorithm information during processing.
 
bool SingleHitTypeClusteringMode () const
 Whether to allow only single hit types in individual clusters.
 
bool ShouldCollapseMCParticlesToPfoTarget () const
 Whether to collapse mc particle decay chains down to just the pfo target.
 
bool UseSingleMCParticleAssociation () const
 Whether to allow only single mc particle association to objects (largest weight)
 
float GetElectromagneticEnergyResolution () const
 Get the electromagnetic energy resolution as a fraction, X, such that sigmaE = ( X * E / sqrt(E) )
 
float GetHadronicEnergyResolution () const
 Get the hadronic energy resolution as a fraction, X, such that sigmaE = ( X * E / sqrt(E) )
 
float GetMCPfoSelectionRadius () const
 Get the radius used to select the pfo target from a mc particle decay chain, units mm.
 
float GetMCPfoSelectionMomentum () const
 Get the momentum magnitude used to select the pfo target from a mc particle decay chain, units GeV.
 
float GetMCPfoSelectionLowEnergyNeutronProtonCutOff () const
 Get the low energy cut-off for selection of protons/neutrons as mc pfos.
 
float GetGapTolerance () const
 Get the tolerance allowed when declaring a point to be "in" a gap region, units mm.
 

Private Member Functions

StatusCode Initialize (const TiXmlHandle *const pXmlHandle)
 Initialize pandora settings.
 
StatusCode ReadGlobalSettings (const TiXmlHandle *const pXmlHandle)
 Read global pandora settings.
 

Private Attributes

bool m_isMonitoringEnabled
 Whether monitoring is enabled.
 
bool m_shouldDisplayAlgorithmInfo
 Whether to display algorithm information during processing.
 
bool m_singleHitTypeClusteringMode
 Whether to allow only single hit types in individual clusters.
 
bool m_shouldCollapseMCParticlesToPfoTarget
 Whether to collapse mc particle decay chains down to just the pfo target.
 
bool m_useSingleMCParticleAssociation
 Whether to allow only single mc particle association to objects (largest weight)
 
float m_electromagneticEnergyResolution
 Electromagnetic energy resolution, X, such that sigmaE = ( X * E / sqrt(E) )
 
float m_hadronicEnergyResolution
 Hadronic energy resolution, X, such that sigmaE = ( X * E / sqrt(E) )
 
float m_mcPfoSelectionRadius
 Radius used to select pfo target from a mc decay chain, units mm.
 
float m_mcPfoSelectionMomentum
 Momentum magnitude used to select pfo target from a mc decay chain, units GeV/c.
 
float m_mcPfoSelectionLowEnergyNPCutOff
 Low energy cut-off for selection of protons/neutrons as MCPFOs.
 
float m_gapTolerance
 Tolerance allowed when declaring a point to be "in" a gap region, units mm.
 
const Pandora *const m_pPandora
 The associated pandora object.
 

Friends

class PandoraApiImpl
 
class PandoraImpl
 

Detailed Description

PandoraSettings class.

Definition at line 24 of file PandoraSettings.h.

Constructor & Destructor Documentation

◆ PandoraSettings()

pandora::PandoraSettings::PandoraSettings ( const Pandora *const  pPandora)

Constructor.

Parameters
pPandoraaddress of the associated pandora object

Definition at line 16 of file PandoraSettings.cc.

◆ ~PandoraSettings()

pandora::PandoraSettings::~PandoraSettings ( )

Destructor.

Definition at line 34 of file PandoraSettings.cc.

Member Function Documentation

◆ GetElectromagneticEnergyResolution()

float pandora::PandoraSettings::GetElectromagneticEnergyResolution ( ) const
inline

Get the electromagnetic energy resolution as a fraction, X, such that sigmaE = ( X * E / sqrt(E) )

Returns
The electromagnetic energy resolution

Definition at line 188 of file PandoraSettings.h.

◆ GetGapTolerance()

float pandora::PandoraSettings::GetGapTolerance ( ) const
inline

Get the tolerance allowed when declaring a point to be "in" a gap region, units mm.

Returns
the tolerance allowed when declaring a point to be "in" a gap region, units mm

Definition at line 223 of file PandoraSettings.h.

◆ GetHadronicEnergyResolution()

float pandora::PandoraSettings::GetHadronicEnergyResolution ( ) const
inline

Get the hadronic energy resolution as a fraction, X, such that sigmaE = ( X * E / sqrt(E) )

Returns
The hadronic energy resolution

Definition at line 195 of file PandoraSettings.h.

◆ GetMCPfoSelectionLowEnergyNeutronProtonCutOff()

float pandora::PandoraSettings::GetMCPfoSelectionLowEnergyNeutronProtonCutOff ( ) const
inline

Get the low energy cut-off for selection of protons/neutrons as mc pfos.

Returns
The low energy cut-off for selection of protons/neutrons as mc pfos

Definition at line 216 of file PandoraSettings.h.

Here is the caller graph for this function:

◆ GetMCPfoSelectionMomentum()

float pandora::PandoraSettings::GetMCPfoSelectionMomentum ( ) const
inline

Get the momentum magnitude used to select the pfo target from a mc particle decay chain, units GeV.

Returns
The pfo selection momentum magnitude

Definition at line 209 of file PandoraSettings.h.

Here is the caller graph for this function:

◆ GetMCPfoSelectionRadius()

float pandora::PandoraSettings::GetMCPfoSelectionRadius ( ) const
inline

Get the radius used to select the pfo target from a mc particle decay chain, units mm.

Returns
The pfo selection radius

Definition at line 202 of file PandoraSettings.h.

Here is the caller graph for this function:

◆ Initialize()

StatusCode pandora::PandoraSettings::Initialize ( const TiXmlHandle *const  pXmlHandle)
private

Initialize pandora settings.

Parameters
pXmlHandleaddress of the relevant xml handle

Definition at line 40 of file PandoraSettings.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsMonitoringEnabled()

bool pandora::PandoraSettings::IsMonitoringEnabled ( ) const
inline

Whether monitoring is enabled.

Returns
boolean

Definition at line 153 of file PandoraSettings.h.

◆ ReadGlobalSettings()

StatusCode pandora::PandoraSettings::ReadGlobalSettings ( const TiXmlHandle *const  pXmlHandle)
private

Read global pandora settings.

Parameters
pXmlHandleaddress of the relevant xml handle

Definition at line 57 of file PandoraSettings.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ShouldCollapseMCParticlesToPfoTarget()

bool pandora::PandoraSettings::ShouldCollapseMCParticlesToPfoTarget ( ) const
inline

Whether to collapse mc particle decay chains down to just the pfo target.

Returns
boolean

Definition at line 174 of file PandoraSettings.h.

Here is the caller graph for this function:

◆ ShouldDisplayAlgorithmInfo()

bool pandora::PandoraSettings::ShouldDisplayAlgorithmInfo ( ) const
inline

Whether to display algorithm information during processing.

Returns
boolean

Definition at line 160 of file PandoraSettings.h.

◆ SingleHitTypeClusteringMode()

bool pandora::PandoraSettings::SingleHitTypeClusteringMode ( ) const
inline

Whether to allow only single hit types in individual clusters.

Returns
boolean

Definition at line 167 of file PandoraSettings.h.

Here is the caller graph for this function:

◆ UseSingleMCParticleAssociation()

bool pandora::PandoraSettings::UseSingleMCParticleAssociation ( ) const
inline

Whether to allow only single mc particle association to objects (largest weight)

Returns
boolean

Definition at line 181 of file PandoraSettings.h.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ PandoraApiImpl

friend class PandoraApiImpl
friend

Definition at line 147 of file PandoraSettings.h.

◆ PandoraImpl

friend class PandoraImpl
friend

Definition at line 148 of file PandoraSettings.h.

Member Data Documentation

◆ m_electromagneticEnergyResolution

float pandora::PandoraSettings::m_electromagneticEnergyResolution
private

Electromagnetic energy resolution, X, such that sigmaE = ( X * E / sqrt(E) )

Definition at line 137 of file PandoraSettings.h.

◆ m_gapTolerance

float pandora::PandoraSettings::m_gapTolerance
private

Tolerance allowed when declaring a point to be "in" a gap region, units mm.

Definition at line 143 of file PandoraSettings.h.

◆ m_hadronicEnergyResolution

float pandora::PandoraSettings::m_hadronicEnergyResolution
private

Hadronic energy resolution, X, such that sigmaE = ( X * E / sqrt(E) )

Definition at line 138 of file PandoraSettings.h.

◆ m_isMonitoringEnabled

bool pandora::PandoraSettings::m_isMonitoringEnabled
private

Whether monitoring is enabled.

Definition at line 131 of file PandoraSettings.h.

◆ m_mcPfoSelectionLowEnergyNPCutOff

float pandora::PandoraSettings::m_mcPfoSelectionLowEnergyNPCutOff
private

Low energy cut-off for selection of protons/neutrons as MCPFOs.

Definition at line 141 of file PandoraSettings.h.

◆ m_mcPfoSelectionMomentum

float pandora::PandoraSettings::m_mcPfoSelectionMomentum
private

Momentum magnitude used to select pfo target from a mc decay chain, units GeV/c.

Definition at line 140 of file PandoraSettings.h.

◆ m_mcPfoSelectionRadius

float pandora::PandoraSettings::m_mcPfoSelectionRadius
private

Radius used to select pfo target from a mc decay chain, units mm.

Definition at line 139 of file PandoraSettings.h.

◆ m_pPandora

const Pandora* const pandora::PandoraSettings::m_pPandora
private

The associated pandora object.

Definition at line 145 of file PandoraSettings.h.

◆ m_shouldCollapseMCParticlesToPfoTarget

bool pandora::PandoraSettings::m_shouldCollapseMCParticlesToPfoTarget
private

Whether to collapse mc particle decay chains down to just the pfo target.

Definition at line 134 of file PandoraSettings.h.

◆ m_shouldDisplayAlgorithmInfo

bool pandora::PandoraSettings::m_shouldDisplayAlgorithmInfo
private

Whether to display algorithm information during processing.

Definition at line 132 of file PandoraSettings.h.

◆ m_singleHitTypeClusteringMode

bool pandora::PandoraSettings::m_singleHitTypeClusteringMode
private

Whether to allow only single hit types in individual clusters.

Definition at line 133 of file PandoraSettings.h.

◆ m_useSingleMCParticleAssociation

bool pandora::PandoraSettings::m_useSingleMCParticleAssociation
private

Whether to allow only single mc particle association to objects (largest weight)

Definition at line 135 of file PandoraSettings.h.

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