EnergyDepositionAsymmetryFeatureTool class. More...

#include <EnergyDepositionAsymmetryFeatureTool.h>

Inheritance diagram for lar_content::EnergyDepositionAsymmetryFeatureTool:

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

Public Member Functions inherited from lar_content::GlobalAsymmetryFeatureTool
	GlobalAsymmetryFeatureTool ()
	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	CalculateAsymmetry (const bool useEnergyMetrics, const pandora::CartesianVector &vertexPosition2D, const pandora::ClusterVector &clusterVector, const pandora::CartesianVector &localWeightedDirectionSum) const override
	Calculate the energy deposition asymmetry feature. 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::GlobalAsymmetryFeatureTool
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle) override

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

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

EnergyDepositionAsymmetryFeatureTool class.

Definition at line 19 of file EnergyDepositionAsymmetryFeatureTool.h.

Constructor & Destructor Documentation

lar_content::EnergyDepositionAsymmetryFeatureTool::EnergyDepositionAsymmetryFeatureTool ( )

Default constructor.

Definition at line 19 of file EnergyDepositionAsymmetryFeatureTool.cc.

                                                                            : GlobalAsymmetryFeatureTool()
 {
 }

Member Function Documentation

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

overrideprivatevirtual

Calculate the energy deposition asymmetry feature.

Parameters

useEnergyMetrics	whether to use energy-based metrics instead of hit-counting-based metrics
vertexPosition2D	the vertex position in this view
slidingFitDataList	the list of sliding fit data objects
localWeightedDirectionSum	the local event axis

Returns: the energy deposition asymmetry feature

Reimplemented from lar_content::AsymmetryFeatureBaseTool.

Definition at line 25 of file EnergyDepositionAsymmetryFeatureTool.cc.

 {
     // Project every hit onto local event axis direction and record side of the projected vtx position on which it falls
     float beforeVtxEnergy(0.f), afterVtxEnergy(0.f);
     unsigned int beforeVtxHits(0), afterVtxHits(0);
 
     const CartesianVector localWeightedDirection(localWeightedDirectionSum.GetUnitVector());
     const float evtProjectedVtxPos(vertexPosition2D.GetDotProduct(localWeightedDirection));
 
     float minBeforeProjectedPos(std::numeric_limits<float>::max());
     float maxBeforeProjectedPos(-std::numeric_limits<float>::max());
 
     float minAfterProjectedPos(std::numeric_limits<float>::max());
     float maxAfterProjectedPos(-std::numeric_limits<float>::max());
 
     for (const Cluster *const pCluster : clusterVector)
     {
         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)
             {
                 minBeforeProjectedPos = std::min(minBeforeProjectedPos, pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection));
                 maxBeforeProjectedPos = std::max(maxBeforeProjectedPos, pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection));
 
                 beforeVtxEnergy += pCaloHit->GetElectromagneticEnergy();
                 ++beforeVtxHits;
             }
 
             else
             {
                 minAfterProjectedPos = std::min(minAfterProjectedPos, pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection));
                 maxAfterProjectedPos = std::max(maxAfterProjectedPos, pCaloHit->GetPositionVector().GetDotProduct(localWeightedDirection));
 
                 afterVtxEnergy += pCaloHit->GetElectromagneticEnergy();
                 ++afterVtxHits;
             }
         }
     }
 
     // Use energy metrics if possible, otherwise fall back on hit counting.
     const unsigned int totalHits(beforeVtxHits + afterVtxHits);
 
     const float beforeLength(std::fabs(maxBeforeProjectedPos - minBeforeProjectedPos));
     const float afterLength(std::fabs(maxAfterProjectedPos - minAfterProjectedPos));
 
     const float beforeVtxEnergyDeposition(beforeLength < std::numeric_limits<float>::epsilon() ? 0 : beforeVtxEnergy / beforeLength);
 
     const float afterVtxEnergyDeposition(afterLength < std::numeric_limits<float>::epsilon() ? 0 : afterVtxEnergy / afterLength);
 
     const float totalEnergyDeposition(beforeVtxEnergyDeposition + afterVtxEnergyDeposition);
 
     if (useEnergyMetrics && totalEnergyDeposition > std::numeric_limits<float>::epsilon())
         return std::fabs((afterVtxEnergyDeposition - beforeVtxEnergyDeposition)) / totalEnergyDeposition;
 
     if (0 == totalHits)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     const float beforeVtxHitDeposition(beforeLength < std::numeric_limits<float>::epsilon() ? 0 : beforeVtxHits / beforeLength);
 
     const float afterVtxHitDeposition(afterLength < std::numeric_limits<float>::epsilon() ? 0 : afterVtxHits / afterLength);
 
     const float totalHitDeposition(beforeVtxHitDeposition + afterVtxHitDeposition);
 
     if (totalHitDeposition > std::numeric_limits<float>::epsilon())
         return std::fabs((afterVtxHitDeposition - beforeVtxHitDeposition)) / totalHitDeposition;
 
     return 0.f;
 }

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

overrideprivate

Definition at line 103 of file EnergyDepositionAsymmetryFeatureTool.cc.

 {
     return GlobalAsymmetryFeatureTool::ReadSettings(xmlHandle);
 }

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

larpandoracontent/larpandoracontent/LArVertex/EnergyDepositionAsymmetryFeatureTool.h
larpandoracontent/larpandoracontent/LArVertex/EnergyDepositionAsymmetryFeatureTool.cc

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation