ShowerAsymmetryFeatureTool class. More...

#include "ShowerAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::ShowerAsymmetryFeatureTool:

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

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

Public Member Functions
	ShowerAsymmetryFeatureTool ()
	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 &, 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...

Detailed Description

ShowerAsymmetryFeatureTool class.

Definition at line 21 of file ShowerAsymmetryFeatureTool.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::ShowerAsymmetryFeatureTool::ShowerAsymmetryFeatureTool ( )

Default constructor.

Definition at line 19 of file ShowerAsymmetryFeatureTool.cc.

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

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 lar_content::LocalAsymmetryFeatureTool::GetAsymmetryForView(), lar_content::GlobalAsymmetryFeatureTool::GetAsymmetryForView(), and 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);
 }

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 27 of file ShowerAsymmetryFeatureTool.cc.

References lar_content::AsymmetryFeatureBaseTool::CalculateAsymmetry(), f, lar_content::TwoDSlidingFitResult::GetGlobalFitDirection(), lar_content::TwoDSlidingFitResult::GetLocalPosition(), and ShouldUseShowerCluster().

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

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 lar_content::LocalAsymmetryFeatureTool::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::ShowerAsymmetryFeatureTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

overrideprivate

Definition at line 74 of file ShowerAsymmetryFeatureTool.cc.

References m_vertexClusterDistance, and lar_content::AsymmetryFeatureBaseTool::ReadSettings().

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

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 59 of file ShowerAsymmetryFeatureTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), lar_content::VertexSelectionBaseAlgorithm::ShowerCluster::GetClusters(), and m_vertexClusterDistance.

Referenced by GetAsymmetryForView().

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

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 lar_content::LocalAsymmetryFeatureTool::GetAsymmetryForView(), lar_content::GlobalAsymmetryFeatureTool::GetAsymmetryForView(), and lar_content::AsymmetryFeatureBaseTool::ReadSettings().

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.

Referenced by ReadSettings(), and ShouldUseShowerCluster().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.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