#include "EnergyKickFeatureTool.h"

Inheritance diagram for lar_content::EnergyKickFeatureTool:

[legend]

Collaboration diagram for lar_content::EnergyKickFeatureTool:

[legend]

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

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

Public Member Functions
	EnergyKickFeatureTool ()
	Default constructor.

void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const VertexSelectionBaseAlgorithm const pAlgorithm, const pandora::Vertex const pVertex, const VertexSelectionBaseAlgorithm::SlidingFitDataListMap &slidingFitDataListMap, const VertexSelectionBaseAlgorithm::ClusterListMap &, const VertexSelectionBaseAlgorithm::KDTreeMap &, const VertexSelectionBaseAlgorithm::ShowerClusterListMap &, const float, float &)
	Run the tool.

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.

float	GetEnergyKickForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &slidingFitDataList) const
	Get the energy kick feature for a given view.

void	IncrementEnergyKickParameters (const pandora::Cluster *const pCluster, const pandora::CartesianVector &clusterDisplacement, const pandora::CartesianVector &clusterDirection, float &totEnergyKick, float &totEnergy, float &totHitKick, unsigned int &totHits) const
	Increment the energy kick parameters for a given cluster.

Private Attributes
float	m_rOffset
	The r offset parameter in the energy score.

float	m_xOffset
	The x offset parameter in the energy score.

Detailed Description

EnergyKickFeatureTool class.

Definition at line 19 of file EnergyKickFeatureTool.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

◆ EnergyKickFeatureTool()

lar_content::EnergyKickFeatureTool::EnergyKickFeatureTool ( )

Default constructor.

Definition at line 20 of file EnergyKickFeatureTool.cc.

Member Function Documentation

◆ GetEnergyKickForView()

float lar_content::EnergyKickFeatureTool::GetEnergyKickForView	(	const pandora::CartesianVector &	vertexPosition2D,
		const VertexSelectionBaseAlgorithm::SlidingFitDataList &	slidingFitDataList
	)		const

private

Get the energy kick feature for a given view.

Parameters

vertexPosition2D	the projection of the vertex position in this view
slidingFitDataList	the list of sliding fit data objects in this view

Returns: the energy kick feature

Definition at line 50 of file EnergyKickFeatureTool.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.

◆ IncrementEnergyKickParameters()

void lar_content::EnergyKickFeatureTool::IncrementEnergyKickParameters	(	const pandora::Cluster *const	pCluster,
		const pandora::CartesianVector &	clusterDisplacement,
		const pandora::CartesianVector &	clusterDirection,
		float &	totEnergyKick,
		float &	totEnergy,
		float &	totHitKick,
		unsigned int &	totHits
	)		const

private

Increment the energy kick parameters for a given cluster.

Parameters

pCluster	address of the cluster
clusterDisplacement	the cluster displacement
clusterDirection	the cluster direction
totEnergyKick	the total energy kick
totEnergy	the total energy
totHitKick	the total hit kick
totHits	the total number of hits

Definition at line 86 of file EnergyKickFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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::EnergyKickFeatureTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 101 of file EnergyKickFeatureTool.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/3]

void lar_content::EnergyKickFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const VertexSelectionBaseAlgorithm *const	pAlgorithm,
		const pandora::Vertex *const	pVertex,
		const VertexSelectionBaseAlgorithm::SlidingFitDataListMap &	slidingFitDataListMap,
		const VertexSelectionBaseAlgorithm::ClusterListMap &	,
		const VertexSelectionBaseAlgorithm::KDTreeMap &	,
		const VertexSelectionBaseAlgorithm::ShowerClusterListMap &	,
		const float	,
		float &
	)

Run the tool.

Parameters

pAlgorithm	address of the calling algorithm
pVertex	address of the vertex
slidingFitDataListMap	map of the sliding fit data lists

Returns: the energy kick feature

Definition at line 26 of file EnergyKickFeatureTool.cc.

Here is the call graph for this function:

◆ Run() [2/3]

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() [3/3]

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_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_rOffset

float lar_content::EnergyKickFeatureTool::m_rOffset

private

The r offset parameter in the energy score.

Definition at line 68 of file EnergyKickFeatureTool.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_xOffset

float lar_content::EnergyKickFeatureTool::m_xOffset

private

The x offset parameter in the energy score.

Definition at line 69 of file EnergyKickFeatureTool.h.

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

LArContent/larpandoracontent/LArVertex/EnergyKickFeatureTool.h
LArContent/larpandoracontent/LArVertex/EnergyKickFeatureTool.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

◆ EnergyKickFeatureTool()

Member Function Documentation

◆ GetEnergyKickForView()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ IncrementEnergyKickParameters()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run() [1/3]

◆ Run() [2/3]

◆ Run() [3/3]

Member Data Documentation

◆ m_instanceName

◆ m_pPandora

◆ m_rOffset

◆ m_type

◆ m_xOffset