ShowerAsymmetryFeatureTool class. More...

#include <ShowerAsymmetryFeatureTool.h>

Inheritance diagram for lar_content::ShowerAsymmetryFeatureTool:

Public Member Functions
	ShowerAsymmetryFeatureTool ()
	Default constructor. More...

Public Member Functions inherited from lar_content::AsymmetryFeatureBaseTool
	AsymmetryFeatureBaseTool ()
	Default constructor. More...

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. More...

Public Member Functions inherited from lar_content::MvaFeatureTool< Ts >
	MvaFeatureTool ()=default
	Default constructor. More...

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

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle) override

float	GetAsymmetryForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::SlidingFitDataList &, const VertexSelectionBaseAlgorithm::ShowerClusterList &showerClusterList) const override
	Get the shower asymmetry feature for a given view. More...

bool	ShouldUseShowerCluster (const pandora::CartesianVector &vertexPosition, const VertexSelectionBaseAlgorithm::ShowerCluster &showerCluster) const
	Get whether we should use a given shower cluster for asymmetry calculation. More...

Private Attributes
float	m_vertexClusterDistance
	The distance around the vertex to look for shower clusters. More...

Additional Inherited Members
Public Types inherited from lar_content::MvaFeatureTool< Ts >
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector

Protected Member Functions inherited from lar_content::AsymmetryFeatureBaseTool
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	IncrementAsymmetryParameters (const float weight, const pandora::CartesianVector &clusterDirection, pandora::CartesianVector &localWeightedDirectionSum) const
	Increment the asymmetry parameters. More...

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

Protected Attributes inherited from lar_content::AsymmetryFeatureBaseTool
float	m_maxAsymmetryDistance
	The max distance between cluster (any hit) and vertex to calculate asymmetry score. More...

Detailed Description

ShowerAsymmetryFeatureTool class.

Definition at line 21 of file ShowerAsymmetryFeatureTool.h.

Constructor & Destructor Documentation

lar_content::ShowerAsymmetryFeatureTool::ShowerAsymmetryFeatureTool ( )

Default constructor.

Definition at line 19 of file ShowerAsymmetryFeatureTool.cc.

                                                        : AsymmetryFeatureBaseTool(), m_vertexClusterDistance(4.f)
 {
 }

Member Function Documentation

float lar_content::ShowerAsymmetryFeatureTool::GetAsymmetryForView	(	const pandora::CartesianVector &	vertexPosition2D,
		const VertexSelectionBaseAlgorithm::SlidingFitDataList &	,
		const VertexSelectionBaseAlgorithm::ShowerClusterList &	showerClusterList
	)		const

overrideprivatevirtual

Get the shower asymmetry feature for a given view.

Parameters

vertexPosition2D	the projected vertex position
showerClusterList	the list of shower clusters in this view

Returns: the shower asymmetry feature

Implements lar_content::AsymmetryFeatureBaseTool.

Definition at line 25 of file ShowerAsymmetryFeatureTool.cc.

 {
     float showerAsymmetry(1.f);
 
     for (const VertexSelectionBaseAlgorithm::ShowerCluster &showerCluster : showerClusterList)
     {
         if (this->ShouldUseShowerCluster(vertexPosition2D, showerCluster))
         {
             const TwoDSlidingFitResult &showerFit = showerCluster.GetFit();
 
             float rL(0.f), rT(0.f);
             showerFit.GetLocalPosition(vertexPosition2D, rL, rT);
 
             CartesianVector showerDirection(0.f, 0.f, 0.f);
             if (STATUS_CODE_SUCCESS != showerFit.GetGlobalFitDirection(rL, showerDirection))
                 continue;
 
             ClusterVector asymmetryClusters;
             std::copy(showerCluster.GetClusters().begin(), showerCluster.GetClusters().end(), std::back_inserter(asymmetryClusters));
 
             showerAsymmetry = this->CalculateAsymmetry(true, vertexPosition2D, asymmetryClusters, showerDirection);
 
             break;
         }
     }
 
     return showerAsymmetry;
 }

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

overrideprivate

Definition at line 72 of file ShowerAsymmetryFeatureTool.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexClusterDistance", m_vertexClusterDistance));
 
     return AsymmetryFeatureBaseTool::ReadSettings(xmlHandle);
 }

bool lar_content::ShowerAsymmetryFeatureTool::ShouldUseShowerCluster	(	const pandora::CartesianVector &	vertexPosition,
		const VertexSelectionBaseAlgorithm::ShowerCluster &	showerCluster
	)		const

private

Get whether we should use a given shower cluster for asymmetry calculation.

Parameters

vertexPosition	the projected vertex position
showerCluster	the shower cluster

Returns: whether the shower cluster should be considered

Definition at line 57 of file ShowerAsymmetryFeatureTool.cc.

 {
     for (const Cluster *const pCluster : showerCluster.GetClusters())
     {
         if (LArClusterHelper::GetClosestDistance(vertexPosition, pCluster) < m_vertexClusterDistance)
             return true;
     }
 
     return false;
 }

Member Data Documentation

float lar_content::ShowerAsymmetryFeatureTool::m_vertexClusterDistance

private

The distance around the vertex to look for shower clusters.

Definition at line 53 of file ShowerAsymmetryFeatureTool.h.

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

larpandoracontent/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.h
larpandoracontent/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation