ShowerAsymmetryFeatureTool class. More...

#include "ShowerAsymmetryFeatureTool.h"

Inheritance diagram for lar_content::ShowerAsymmetryFeatureTool:

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

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

void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const VertexSelectionBaseAlgorithm const pAlgorithm, const pandora::Vertex const pVertex, const VertexSelectionBaseAlgorithm::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...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

float	GetShowerAsymmetryForView (const pandora::CartesianVector &vertexPosition2D, const VertexSelectionBaseAlgorithm::ShowerClusterList &showerClusterList) const
	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...

void	CalculateAsymmetryParameters (const VertexSelectionBaseAlgorithm::ShowerCluster &showerCluster, const float projectedVtxPosition, const pandora::CartesianVector &showerDirection, float &beforeVtxEnergy, float &afterVtxEnergy) const
	Calculate the parameters for the 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::vector<MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolVector

inherited

Definition at line 30 of file LArMvaHelper.h.

Constructor & Destructor Documentation

lar_content::ShowerAsymmetryFeatureTool::ShowerAsymmetryFeatureTool ( )

Default constructor.

Definition at line 19 of file ShowerAsymmetryFeatureTool.cc.

                                                        :
     m_vertexClusterDistance(4.f)
 {
 }

Member Function Documentation

void lar_content::ShowerAsymmetryFeatureTool::CalculateAsymmetryParameters	(	const VertexSelectionBaseAlgorithm::ShowerCluster &	showerCluster,
		const float	projectedVtxPosition,
		const pandora::CartesianVector &	showerDirection,
		float &	beforeVtxEnergy,
		float &	afterVtxEnergy
	)		const

private

Calculate the parameters for the asymmetry calculation.

Parameters

showerCluster	the shower cluster
projectedVtxPosition	the projected vertex position
showerDirection	the direction of the shower axis
beforeVtxEnergy	the shower energy before the vertex position
afterVtxEnergy	the shower energy after the vertex position

Definition at line 97 of file ShowerAsymmetryFeatureTool.cc.

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

Referenced by GetShowerAsymmetryForView().

 {
     beforeVtxEnergy = 0.f;
     afterVtxEnergy = 0.f;
 
     for (const Cluster * const pCluster : showerCluster.GetClusters())
     {
         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(showerDirection) < projectedVtxPosition)
                 beforeVtxEnergy += pCaloHit->GetElectromagneticEnergy();
 
             else if (pCaloHit->GetPositionVector().GetDotProduct(showerDirection) > projectedVtxPosition)
                 afterVtxEnergy += pCaloHit->GetElectromagneticEnergy();
         }
     }
 }

float lar_content::ShowerAsymmetryFeatureTool::GetShowerAsymmetryForView	(	const pandora::CartesianVector &	vertexPosition2D,
		const VertexSelectionBaseAlgorithm::ShowerClusterList &	showerClusterList
	)		const

private

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

Definition at line 49 of file ShowerAsymmetryFeatureTool.cc.

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

Referenced by Run().

 {
     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);
             showerFit.GetGlobalFitDirection(rL, showerDirection);
 
             const float projectedVtxPosition = vertexPosition2D.GetDotProduct(showerDirection);
 
             float beforeVtxEnergy(0.f), afterVtxEnergy(0.f);
             this->CalculateAsymmetryParameters(showerCluster, projectedVtxPosition, showerDirection, beforeVtxEnergy, afterVtxEnergy);
 
             if (beforeVtxEnergy + afterVtxEnergy > 0.f)
                 showerAsymmetry = std::fabs(afterVtxEnergy - beforeVtxEnergy) / (afterVtxEnergy + beforeVtxEnergy);
 
             break;
         }
     }
 
     return showerAsymmetry;
 }

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

private

Definition at line 125 of file ShowerAsymmetryFeatureTool.cc.

References m_vertexClusterDistance.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "VertexClusterDistance", m_vertexClusterDistance));
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::ShowerAsymmetryFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const VertexSelectionBaseAlgorithm *const	pAlgorithm,
		const pandora::Vertex *const	pVertex,
		const VertexSelectionBaseAlgorithm::SlidingFitDataListMap &	,
		const VertexSelectionBaseAlgorithm::ClusterListMap &	,
		const VertexSelectionBaseAlgorithm::KDTreeMap &	,
		const VertexSelectionBaseAlgorithm::ShowerClusterListMap &	showerClusterListMap,
		const float	,
		float &
	)

Run the tool.

Parameters

pAlgorithm	address of the calling algorithm
pVertex	address of the vertex
showerClusterListMap	map of the shower cluster lists

Returns: the shower asymmetry feature

Definition at line 26 of file ShowerAsymmetryFeatureTool.cc.

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

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

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

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

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

Referenced by GetShowerAsymmetryForView().

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

Member Data Documentation

float lar_content::ShowerAsymmetryFeatureTool::m_vertexClusterDistance

private

The distance around the vertex to look for shower clusters.

Definition at line 78 of file ShowerAsymmetryFeatureTool.h.

Referenced by ReadSettings(), and ShouldUseShowerCluster().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArVertex/ShowerAsymmetryFeatureTool.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