LocalAsymmetryFeatureTool class. More...

#include "LocalAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::LocalAsymmetryFeatureTool:

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

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

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 &showerClusterListMap, const float, float &)
	Run the tool. More...

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

virtual void	Run (MvaTypes::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, Ts...)

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

Detailed Description

LocalAsymmetryFeatureTool class.

Definition at line 19 of file LocalAsymmetryFeatureTool.h.

Member Typedef Documentation

template<typename... Ts>

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

inherited

Definition at line 37 of file LArMvaHelper.h.

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

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

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 70 of file AsymmetryFeatureBaseTool.cc.

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

Referenced by GetAsymmetryForView(), lar_content::GlobalAsymmetryFeatureTool::GetAsymmetryForView(), and lar_content::ShowerAsymmetryFeatureTool::GetAsymmetryForView().

 {
     // 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(beforeVtxHitEnergy + afterVtxHitEnergy);
     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);
 }

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.

References m_minAsymmetryCosAngle.

Referenced by GetAsymmetryForView().

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

References lar_content::AsymmetryFeatureBaseTool::CalculateAsymmetry(), CheckAngle(), f, lar_content::LArClusterHelper::GetClosestDistance(), lar_content::AsymmetryFeatureBaseTool::IncrementAsymmetryParameters(), lar_content::AsymmetryFeatureBaseTool::m_maxAsymmetryDistance, and m_maxAsymmetryNClusters.

 {
     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);
 }

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 53 of file AsymmetryFeatureBaseTool.cc.

References f, and weight.

Referenced by GetAsymmetryForView(), and lar_content::GlobalAsymmetryFeatureTool::GetAsymmetryForView().

 {
     // 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())
     {
         if (localWeightedDirectionSum.GetCosOpeningAngle(clusterDirection) < 0.f)
             newDirection *= -1.f;
     }
 
     localWeightedDirectionSum += newDirection * weight;
 }

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

overrideprivate

Definition at line 89 of file LocalAsymmetryFeatureTool.cc.

References m_maxAsymmetryNClusters, m_minAsymmetryCosAngle, and lar_content::AsymmetryFeatureBaseTool::ReadSettings().

 {
     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);
 }

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 26 of file AsymmetryFeatureBaseTool.cc.

References f, lar_content::AsymmetryFeatureBaseTool::GetAsymmetryForView(), and lar_content::LArGeometryHelper::ProjectPosition().

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

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

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.

     {
         (void)featureMap;
         (void)featureOrder;
         (void)featureToolName;
         return;
     };

Member Data Documentation

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.

Referenced by GetAsymmetryForView(), lar_content::GlobalAsymmetryFeatureTool::GetAsymmetryForView(), and lar_content::AsymmetryFeatureBaseTool::ReadSettings().

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.

Referenced by GetAsymmetryForView(), and ReadSettings().

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.

Referenced by CheckAngle(), and ReadSettings().

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation