EnergyKickVertexSelectionAlgorithm class. More...

#include <EnergyKickVertexSelectionAlgorithm.h>

Inheritance diagram for lar_content::EnergyKickVertexSelectionAlgorithm:

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

Public Member Functions inherited from lar_content::VertexSelectionBaseAlgorithm
	VertexSelectionBaseAlgorithm ()
	Default constructor. More...

Private Member Functions
void	GetVertexScoreList (const pandora::VertexVector &vertexVector, const BeamConstants &beamConstants, HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW, VertexScoreList &vertexScoreList) const
	Get the vertex score list for a provided list of candidate vertices. More...

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

Private Attributes
VertexFeatureTool::FeatureToolVector	m_featureToolVector
	The feature tool map. More...

pandora::StringVector	m_inputClusterListNames
	The list of cluster list names. More...

unsigned int	m_minClusterCaloHits
	The min number of hits parameter in the energy score. More...

unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...

float	m_epsilon
	The epsilon parameter in the energy score. More...

float	m_asymmetryConstant
	The asymmetry constant parameter in the energy score. More...

Additional Inherited Members
Public Types inherited from lar_content::VertexSelectionBaseAlgorithm
typedef std::vector< VertexScore >	VertexScoreList

typedef std::vector < SlidingFitData >	SlidingFitDataList

typedef std::vector < ShowerCluster >	ShowerClusterList

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

typedef KDTreeLinkerAlgo < const pandora::CaloHit *, 2 >	HitKDTree2D

typedef std::map < pandora::HitType, const pandora::ClusterList & >	ClusterListMap
	Map array of cluster lists for passing to tools. More...

typedef std::map < pandora::HitType, const SlidingFitDataList >	SlidingFitDataListMap
	Map of sliding fit data lists for passing to tools. More...

typedef std::map < pandora::HitType, const ShowerClusterList >	ShowerClusterListMap
	Map of shower cluster lists for passing to tools. More...

typedef std::map < pandora::HitType, const std::reference_wrapper < HitKDTree2D > >	KDTreeMap
	Map array of hit kd trees for passing to tools. More...

typedef MvaFeatureTool< const VertexSelectionBaseAlgorithm const, const pandora::Vertex const, const SlidingFitDataListMap &, const ClusterListMap &, const KDTreeMap &, const ShowerClusterListMap &, const float, float & >	VertexFeatureTool
	The base type for the vertex feature tools. More...

Protected Member Functions inherited from lar_content::VertexSelectionBaseAlgorithm
virtual void	FilterVertexList (const pandora::VertexList *const pInputVertexList, HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW, pandora::VertexVector &filteredVertices) const
	Filter the input list of vertices to obtain a reduced number of vertex candidates. More...

virtual void	GetBeamConstants (const pandora::VertexVector &vertexVector, BeamConstants &beamConstants) const
	Get the beam score constants for a provided list of candidate vertices. More...

