LocalAsymmetryFeatureTool class. More...

#include "LocalAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::LocalAsymmetryFeatureTool:

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

Public Member Functions
	LocalAsymmetryFeatureTool ()
	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 &, const float, float &)
	Run the tool. 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)

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

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

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

Private Attributes
float	m_maxAsymmetryDistance
	The max distance between cluster (any hit) and vertex to calculate asymmetry score. More...

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

Detailed Description

LocalAsymmetryFeatureTool class.

Definition at line 19 of file LocalAsymmetryFeatureTool.h.

Member Typedef Documentation

template<typename... Ts>

typedef std::vector<MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolVector

inherited

Definition at line 30 of file LArMvaHelper.h.

Constructor & Destructor Documentation

lar_content::LocalAsymmetryFeatureTool::LocalAsymmetryFeatureTool ( )

Default constructor.

Definition at line 21 of file LocalAsymmetryFeatureTool.cc.

                                                      :
     m_maxAsymmetryDistance(5.f),
     m_minAsymmetryCosAngle(0.9962),
     m_maxAsymmetryNClusters(2)
 {
 }

Member Function Documentation

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

private

Calculate the local asymmetry feature.

Parameters

useEnergyMetrics	whether to use energy-based rather than hit-counting-based metrics
vertexPosition2D	the vertex position
asymmetryClusters	the clusters to use to calculate the asymmetry
localWeightedDirectionSum	the local event axis

Returns: the local asymmetry feature

Definition at line 120 of file LocalAsymmetryFeatureTool.cc.

References f, m_maxAsymmetryNClusters, and lar_content::LArClusterHelper::SortHitsByPosition().

Referenced by GetLocalAsymmetryForView().

 {
     if (asymmetryClusters.empty() || (asymmetryClusters.size() > m_maxAsymmetryNClusters))
         return 1.f;
 
     // Project every hit onto local event axis direction and record side of the projected vtx position on which it falls
     float beforeVtxHitEnergy(0.f), afterVtxHitEnergy(0.f);
     unsigned int beforeVtxHitCount(0), afterVtxHitCount(0);
 
     const CartesianVector localWeightedDirection(localWeightedDirectionSum.GetUnitVector());
     const float evtProjectedVtxPos(vertexPosition2D.GetDotProduct(localWeightedDirection));
 
     for (const Cluster *const pCluster : asymmetryClusters)
     {
         CaloHitList caloHitList;
         pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
         CaloHitVector caloHitVector(caloHitList.begin(), caloHitList.end());
         std::sort(caloHitVector.begin(), caloHitVector.end(), LArClusterHelper::SortHitsByPosition);
 
         for (const CaloHit *const pCaloHit : caloHitVector)
         {
             if (pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection) < evtProjectedVtxPos)
             {
                 beforeVtxHitEnergy += pCaloHit->GetElectromagneticEnergy();
                 ++beforeVtxHitCount;
             }
 
             else
             {
                 afterVtxHitEnergy += pCaloHit->GetElectromagneticEnergy();
                 ++afterVtxHitCount;
             }
         }
     }
 
     // Use energy metrics if possible, otherwise fall back on hit counting.
     const float totHitEnergy(afterVtxHitEnergy + beforeVtxHitEnergy);
     const unsigned int totHitCount(beforeVtxHitCount + afterVtxHitCount);
 
     if (useEnergyMetrics && (totHitEnergy > std::numeric_limits<float>::epsilon()))
         return std::fabs((afterVtxHitEnergy - beforeVtxHitEnergy)) / totHitEnergy;
 
     if (0 == totHitCount)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     return std::fabs((static_cast<float>(afterVtxHitCount) - static_cast<float>(beforeVtxHitCount))) / static_cast<float>(totHitCount);
 }

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

private

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

Definition at line 53 of file LocalAsymmetryFeatureTool.cc.

References CalculateLocalAsymmetry(), f, lar_content::LArClusterHelper::GetClosestDistance(), IncrementAsymmetryParameters(), and m_maxAsymmetryDistance.

