ConeChargeFeatureTool class for the calculation of charge distribution and conicalness. More...

#include "TrackShowerIdFeatureTool.h"

Inheritance diagram for lar_content::ConeChargeFeatureTool:

[legend]

Collaboration diagram for lar_content::ConeChargeFeatureTool:

[legend]

Public Types
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector

typedef std::map< std::string, MvaFeatureTool< Ts... > * >	FeatureToolMap

Public Member Functions
	ConeChargeFeatureTool ()
	Default constructor.

void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const pandora::Algorithm const pAlgorithm, const pandora::ParticleFlowObject const pInputPfo)

void	Run (LArMvaHelper::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, const pandora::Algorithm const pAlgorithm, const pandora::ParticleFlowObject const pInputPfo)

virtual void	Run (MvaTypes::MvaFeatureVector &featureVector, Ts... args)=0
	Run the algorithm tool.

virtual void	Run (MvaTypes::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, Ts...)

const std::string &	GetType () const
	Get the type.

const std::string &	GetInstanceName () const
	Get the instance name.

const Pandora &	GetPandora () const
	Get the associated pandora instance.

Protected Member Functions
virtual StatusCode	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.

virtual StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

StatusCode	RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
	Register i) the pandora instance that will run the process and ii) the process type.

Protected Attributes
const Pandora *	m_pPandora
	The pandora object that will run the process.

std::string	m_type
	The process type.

std::string	m_instanceName
	The process instance name.

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

void	CalculateChargeDistribution (const pandora::CaloHitList &caloHitList, const pandora::CartesianVector &pfoStart, const pandora::CartesianVector &pfoDir, float &chargeCore, float &chargeHalo, float &chargeCon)
	Calculate charge distribution in relation to the Moeliere radius.

float	CalculateConicalness (const pandora::CaloHitList &caloHitList, const pandora::CartesianVector &pfoStart, const pandora::CartesianVector &pfoDir, const float pfoLength)
	Calculate conicalness as a ratio of charge distribution at the end and start of pfo.

Private Attributes
unsigned int	m_conMinHits
	Configurable parameters to calculate cone charge variables.

float	m_minCharge

float	m_conFracRange

float	m_MoliereRadius

float	m_MoliereRadiusFrac

Detailed Description

ConeChargeFeatureTool class for the calculation of charge distribution and conicalness.

Definition at line 210 of file TrackShowerIdFeatureTool.h.

Member Typedef Documentation

◆ FeatureToolMap

template<typename... Ts>

typedef std::map<std::string, MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolMap

inherited

Definition at line 37 of file LArMvaHelper.h.

◆ FeatureToolVector

template<typename... Ts>

typedef std::vector<MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolVector

inherited

Definition at line 36 of file LArMvaHelper.h.

Constructor & Destructor Documentation

◆ ConeChargeFeatureTool()

lar_content::ConeChargeFeatureTool::ConeChargeFeatureTool ( )

Default constructor.

Definition at line 397 of file TrackShowerIdFeatureTool.cc.

Member Function Documentation

◆ CalculateChargeDistribution()

void lar_content::ConeChargeFeatureTool::CalculateChargeDistribution	(	const pandora::CaloHitList &	caloHitList,
		const pandora::CartesianVector &	pfoStart,
		const pandora::CartesianVector &	pfoDir,
		float &	chargeCore,
		float &	chargeHalo,
		float &	chargeCon
	)

private

Calculate charge distribution in relation to the Moeliere radius.

Parameters

caloHitList	the calo hit list of plane w
pfoStart	start position of the pfo
pfoDir	direction of pfo from the principle vector of pca
chargeCore	to receive sum of charge within Moeliete radius * fraction
chargeHalo	to receive sum of charge outside of Moeliere radius * fraction
chargeCon	to receive weighted sum of total charge

Definition at line 472 of file TrackShowerIdFeatureTool.cc.

Here is the caller graph for this function:

◆ CalculateConicalness()

float lar_content::ConeChargeFeatureTool::CalculateConicalness	(	const pandora::CaloHitList &	caloHitList,
		const pandora::CartesianVector &	pfoStart,
		const pandora::CartesianVector &	pfoDir,
		const float	pfoLength
	)

private

Calculate conicalness as a ratio of charge distribution at the end and start of pfo.

Parameters

caloHitList	the calo hit list of plane w
pfoStart	start position of the pfo
pfoDir	direction of pfo from the principle vector of pca
pfoLength	length of the whole pfo return conicalness

Definition at line 490 of file TrackShowerIdFeatureTool.cc.

Here is the caller graph for this function:

◆ GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const

inlineinherited

Get the instance name.

Returns: The instance name

Definition at line 109 of file Process.h.

◆ GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const

inlineinherited

Get the associated pandora instance.

Returns: the associated pandora instance

Definition at line 116 of file Process.h.

◆ GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ Initialize()

StatusCode pandora::Process::Initialize ( )

inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

◆ ReadSettings()

StatusCode lar_content::ConeChargeFeatureTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 527 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

◆ RegisterDetails()

StatusCode pandora::Process::RegisterDetails	(	const Pandora *const	pPandora,
		const std::string &	type,
		const std::string &	instanceName
	)

inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode pandora::Process::Reset ( )

inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

◆ Run() [1/4]

void lar_content::ConeChargeFeatureTool::Run	(	LArMvaHelper::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pInputPfo
	)

Definition at line 447 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

◆ Run() [2/4]

void lar_content::ConeChargeFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pInputPfo
	)

Definition at line 408 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run() [3/4]

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run	(	MvaTypes::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		Ts...
	)

inlinevirtualinherited

Definition at line 51 of file LArMvaHelper.h.

◆ Run() [4/4]

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run	(	MvaTypes::MvaFeatureVector &	featureVector,
		Ts...	args
	)

pure virtualinherited

Run the algorithm tool.

Parameters

featureVector	the vector of features to append
args	arguments to pass to the tool

Member Data Documentation

◆ m_conFracRange

float lar_content::ConeChargeFeatureTool::m_conFracRange

private

Definition at line 236 of file TrackShowerIdFeatureTool.h.

◆ m_conMinHits

unsigned int lar_content::ConeChargeFeatureTool::m_conMinHits

private

Configurable parameters to calculate cone charge variables.

Parameters

conMinHits	minimum hit requirement at start and end of pfo to calculate conicalness
minCharge	minimum charge requirement at start and end of pfo to calculate conicalness
conFracRange	conincal fractional range to determine start/end of pfo
MoliereRadius	10.1 cm to determine halo/core of pfo
MoliereRadiusFrac	fraction of Moliere radius, default = 0.2

Definition at line 234 of file TrackShowerIdFeatureTool.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minCharge

float lar_content::ConeChargeFeatureTool::m_minCharge

private

Definition at line 235 of file TrackShowerIdFeatureTool.h.

◆ m_MoliereRadius

float lar_content::ConeChargeFeatureTool::m_MoliereRadius

private

Definition at line 237 of file TrackShowerIdFeatureTool.h.

◆ m_MoliereRadiusFrac

float lar_content::ConeChargeFeatureTool::m_MoliereRadiusFrac

private

Definition at line 238 of file TrackShowerIdFeatureTool.h.

◆ m_pPandora

const Pandora* pandora::Process::m_pPandora

protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

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

LArContent/larpandoracontent/LArTrackShowerId/TrackShowerIdFeatureTool.h
LArContent/larpandoracontent/LArTrackShowerId/TrackShowerIdFeatureTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FeatureToolMap

◆ FeatureToolVector

Constructor & Destructor Documentation

◆ ConeChargeFeatureTool()

Member Function Documentation

◆ CalculateChargeDistribution()

◆ CalculateConicalness()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run() [1/4]

◆ Run() [2/4]

◆ Run() [3/4]

◆ Run() [4/4]

Member Data Documentation

◆ m_conFracRange

◆ m_conMinHits

◆ m_instanceName

◆ m_minCharge

◆ m_MoliereRadius

◆ m_MoliereRadiusFrac

◆ m_pPandora

◆ m_type