void	GetClusterLists (const pandora::StringVector &inputClusterListNames, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the cluster lists. More...

void	CalculateClusterSlidingFits (const pandora::ClusterList &inputClusterList, const unsigned int minClusterCaloHits, const unsigned int slidingFitWindow, SlidingFitDataList &slidingFitDataList) const
	Calculate the cluster sliding fits. More...

float	GetBeamDeweightingScore (const BeamConstants &beamConstants, const pandora::Vertex *const pVertex) const
	Get the beam deweighting score for a vertex. More...

bool	IsBeamModeOn () const
	Whether algorithm is running in beam mode, assuming neutrinos travel in positive z-direction. More...

float	GetVertexEnergy (const pandora::Vertex *const pVertex, const KDTreeMap &kdTreeMap) const
	Calculate the energy of a vertex candidate by summing values from all three planes. More...

float	VertexHitEnergy (const pandora::Vertex *const pVertex, const pandora::HitType hitType, HitKDTree2D &kdTree) const
	Finds the energy of the nearest hit to the vertex candidate in this view. More...

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

Detailed Description

EnergyKickVertexSelectionAlgorithm class.

Definition at line 19 of file EnergyKickVertexSelectionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::EnergyKickVertexSelectionAlgorithm::EnergyKickVertexSelectionAlgorithm ( )

Default constructor.

Definition at line 22 of file EnergyKickVertexSelectionAlgorithm.cc.

                                                                        :
     m_minClusterCaloHits(12),
     m_slidingFitWindow(100),
     m_epsilon(0.06),
     m_asymmetryConstant(3.f)
 {
 }

Member Function Documentation

void lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList	(	const pandora::VertexVector &	vertexVector,
		const BeamConstants &	beamConstants,
		HitKDTree2D &	kdTreeU,
		HitKDTree2D &	kdTreeV,
		HitKDTree2D &	kdTreeW,
		VertexScoreList &	vertexScoreList
	)		const

privatevirtual

Get the vertex score list for a provided list of candidate vertices.

Parameters

vertexVector	the vertex vector
beamConstants	the beam constants
kdTreeU	the kd tree for u hits
kdTreeV	the kd tree for v hits
kdTreeW	the kd tree for w hits
vertexScoreList	to receive the vertex score list

Implements lar_content::VertexSelectionBaseAlgorithm.

Definition at line 32 of file EnergyKickVertexSelectionAlgorithm.cc.

 {
     ClusterList clustersU, clustersV, clustersW;
     this->GetClusterLists(m_inputClusterListNames, clustersU, clustersV, clustersW);
 
     SlidingFitDataList slidingFitDataListU, slidingFitDataListV, slidingFitDataListW;
     this->CalculateClusterSlidingFits(clustersU, m_minClusterCaloHits, m_slidingFitWindow, slidingFitDataListU);
     this->CalculateClusterSlidingFits(clustersV, m_minClusterCaloHits, m_slidingFitWindow, slidingFitDataListV);
     this->CalculateClusterSlidingFits(clustersW, m_minClusterCaloHits, m_slidingFitWindow, slidingFitDataListW);
 
     // Create maps from hit types to objects for passing to feature tools
     const SlidingFitDataListMap slidingFitDataListMap{
         {TPC_VIEW_U, slidingFitDataListU}, {TPC_VIEW_V, slidingFitDataListV}, {TPC_VIEW_W, slidingFitDataListW}};
 
     float bestFastScore(0.f); // not actually used - artefact of toolizing RPhi score and still using performance trick
     for (const Vertex *const pVertex : vertexVector)
     {
         const float beamDeweightingScore(this->IsBeamModeOn() ? this->GetBeamDeweightingScore(beamConstants, pVertex) : 0.f);
 
         const float energyKick(LArMvaHelper::CalculateFeaturesOfType<EnergyKickFeatureTool>(m_featureToolVector, this, pVertex,
             slidingFitDataListMap, ClusterListMap(), KDTreeMap(), ShowerClusterListMap(), beamDeweightingScore, bestFastScore)
                                    .at(0)
                                    .Get());
 
         const float energyAsymmetry(LArMvaHelper::CalculateFeaturesOfType<LocalAsymmetryFeatureTool>(m_featureToolVector, this, pVertex,
             slidingFitDataListMap, ClusterListMap(), KDTreeMap(), ShowerClusterListMap(), beamDeweightingScore, bestFastScore)
                                         .at(0)
                                         .Get());
 
         const float energyKickScore(-energyKick / m_epsilon);
         const float energyAsymmetryScore(energyAsymmetry / m_asymmetryConstant);
 
         vertexScoreList.push_back(VertexScore(pVertex, beamDeweightingScore + energyKickScore + energyAsymmetryScore));
     }
 }

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

private

Definition at line 72 of file EnergyKickVertexSelectionAlgorithm.cc.

 {
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "FeatureTools", algorithmToolVector));
 
     for (AlgorithmTool *const pAlgorithmTool : algorithmToolVector)
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, LArMvaHelper::AddFeatureToolToVector(pAlgorithmTool, m_featureToolVector));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputClusterListNames", m_inputClusterListNames));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterCaloHits", m_minClusterCaloHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Epsilon", m_epsilon));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "AsymmetryConstant", m_asymmetryConstant));
 
     if ((m_epsilon < std::numeric_limits<float>::epsilon()) || (m_asymmetryConstant < std::numeric_limits<float>::epsilon()))
     {
         std::cout << "EnergyKickVertexSelection: Invalid parameter(s), Epsilon " << m_epsilon << ", AsymmetryConstant "
                   << m_asymmetryConstant << std::endl;
         return STATUS_CODE_INVALID_PARAMETER;
     }
 
     return VertexSelectionBaseAlgorithm::ReadSettings(xmlHandle);
 }