Referenced by Run().

 {
     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->IncrementAsymmetryParameters(pCluster->GetElectromagneticEnergy(), clusterDirection, energyWeightedDirectionSum);
             useAsymmetry &= 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;
 
     const CartesianVector &localWeightedDirectionSum(useEnergy ? energyWeightedDirectionSum : hitWeightedDirectionSum);
     return this->CalculateLocalAsymmetry(useEnergy, vertexPosition2D, asymmetryClusters, localWeightedDirectionSum);
 }

bool lar_content::LocalAsymmetryFeatureTool::IncrementAsymmetryParameters	(	const float	weight,
		const pandora::CartesianVector &	clusterDirection,
		pandora::CartesianVector &	localWeightedDirectionSum
	)		const

private

Increment the asymmetry parameters.

Parameters

weight	the weight for the increment
clusterDirection	the cluster direction
localWeightedDirectionSum	the current value of the vector

Returns: whether the energy asymmetry score is still viable

Definition at line 94 of file LocalAsymmetryFeatureTool.cc.

References f, m_minAsymmetryCosAngle, and weight.

Referenced by GetLocalAsymmetryForView().

 {
     // If the new axis direction is at an angle of greater than 90 deg to the current axis direction, flip it 180 degs.
     CartesianVector newDirection(clusterDirection);
 
     if (localWeightedDirectionSum.GetMagnitudeSquared() > std::numeric_limits<float>::epsilon())
     {
         const float cosOpeningAngle(localWeightedDirectionSum.GetCosOpeningAngle(clusterDirection));
 
         if (std::fabs(cosOpeningAngle) > m_minAsymmetryCosAngle)
         {
             if (cosOpeningAngle < 0.f)
                 newDirection *= -1.f;
         }
 
         else
             return false;
     }
 
     localWeightedDirectionSum += newDirection * weight;
     return true;
 }

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

private

Definition at line 172 of file LocalAsymmetryFeatureTool.cc.

References m_maxAsymmetryDistance, m_maxAsymmetryNClusters, and m_minAsymmetryCosAngle.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxAsymmetryDistance", m_maxAsymmetryDistance));
 
     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 STATUS_CODE_SUCCESS;
 }

void lar_content::LocalAsymmetryFeatureTool::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 30 of file LocalAsymmetryFeatureTool.cc.

References f, GetLocalAsymmetryForView(), and lar_content::LArGeometryHelper::ProjectPosition().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     float localAsymmetry(0.f);
 
     localAsymmetry += this->GetLocalAsymmetryForView(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_U),
         slidingFitDataListMap.at(TPC_VIEW_U));
 
     localAsymmetry += this->GetLocalAsymmetryForView(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_V),
         slidingFitDataListMap.at(TPC_VIEW_V));
 
     localAsymmetry += this->GetLocalAsymmetryForView(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), TPC_VIEW_W),
         slidingFitDataListMap.at(TPC_VIEW_W));
 
     featureVector.push_back(localAsymmetry);
 }

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

float lar_content::LocalAsymmetryFeatureTool::m_maxAsymmetryDistance

private

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

Definition at line 78 of file LocalAsymmetryFeatureTool.h.

Referenced by GetLocalAsymmetryForView(), and ReadSettings().

unsigned int lar_content::LocalAsymmetryFeatureTool::m_maxAsymmetryNClusters

private

The max number of associated clusters to calculate the asymmetry.

Definition at line 80 of file LocalAsymmetryFeatureTool.h.

Referenced by CalculateLocalAsymmetry(), and ReadSettings().

float lar_content::LocalAsymmetryFeatureTool::m_minAsymmetryCosAngle

private

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

Definition at line 79 of file LocalAsymmetryFeatureTool.h.

Referenced by IncrementAsymmetryParameters(), and ReadSettings().

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

larpandoracontent/v03_13_02/source/larpandoracontent/LArVertex/LocalAsymmetryFeatureTool.h
larpandoracontent/v03_13_02/source/larpandoracontent/LArVertex/LocalAsymmetryFeatureTool.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation