LocalAsymmetryFeatureTool class. More...

#include <LocalAsymmetryFeatureTool.h>

Inheritance diagram for lar_content::LocalAsymmetryFeatureTool:

Public Member Functions
	LocalAsymmetryFeatureTool ()
	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 &slidingFitDataList, const VertexSelectionBaseAlgorithm::ShowerClusterList &) const override
	Get the local asymmetry feature in a given view. More...

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

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

unsigned int	m_maxAsymmetryNClusters
	The max number of associated clusters to calculate the asymmetry. 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

LocalAsymmetryFeatureTool class.

Definition at line 19 of file LocalAsymmetryFeatureTool.h.

Constructor & Destructor Documentation

lar_content::LocalAsymmetryFeatureTool::LocalAsymmetryFeatureTool ( )

Default constructor.

Definition at line 20 of file LocalAsymmetryFeatureTool.cc.

                                                      :
     AsymmetryFeatureBaseTool(),
     m_minAsymmetryCosAngle(0.9962),
     m_maxAsymmetryNClusters(2)
 {
 }

Member Function Documentation

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.

 {
     if (!(weightedDirectionSum.GetMagnitudeSquared() > std::numeric_limits<float>::epsilon()))
         return true;
 
     const float cosOpeningAngle(weightedDirectionSum.GetCosOpeningAngle(clusterDirection));
     return std::fabs(cosOpeningAngle) > m_minAsymmetryCosAngle;
 }

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.

 {
     bool useEnergy(true), useAsymmetry(true);
     CartesianVector energyWeightedDirectionSum(0.f, 0.f, 0.f), hitWeightedDirectionSum(0.f, 0.f, 0.f);
     ClusterVector asymmetryClusters;
 
     for (const VertexSelectionBaseAlgorithm::SlidingFitData &slidingFitData : slidingFitDataList)
     {
         const Cluster *const pCluster(slidingFitData.GetCluster());
 
         if (pCluster->GetElectromagneticEnergy() < std::numeric_limits<float>::epsilon())
             useEnergy = false;
 
         const CartesianVector vertexToMinLayer(slidingFitData.GetMinLayerPosition() - vertexPosition2D);
         const CartesianVector vertexToMaxLayer(slidingFitData.GetMaxLayerPosition() - vertexPosition2D);
 
         const bool minLayerClosest(vertexToMinLayer.GetMagnitudeSquared() < vertexToMaxLayer.GetMagnitudeSquared());
         const CartesianVector &clusterDirection((minLayerClosest) ? slidingFitData.GetMinLayerDirection() : slidingFitData.GetMaxLayerDirection());
 
         if (useAsymmetry && (LArClusterHelper::GetClosestDistance(vertexPosition2D, pCluster) < m_maxAsymmetryDistance))
         {
             useAsymmetry &= this->CheckAngle(energyWeightedDirectionSum, clusterDirection);
             this->IncrementAsymmetryParameters(pCluster->GetElectromagneticEnergy(), clusterDirection, energyWeightedDirectionSum);
 
             useAsymmetry &= this->CheckAngle(hitWeightedDirectionSum, clusterDirection);
             this->IncrementAsymmetryParameters(static_cast<float>(pCluster->GetNCaloHits()), clusterDirection, hitWeightedDirectionSum);
 
             asymmetryClusters.push_back(pCluster);
         }
 
         if (!useAsymmetry)
             return 1.f;
     }
 
     // Default: maximum asymmetry (i.e. not suppressed), zero for energy kick (i.e. not suppressed)
     if ((useEnergy && energyWeightedDirectionSum == CartesianVector(0.f, 0.f, 0.f)) ||
         (!useEnergy && hitWeightedDirectionSum == CartesianVector(0.f, 0.f, 0.f)))
         return 1.f;
 
     if (asymmetryClusters.empty() || (asymmetryClusters.size() > m_maxAsymmetryNClusters))
         return 1.f;
 
     const CartesianVector &localWeightedDirectionSum(useEnergy ? energyWeightedDirectionSum : hitWeightedDirectionSum);
     return this->CalculateAsymmetry(useEnergy, vertexPosition2D, asymmetryClusters, localWeightedDirectionSum);
 }

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

overrideprivate

Definition at line 89 of file LocalAsymmetryFeatureTool.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinAsymmetryCosAngle", m_minAsymmetryCosAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxAsymmetryNClusters", m_maxAsymmetryNClusters));
 
     return AsymmetryFeatureBaseTool::ReadSettings(xmlHandle);
 }