ThreeDChargeFeatureTool class for the calculation of charge-related features. More...

#include "TrackShowerIdFeatureTool.h"

Inheritance diagram for lar_content::ThreeDChargeFeatureTool:

[legend]

Collaboration diagram for lar_content::ThreeDChargeFeatureTool:

[legend]

Classes
class	VertexComparator
	VertexComparator class for comparison of two points wrt neutrino vertex position. More...

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

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

Public Member Functions
	ThreeDChargeFeatureTool ()
	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
void	CalculateChargeVariables (const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster, float &totalCharge, float &chargeSigma, float &chargeMean, float &endCharge)
	Calculation of the charge variables.

void	OrderCaloHitsByDistanceToVertex (const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster, pandora::CaloHitList &caloHitList)
	Function to order the calo hit list by distance to neutrino vertex.

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

Private Attributes
float	m_endChargeFraction
	Fraction of hits that will be considered to calculate end charge (default 10%)

Detailed Description

ThreeDChargeFeatureTool class for the calculation of charge-related features.

Definition at line 338 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

◆ ThreeDChargeFeatureTool()

lar_content::ThreeDChargeFeatureTool::ThreeDChargeFeatureTool ( )

Default constructor.

Definition at line 1057 of file TrackShowerIdFeatureTool.cc.

Member Function Documentation

◆ CalculateChargeVariables()

void lar_content::ThreeDChargeFeatureTool::CalculateChargeVariables	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster,
		float &	totalCharge,
		float &	chargeSigma,
		float &	chargeMean,
		float &	endCharge
	)

private

Calculation of the charge variables.

Parameters

pAlgorithm,the	algorithm
pCluster	the cluster we are characterizing
totalCharge,to	receive the total charge
chargeSigma,to	receive the charge sigma
chargeMean,to	receive the charge mean
startCharge,to	receive the charge in the initial 10% hits
endCharge,to	receive the charge in the last 10% hits

Definition at line 1112 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

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:

◆ OrderCaloHitsByDistanceToVertex()

void lar_content::ThreeDChargeFeatureTool::OrderCaloHitsByDistanceToVertex	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster,
		pandora::CaloHitList &	caloHitList
	)

private

Function to order the calo hit list by distance to neutrino vertex.

Parameters

pAlgorithm,the	algorithm
pCluster	the cluster we are characterizing
caloHitList	to receive the ordered calo hit list

Definition at line 1155 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 1191 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::ThreeDChargeFeatureTool::Run	(	LArMvaHelper::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pInputPfo
	)

Definition at line 1090 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

◆ Run() [2/4]

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

Definition at line 1063 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_endChargeFraction

float lar_content::ThreeDChargeFeatureTool::m_endChargeFraction

private

Fraction of hits that will be considered to calculate end charge (default 10%)

Definition at line 401 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_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

Classes

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

◆ ThreeDChargeFeatureTool()

Member Function Documentation

◆ CalculateChargeVariables()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ OrderCaloHitsByDistanceToVertex()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run() [1/4]

◆ Run() [2/4]

◆ Run() [3/4]

◆ Run() [4/4]

Member Data Documentation

◆ m_endChargeFraction

◆ m_instanceName

◆ m_pPandora

◆ m_type