LocalAsymmetryFeatureTool class. More...

#include "LocalAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::LocalAsymmetryFeatureTool:

[legend]

Collaboration diagram for lar_content::LocalAsymmetryFeatureTool:

[legend]

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

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

Public Member Functions
	LocalAsymmetryFeatureTool ()
	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 &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
void	IncrementAsymmetryParameters (const float weight, const pandora::CartesianVector &clusterDirection, pandora::CartesianVector &localWeightedDirectionSum) const
	Increment the asymmetry parameters.

virtual float	CalculateAsymmetry (const bool useEnergyMetrics, const pandora::CartesianVector &vertexPosition2D, const pandora::ClusterVector &asymmetryClusters, const pandora::CartesianVector &localWeightedDirectionSum) const
	Calculate the asymmetry feature.

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
float	m_maxAsymmetryDistance
	The max distance between cluster (any hit) and vertex to calculate asymmetry score.

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) override
	Read the algorithm settings.

float	GetAsymmetryForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &slidingFitDataList, const VertexSelectionBaseAlgorithm::ShowerClusterList &) const override
	Get the local asymmetry feature in a given view.

bool	CheckAngle (const pandora::CartesianVector &weightedDirectionSum, const pandora::CartesianVector &clusterDirection) const
	Check whether a cluster's direction agrees with the current weighted direction.

Private Attributes
float	m_minAsymmetryCosAngle
	The min opening angle cosine used to determine viability of asymmetry score.

unsigned int	m_maxAsymmetryNClusters
	The max number of associated clusters to calculate the asymmetry.

Detailed Description

LocalAsymmetryFeatureTool class.

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

◆ LocalAsymmetryFeatureTool()

lar_content::LocalAsymmetryFeatureTool::LocalAsymmetryFeatureTool ( )

Default constructor.

Definition at line 20 of file LocalAsymmetryFeatureTool.cc.

Member Function Documentation

◆ CalculateAsymmetry()

float lar_content::AsymmetryFeatureBaseTool::CalculateAsymmetry	(	const bool	useEnergyMetrics,
		const pandora::CartesianVector &	vertexPosition2D,
		const pandora::ClusterVector &	asymmetryClusters,
		const pandora::CartesianVector &	localWeightedDirectionSum
	)		const

protectedvirtualinherited

Calculate the asymmetry feature.

Parameters

useEnergyMetrics	whether to use energy-based metrics instead of hit-counting-based metrics
vertexPosition2D	the vertex position in this view
asymmetryCluster	the vector of cluster objects to be used in the asymmetry calculation
localWeightedDirectionSum	the local event axis

Returns: the asymmetry feature

Reimplemented in lar_content::EnergyDepositionAsymmetryFeatureTool.

Definition at line 69 of file AsymmetryFeatureBaseTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckAngle()

bool lar_content::LocalAsymmetryFeatureTool::CheckAngle	(	const pandora::CartesianVector &	weightedDirectionSum,
		const pandora::CartesianVector &	clusterDirection
	)		const

private

Check whether a cluster's direction agrees with the current weighted direction.

Parameters

weightedDirectionSum	the current weighted direction
clusterDirection	the cluster's direction

Returns: boolean

Definition at line 78 of file LocalAsymmetryFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAsymmetryForView()

float lar_content::LocalAsymmetryFeatureTool::GetAsymmetryForView	(	const pandora::CartesianVector &	vertexPosition2D,
		const VertexSelectionBaseAlgorithm::SlidingFitDataList &	slidingFitDataList,
		const VertexSelectionBaseAlgorithm::ShowerClusterList &
	)		const

overrideprivatevirtual

Get the local asymmetry feature in a given view.

Parameters

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

Returns: the local asymmetry feature

Implements lar_content::AsymmetryFeatureBaseTool.

Definition at line 29 of file LocalAsymmetryFeatureTool.cc.

Here is the call 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.

◆ IncrementAsymmetryParameters()

void lar_content::AsymmetryFeatureBaseTool::IncrementAsymmetryParameters	(	const float	weight,
		const pandora::CartesianVector &	clusterDirection,
		pandora::CartesianVector &	localWeightedDirectionSum
	)		const

protectedinherited

Increment the asymmetry parameters.

Parameters

weight	the weight to assign to this vector
clusterDirection	the direction of the cluster
localWeightedDirectionSum	the current energy-weighted local cluster direction vector

Definition at line 52 of file AsymmetryFeatureBaseTool.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::LocalAsymmetryFeatureTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

overrideprivatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::AsymmetryFeatureBaseTool.

Definition at line 89 of file LocalAsymmetryFeatureTool.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::AsymmetryFeatureBaseTool::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 &	showerClusterListMap,
		const float	,
		float &
	)

inherited

Run the tool.

Parameters

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

Returns: the asymmetry feature

Definition at line 25 of file AsymmetryFeatureBaseTool.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_maxAsymmetryDistance

float lar_content::AsymmetryFeatureBaseTool::m_maxAsymmetryDistance

protectedinherited

The max distance between cluster (any hit) and vertex to calculate asymmetry score.

Definition at line 81 of file AsymmetryFeatureBaseTool.h.

◆ m_maxAsymmetryNClusters

unsigned int lar_content::LocalAsymmetryFeatureTool::m_maxAsymmetryNClusters

private

The max number of associated clusters to calculate the asymmetry.

Definition at line 52 of file LocalAsymmetryFeatureTool.h.

◆ m_minAsymmetryCosAngle

float lar_content::LocalAsymmetryFeatureTool::m_minAsymmetryCosAngle

private

The min opening angle cosine used to determine viability of asymmetry score.

Definition at line 51 of file LocalAsymmetryFeatureTool.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/LArVertex/LocalAsymmetryFeatureTool.h
LArContent/larpandoracontent/LArVertex/LocalAsymmetryFeatureTool.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

◆ LocalAsymmetryFeatureTool()

Member Function Documentation

◆ CalculateAsymmetry()

◆ CheckAngle()

◆ GetAsymmetryForView()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ IncrementAsymmetryParameters()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run() [1/3]

◆ Run() [2/3]

◆ Run() [3/3]

Member Data Documentation

◆ m_instanceName

◆ m_maxAsymmetryDistance

◆ m_maxAsymmetryNClusters

◆ m_minAsymmetryCosAngle

◆ m_pPandora

◆ m_type