VertexSelectionBaseAlgorithm class. More...

#include "VertexSelectionBaseAlgorithm.h"

Inheritance diagram for lar_content::VertexSelectionBaseAlgorithm:

Classes
class	BeamConstants
	Beam constants class. More...

class	ShowerCluster
	Shower cluster class. More...

class	SlidingFitData
	Sliding fit data class. More...

class	VertexScore
	VertexScore class. More...

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

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

Protected Member Functions
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...

virtual void	GetVertexScoreList (const pandora::VertexVector &vertexVector, const BeamConstants &beamConstants, HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW, VertexScoreList &vertexScoreList) const =0
	Get the vertex score list 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)

Private Member Functions
pandora::StatusCode	Run ()

void	InitializeKDTrees (HitKDTree2D &kdTreeU, HitKDTree2D &kdTreeV, HitKDTree2D &kdTreeW) const
	Initialize kd trees with details of hits in algorithm-configured cluster lists. More...

bool	IsVertexOnHit (const pandora::Vertex *const pVertex, const pandora::HitType hitType, HitKDTree2D &kdTree) const
	Whether the vertex lies on a hit in the specified view. More...

bool	IsVertexInGap (const pandora::Vertex *const pVertex, const pandora::HitType hitType) const
	Whether the vertex lies in a registered gap. More...

void	SelectTopScoreVertices (VertexScoreList &vertexScoreList, pandora::VertexList &selectedVertexList) const
	From the top-scoring candidate vertices, select a subset for further investigation. More...

bool	AcceptVertexLocation (const pandora::Vertex *const pVertex, const pandora::VertexList &selectedVertexList) const
	Whether to accept a candidate vertex, based on its spatial position in relation to other selected candidates. More...

Static Private Member Functions
static bool	SortByVertexZPosition (const pandora::Vertex const pLhs, const pandora::Vertex const pRhs)
	Sort vertices by increasing z position. More...

Private Attributes
pandora::StringVector	m_inputCaloHitListNames
	The list of calo hit list names. More...

std::string	m_outputVertexListName
	The name under which to save the output vertex list. More...

bool	m_replaceCurrentVertexList
	Whether to replace the current vertex list with the output list. More...

bool	m_beamMode
	Whether to run in beam mode, assuming neutrinos travel in positive z-direction. More...

float	m_nDecayLengthsInZSpan
	The number of score decay lengths to use over the course of the vertex z-span. More...

bool	m_selectSingleVertex
	Whether to make a final decision and select just one vertex candidate. More...

unsigned int	m_maxTopScoreSelections
	Max number of top-scoring vertex candidate to select for output. More...

float	m_maxOnHitDisplacement
	Max hit-vertex displacement for declaring vertex to lie on a hit in each view. More...

float	m_minCandidateDisplacement
	Ignore other top-scoring candidates located in close proximity to original. More...

float	m_minCandidateScoreFraction
	Ignore other top-scoring candidates with score less than a fraction of original. More...

bool	m_useDetectorGaps
	Whether to account for registered detector gaps in vertex selection. More...

float	m_gapTolerance
	The tolerance to use when querying whether a sampling point is in a gap, units cm. More...

bool	m_isEmptyViewAcceptable
	Whether views entirely empty of hits are classed as 'acceptable' for candidate filtration. More...

unsigned int	m_minVertexAcceptableViews
	The minimum number of views in which a candidate must sit on/near a hit or in a gap (or view can be empty) More...

Detailed Description

VertexSelectionBaseAlgorithm class.

Definition at line 32 of file VertexSelectionBaseAlgorithm.h.

Member Typedef Documentation

typedef std::map<pandora::HitType, const pandora::ClusterList &> lar_content::VertexSelectionBaseAlgorithm::ClusterListMap

Map array of cluster lists for passing to tools.

Definition at line 227 of file VertexSelectionBaseAlgorithm.h.

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

Definition at line 223 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<HitKDNode2D> lar_content::VertexSelectionBaseAlgorithm::HitKDNode2DList

Definition at line 224 of file VertexSelectionBaseAlgorithm.h.

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

Definition at line 225 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const std::reference_wrapper<HitKDTree2D> > lar_content::VertexSelectionBaseAlgorithm::KDTreeMap

Map array of hit kd trees for passing to tools.

Definition at line 230 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<ShowerCluster> lar_content::VertexSelectionBaseAlgorithm::ShowerClusterList

Definition at line 221 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const ShowerClusterList> lar_content::VertexSelectionBaseAlgorithm::ShowerClusterListMap

Map of shower cluster lists for passing to tools.

Definition at line 229 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<SlidingFitData> lar_content::VertexSelectionBaseAlgorithm::SlidingFitDataList

Definition at line 175 of file VertexSelectionBaseAlgorithm.h.

typedef std::map<pandora::HitType, const SlidingFitDataList> lar_content::VertexSelectionBaseAlgorithm::SlidingFitDataListMap

Map of sliding fit data lists for passing to tools.

Definition at line 228 of file VertexSelectionBaseAlgorithm.h.

typedef MvaFeatureTool<const VertexSelectionBaseAlgorithm *const, const pandora::Vertex *const, const SlidingFitDataListMap &, const ClusterListMap &, const KDTreeMap &, const ShowerClusterListMap &, const float, float &> lar_content::VertexSelectionBaseAlgorithm::VertexFeatureTool

The base type for the vertex feature tools.

Definition at line 234 of file VertexSelectionBaseAlgorithm.h.

typedef std::vector<VertexScore> lar_content::VertexSelectionBaseAlgorithm::VertexScoreList

Definition at line 82 of file VertexSelectionBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::VertexSelectionBaseAlgorithm::VertexSelectionBaseAlgorithm ( )

Default constructor.

Definition at line 22 of file VertexSelectionBaseAlgorithm.cc.

                                                            :
     m_replaceCurrentVertexList(true),
     m_beamMode(true),
     m_nDecayLengthsInZSpan(2.f),
     m_selectSingleVertex(true),
     m_maxTopScoreSelections(3),
     m_maxOnHitDisplacement(1.f),
     m_minCandidateDisplacement(2.f),
     m_minCandidateScoreFraction(0.5f),
     m_useDetectorGaps(true),
     m_gapTolerance(0.f),
     m_isEmptyViewAcceptable(true),
     m_minVertexAcceptableViews(3)
 {
 }

Member Function Documentation

bool lar_content::VertexSelectionBaseAlgorithm::AcceptVertexLocation	(	const pandora::Vertex *const	pVertex,
		const pandora::VertexList &	selectedVertexList
	)		const

private

Whether to accept a candidate vertex, based on its spatial position in relation to other selected candidates.

Parameters

pVertex	the address of the vertex
selectedVertexList	the selected vertex list

Returns: boolean

Definition at line 314 of file VertexSelectionBaseAlgorithm.cc.

References m_minCandidateDisplacement.

Referenced by SelectTopScoreVertices().

 {
     const CartesianVector &position(pVertex->GetPosition());
     const float minCandidateDisplacementSquared(m_minCandidateDisplacement * m_minCandidateDisplacement);
 
     for (const Vertex *const pSelectedVertex : selectedVertexList)
     {
         if (pVertex == pSelectedVertex)
             return false;
 
         if ((position - pSelectedVertex->GetPosition()).GetMagnitudeSquared() < minCandidateDisplacementSquared)
             return false;
     }
 
     return true;
 }

void lar_content::VertexSelectionBaseAlgorithm::CalculateClusterSlidingFits	(	const pandora::ClusterList &	inputClusterList,
		const unsigned int	minClusterCaloHits,
		const unsigned int	slidingFitWindow,
		SlidingFitDataList &	slidingFitDataList
	)		const

protected

Calculate the cluster sliding fits.

Parameters

inputClusterList	the input cluster list
minClusterCaloHits	the minimum number of cluster calo hits
slidingFitWindow	the sliding fit window
slidingFitDataList	the list of sliding fits to fill

Definition at line 120 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::LArGeometryHelper::GetWireZPitch(), and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::MvaVertexSelectionAlgorithm< T >::GetVertexScoreList().

 {
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
 
     ClusterVector sortedClusters(inputClusterList.begin(), inputClusterList.end());
     std::sort(sortedClusters.begin(), sortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster : sortedClusters)
     {
         if (pCluster->GetNCaloHits() < minClusterCaloHits)
             continue;
 
         // Make sure the window size is such that there are not more layers than hits (following TwoDSlidingLinearFit calculation).
         const unsigned int newSlidingFitWindow(
             std::min(static_cast<int>(pCluster->GetNCaloHits()), static_cast<int>(slidingFitPitch * slidingFitWindow)));
         slidingFitDataList.emplace_back(pCluster, newSlidingFitWindow, slidingFitPitch);
     }
 }

void lar_content::VertexSelectionBaseAlgorithm::FilterVertexList	(	const pandora::VertexList *const	pInputVertexList,
		HitKDTree2D &	kdTreeU,
		HitKDTree2D &	kdTreeV,
		HitKDTree2D &	kdTreeW,
		pandora::VertexVector &	filteredVertices
	)		const

protectedvirtual

Filter the input list of vertices to obtain a reduced number of vertex candidates.

Parameters

pInputVertexList	the address of the input vertex list
kdTreeU	the kd tree for u hits
kdTreeV	the kd tree for v hits
kdTreeW	the kd tree for w hits
filteredVertices	to receive the filtered vertex list

Definition at line 40 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::KDTreeLinkerAlgo< DATA, DIM >::empty(), IsVertexInGap(), IsVertexOnHit(), m_isEmptyViewAcceptable, m_minVertexAcceptableViews, and SortByVertexZPosition().

Referenced by Run().

 {
     for (const Vertex *const pVertex : *pInputVertexList)
     {
         unsigned int nAcceptableViews(0);
 
         if ((m_isEmptyViewAcceptable && kdTreeU.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_U, kdTreeU) || this->IsVertexInGap(pVertex, TPC_VIEW_U))
             ++nAcceptableViews;
 
         if ((m_isEmptyViewAcceptable && kdTreeV.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_V, kdTreeV) || this->IsVertexInGap(pVertex, TPC_VIEW_V))
             ++nAcceptableViews;
 
         if ((m_isEmptyViewAcceptable && kdTreeW.empty()) || this->IsVertexOnHit(pVertex, TPC_VIEW_W, kdTreeW) || this->IsVertexInGap(pVertex, TPC_VIEW_W))
             ++nAcceptableViews;
 
         if (nAcceptableViews >= m_minVertexAcceptableViews)
             filteredVertices.push_back(pVertex);
     }
 
     std::sort(filteredVertices.begin(), filteredVertices.end(), SortByVertexZPosition);
 }

void lar_content::VertexSelectionBaseAlgorithm::GetBeamConstants	(	const pandora::VertexVector &	vertexVector,
		BeamConstants &	beamConstants
	)		const

protectedvirtual

Get the beam score constants for a provided list of candidate vertices.

Parameters

vertexVector	the vertex vector
beamConstants	to receive the beam constants

Definition at line 65 of file VertexSelectionBaseAlgorithm.cc.

References f, m_beamMode, m_nDecayLengthsInZSpan, and lar_content::VertexSelectionBaseAlgorithm::BeamConstants::SetConstants().

Referenced by Run().

 {
     if (!m_beamMode)
         return;
 
     if (vertexVector.empty())
         throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
 
     float minZCoordinate(std::numeric_limits<float>::max()), maxZCoordinate(-std::numeric_limits<float>::max());
 
     for (const Vertex *const pVertex : vertexVector)
     {
         if (pVertex->GetPosition().GetZ() < minZCoordinate)
             minZCoordinate = pVertex->GetPosition().GetZ();
 
         if (pVertex->GetPosition().GetZ() > maxZCoordinate)
             maxZCoordinate = pVertex->GetPosition().GetZ();
     }
 
     const float zSpan(maxZCoordinate - minZCoordinate);
     const float decayConstant((zSpan < std::numeric_limits<float>::epsilon()) ? 0.f : (m_nDecayLengthsInZSpan / zSpan));
     beamConstants.SetConstants(minZCoordinate, decayConstant);
 }

float lar_content::VertexSelectionBaseAlgorithm::GetBeamDeweightingScore	(	const BeamConstants &	beamConstants,
		const pandora::Vertex *const	pVertex
	)		const

inlineprotected

Get the beam deweighting score for a vertex.

Parameters

beamConstants	the beam constants
pVertex	address of the vertex

Returns: the score

Definition at line 419 of file VertexSelectionBaseAlgorithm.h.

References lar_content::VertexSelectionBaseAlgorithm::BeamConstants::GetDecayConstant(), and lar_content::VertexSelectionBaseAlgorithm::BeamConstants::GetMinZCoordinate().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

 {
     const float vertexMinZ(std::max(pVertex->GetPosition().GetZ(), beamConstants.GetMinZCoordinate()));
     return (beamConstants.GetMinZCoordinate() - vertexMinZ) * beamConstants.GetDecayConstant();
 }

void lar_content::VertexSelectionBaseAlgorithm::GetClusterLists	(	const pandora::StringVector &	inputClusterListNames,
		pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protected

Get the cluster lists.

Parameters

inputClusterListNames	the input cluster list names
clusterListU	the U-view cluster list to populate
clusterListV	the V-view cluster list to populate
clusterListW	the W-view cluster list to populate

Definition at line 91 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType().

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::MvaVertexSelectionAlgorithm< T >::GetVertexScoreList().

 {
     for (const std::string &clusterListName : inputClusterListNames)
     {
         const ClusterList *pClusterList(NULL);
         PANDORA_THROW_RESULT_IF_AND_IF(
             STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, clusterListName, pClusterList));
 
         if (!pClusterList || pClusterList->empty())
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "EnergyKickVertexSelectionAlgorithm: unable to find cluster list " << clusterListName << std::endl;
 
             continue;
         }
 
         const HitType hitType(LArClusterHelper::GetClusterHitType(*(pClusterList->begin())));
 
         if ((TPC_VIEW_U != hitType) && (TPC_VIEW_V != hitType) && (TPC_VIEW_W != hitType))
             throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
         ClusterList &clusterList((TPC_VIEW_U == hitType) ? clusterListU : (TPC_VIEW_V == hitType) ? clusterListV : clusterListW);
         clusterList.insert(clusterList.end(), pClusterList->begin(), pClusterList->end());
     }
 }

float lar_content::VertexSelectionBaseAlgorithm::GetVertexEnergy	(	const pandora::Vertex *const	pVertex,
		const KDTreeMap &	kdTreeMap
	)		const

protected

Calculate the energy of a vertex candidate by summing values from all three planes.

Parameters

pVertex	the address of the vertex
kdTreeMap	the map of 2D hit kd trees

Returns: the summed vertex energy

Definition at line 243 of file VertexSelectionBaseAlgorithm.cc.

References f, IsVertexInGap(), and VertexHitEnergy().

Referenced by lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

 {
     float totalEnergy(0.f);
 
     if (!this->IsVertexInGap(pVertex, TPC_VIEW_U))
         totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_U, kdTreeMap.at(TPC_VIEW_U));
 
     if (!this->IsVertexInGap(pVertex, TPC_VIEW_V))
         totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_V, kdTreeMap.at(TPC_VIEW_V));
 
     if (!this->IsVertexInGap(pVertex, TPC_VIEW_W))
         totalEnergy += this->VertexHitEnergy(pVertex, TPC_VIEW_W, kdTreeMap.at(TPC_VIEW_W));
 
     return totalEnergy;
 }

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

protectedpure virtual

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

Implemented in lar_content::TrainedVertexSelectionAlgorithm, lar_content::MvaVertexSelectionAlgorithm< T >, lar_content::EnergyKickVertexSelectionAlgorithm, lar_content::HitAngleVertexSelectionAlgorithm, and lar_content::CheatingVertexSelectionAlgorithm.

Referenced by Run().

void lar_content::VertexSelectionBaseAlgorithm::InitializeKDTrees	(	HitKDTree2D &	kdTreeU,
		HitKDTree2D &	kdTreeV,
		HitKDTree2D &	kdTreeW
	)		const

private

Initialize kd trees with details of hits in algorithm-configured cluster lists.

Parameters

kdTreeU	the kd tree for u hits
kdTreeV	the kd tree for v hits
kdTreeW	the kd tree for w hits

Definition at line 186 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::KDTreeLinkerAlgo< DATA, DIM >::build(), lar_content::KDTreeLinkerAlgo< DATA, DIM >::empty(), lar_content::fill_and_bound_2d_kd_tree(), and m_inputCaloHitListNames.

Referenced by Run().

 {
     for (const std::string &caloHitListName : m_inputCaloHitListNames)
     {
         const CaloHitList *pCaloHitList = NULL;
         PANDORA_THROW_RESULT_IF_AND_IF(
             STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, caloHitListName, pCaloHitList));
 
         if (!pCaloHitList || pCaloHitList->empty())
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "VertexSelectionBaseAlgorithm: unable to find calo hit list " << caloHitListName << std::endl;
 
             continue;
         }
 
         const HitType hitType((*(pCaloHitList->begin()))->GetHitType());
 
         if ((TPC_VIEW_U != hitType) && (TPC_VIEW_V != hitType) && (TPC_VIEW_W != hitType))
             throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
         HitKDTree2D &kdTree((TPC_VIEW_U == hitType) ? kdTreeU : (TPC_VIEW_V == hitType) ? kdTreeV : kdTreeW);
 
         if (!kdTree.empty())
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         HitKDNode2DList hitKDNode2DList;
         KDTreeBox hitsBoundingRegion2D(fill_and_bound_2d_kd_tree(*pCaloHitList, hitKDNode2DList));
         kdTree.build(hitKDNode2DList, hitsBoundingRegion2D);
     }
 }

bool lar_content::VertexSelectionBaseAlgorithm::IsBeamModeOn ( ) const

inlineprotected

Whether algorithm is running in beam mode, assuming neutrinos travel in positive z-direction.

Returns: boolean

Definition at line 427 of file VertexSelectionBaseAlgorithm.h.

References m_beamMode.

Referenced by lar_content::TrainedVertexSelectionAlgorithm::AddEventFeaturesToVector(), lar_content::TrainedVertexSelectionAlgorithm::AddVertexFeaturesToVector(), lar_content::EnergyKickVertexSelectionAlgorithm::GetVertexScoreList(), and lar_content::TrainedVertexSelectionAlgorithm::PopulateVertexFeatureInfoMap().

 {
     return m_beamMode;
 }

bool lar_content::VertexSelectionBaseAlgorithm::IsVertexInGap	(	const pandora::Vertex *const	pVertex,
		const pandora::HitType	hitType
	)		const

private

Whether the vertex lies in a registered gap.

Parameters

pVertex	the address of the vertex
hitType	the relevant hit type

Returns: boolean

Definition at line 233 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::LArGeometryHelper::IsInGap3D(), m_gapTolerance, and m_useDetectorGaps.

Referenced by FilterVertexList(), and GetVertexEnergy().

 {
     if (!m_useDetectorGaps)
         return false;
 
     return LArGeometryHelper::IsInGap3D(this->GetPandora(), pVertex->GetPosition(), hitType, m_gapTolerance);
 }

bool lar_content::VertexSelectionBaseAlgorithm::IsVertexOnHit	(	const pandora::Vertex *const	pVertex,
		const pandora::HitType	hitType,
		HitKDTree2D &	kdTree
	)		const

private

Whether the vertex lies on a hit in the specified view.

Parameters

pVertex	the address of the vertex
hitType	the relevant hit type
kdTree	the relevant kd tree

Returns: boolean

Definition at line 220 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::build_2d_kd_search_region(), m_maxOnHitDisplacement, lar_content::LArGeometryHelper::ProjectPosition(), and lar_content::KDTreeLinkerAlgo< DATA, DIM >::search().

Referenced by FilterVertexList().

 {
     const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
     KDTreeBox searchRegionHits = build_2d_kd_search_region(vertexPosition2D, m_maxOnHitDisplacement, m_maxOnHitDisplacement);
 
     HitKDNode2DList found;
     kdTree.search(searchRegionHits, found);
 
     return (!found.empty());
 }

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

protected

Definition at line 393 of file VertexSelectionBaseAlgorithm.cc.

References m_beamMode, m_gapTolerance, m_inputCaloHitListNames, m_isEmptyViewAcceptable, m_maxOnHitDisplacement, m_maxTopScoreSelections, m_minCandidateDisplacement, m_minCandidateScoreFraction, m_minVertexAcceptableViews, m_nDecayLengthsInZSpan, m_outputVertexListName, m_replaceCurrentVertexList, m_selectSingleVertex, and m_useDetectorGaps.

Referenced by lar_content::EnergyKickVertexSelectionAlgorithm::ReadSettings(), and lar_content::TrainedVertexSelectionAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputCaloHitListNames", m_inputCaloHitListNames));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputVertexListName", m_outputVertexListName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "ReplaceCurrentVertexList", m_replaceCurrentVertexList));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "BeamMode", m_beamMode));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NDecayLengthsInZSpan", m_nDecayLengthsInZSpan));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectSingleVertex", m_selectSingleVertex));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxTopScoreSelections", m_maxTopScoreSelections));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxOnHitDisplacement", m_maxOnHitDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinCandidateDisplacement", m_minCandidateDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinCandidateScoreFraction", m_minCandidateScoreFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseDetectorGaps", m_useDetectorGaps));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "GapTolerance", m_gapTolerance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "IsEmptyViewAcceptable", m_isEmptyViewAcceptable));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinVertexAcceptableViews", m_minVertexAcceptableViews));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::VertexSelectionBaseAlgorithm::Run ( )

private

Definition at line 142 of file VertexSelectionBaseAlgorithm.cc.

References FilterVertexList(), GetBeamConstants(), GetVertexScoreList(), InitializeKDTrees(), m_outputVertexListName, m_replaceCurrentVertexList, and SelectTopScoreVertices().

 {
     const VertexList *pInputVertexList(NULL);
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pInputVertexList));
 
     if (!pInputVertexList || pInputVertexList->empty())
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "VertexSelectionBaseAlgorithm: unable to find current vertex list " << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     HitKDTree2D kdTreeU, kdTreeV, kdTreeW;
     this->InitializeKDTrees(kdTreeU, kdTreeV, kdTreeW);
 
     VertexVector filteredVertices;
     this->FilterVertexList(pInputVertexList, kdTreeU, kdTreeV, kdTreeW, filteredVertices);
 
     if (filteredVertices.empty())
         return STATUS_CODE_SUCCESS;
 
     BeamConstants beamConstants;
     this->GetBeamConstants(filteredVertices, beamConstants);
 
     VertexScoreList vertexScoreList;
     this->GetVertexScoreList(filteredVertices, beamConstants, kdTreeU, kdTreeV, kdTreeW, vertexScoreList);
 
     VertexList selectedVertexList;
     this->SelectTopScoreVertices(vertexScoreList, selectedVertexList);
 
     if (!selectedVertexList.empty())
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, m_outputVertexListName, selectedVertexList));
 
         if (m_replaceCurrentVertexList)
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Vertex>(*this, m_outputVertexListName));
     }
 
     return STATUS_CODE_SUCCESS;
 }

void lar_content::VertexSelectionBaseAlgorithm::SelectTopScoreVertices	(	VertexScoreList &	vertexScoreList,
		pandora::VertexList &	selectedVertexList
	)		const

private

From the top-scoring candidate vertices, select a subset for further investigation.

Parameters

vertexScoreList	the vertex score list
selectedVertexList	to receive the selected vertex list

Definition at line 286 of file VertexSelectionBaseAlgorithm.cc.

References AcceptVertexLocation(), f, m_maxTopScoreSelections, m_minCandidateScoreFraction, and m_selectSingleVertex.

Referenced by Run().

 {
     float bestScore(0.f);
     std::sort(vertexScoreList.begin(), vertexScoreList.end());
 
     for (const VertexScore &vertexScore : vertexScoreList)
     {
         if (selectedVertexList.size() >= m_maxTopScoreSelections)
             break;
 
         if (!selectedVertexList.empty() && !this->AcceptVertexLocation(vertexScore.GetVertex(), selectedVertexList))
             continue;
 
         if (!selectedVertexList.empty() && (vertexScore.GetScore() < m_minCandidateScoreFraction * bestScore))
             continue;
 
         selectedVertexList.push_back(vertexScore.GetVertex());
 
         if (m_selectSingleVertex)
             return;
 
         if (vertexScore.GetScore() > bestScore)
             bestScore = vertexScore.GetScore();
     }
 }

bool lar_content::VertexSelectionBaseAlgorithm::SortByVertexZPosition	(	const pandora::Vertex *const	pLhs,
		const pandora::Vertex *const	pRhs
	)

staticprivate

Sort vertices by increasing z position.

Parameters

pLhs	address of the lhs vertex
pRhs	address of the rhs vertex

Returns: whether lhs should precedes rhs

Definition at line 333 of file VertexSelectionBaseAlgorithm.cc.

Referenced by FilterVertexList().

 {
     const CartesianVector deltaPosition(pRhs->GetPosition() - pLhs->GetPosition());
 
     if (std::fabs(deltaPosition.GetZ()) > std::numeric_limits<float>::epsilon())
         return (deltaPosition.GetZ() > std::numeric_limits<float>::epsilon());
 
     if (std::fabs(deltaPosition.GetX()) > std::numeric_limits<float>::epsilon())
         return (deltaPosition.GetX() > std::numeric_limits<float>::epsilon());
 
     // ATTN No way to distinguish between vertices if still have a tie in y coordinate
     return (deltaPosition.GetY() > std::numeric_limits<float>::epsilon());
 }

float lar_content::VertexSelectionBaseAlgorithm::VertexHitEnergy	(	const pandora::Vertex *const	pVertex,
		const pandora::HitType	hitType,
		HitKDTree2D &	kdTree
	)		const

protected

Finds the energy of the nearest hit to the vertex candidate in this view.

Parameters

pVertex	the address of the vertex
hitType	the relevant hit type
kdTree	the kd tree of 2D hits

Returns: the energy of the nearest hit

Definition at line 261 of file VertexSelectionBaseAlgorithm.cc.

References lar_content::build_2d_kd_search_region(), energy, m_maxOnHitDisplacement, lar_content::LArGeometryHelper::ProjectPosition(), and lar_content::KDTreeLinkerAlgo< DATA, DIM >::search().

Referenced by GetVertexEnergy().

 {
     const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
     KDTreeBox searchRegionHits = build_2d_kd_search_region(vertexPosition2D, m_maxOnHitDisplacement, m_maxOnHitDisplacement);
 
     HitKDNode2DList foundHits;
     kdTree.search(searchRegionHits, foundHits);
 
     float dr(std::numeric_limits<float>::max());
     float energy(0);
 
     for (auto hit : foundHits)
     {
         const float diff = (vertexPosition2D - hit.data->GetPositionVector()).GetMagnitude();
         if (diff < dr)
         {
             dr = diff;
             energy = hit.data->GetElectromagneticEnergy();
         }
     }
     return energy;
 }

Member Data Documentation

bool lar_content::VertexSelectionBaseAlgorithm::m_beamMode

private

Whether to run in beam mode, assuming neutrinos travel in positive z-direction.

Definition at line 399 of file VertexSelectionBaseAlgorithm.h.

Referenced by GetBeamConstants(), IsBeamModeOn(), and ReadSettings().

float lar_content::VertexSelectionBaseAlgorithm::m_gapTolerance

private

The tolerance to use when querying whether a sampling point is in a gap, units cm.

Definition at line 411 of file VertexSelectionBaseAlgorithm.h.

Referenced by IsVertexInGap(), and ReadSettings().

pandora::StringVector lar_content::VertexSelectionBaseAlgorithm::m_inputCaloHitListNames

private

The list of calo hit list names.

Definition at line 394 of file VertexSelectionBaseAlgorithm.h.

Referenced by InitializeKDTrees(), and ReadSettings().

bool lar_content::VertexSelectionBaseAlgorithm::m_isEmptyViewAcceptable

private

Whether views entirely empty of hits are classed as 'acceptable' for candidate filtration.

Definition at line 413 of file VertexSelectionBaseAlgorithm.h.

Referenced by FilterVertexList(), and ReadSettings().

float lar_content::VertexSelectionBaseAlgorithm::m_maxOnHitDisplacement

private

Max hit-vertex displacement for declaring vertex to lie on a hit in each view.

Definition at line 405 of file VertexSelectionBaseAlgorithm.h.

Referenced by IsVertexOnHit(), ReadSettings(), and VertexHitEnergy().

unsigned int lar_content::VertexSelectionBaseAlgorithm::m_maxTopScoreSelections

private

Max number of top-scoring vertex candidate to select for output.

Definition at line 403 of file VertexSelectionBaseAlgorithm.h.

Referenced by ReadSettings(), and SelectTopScoreVertices().

float lar_content::VertexSelectionBaseAlgorithm::m_minCandidateDisplacement

private

Ignore other top-scoring candidates located in close proximity to original.

Definition at line 407 of file VertexSelectionBaseAlgorithm.h.

Referenced by AcceptVertexLocation(), and ReadSettings().

float lar_content::VertexSelectionBaseAlgorithm::m_minCandidateScoreFraction

private

Ignore other top-scoring candidates with score less than a fraction of original.

Definition at line 408 of file VertexSelectionBaseAlgorithm.h.

Referenced by ReadSettings(), and SelectTopScoreVertices().

unsigned int lar_content::VertexSelectionBaseAlgorithm::m_minVertexAcceptableViews

private

The minimum number of views in which a candidate must sit on/near a hit or in a gap (or view can be empty)

Definition at line 414 of file VertexSelectionBaseAlgorithm.h.

Referenced by FilterVertexList(), and ReadSettings().

float lar_content::VertexSelectionBaseAlgorithm::m_nDecayLengthsInZSpan

private

The number of score decay lengths to use over the course of the vertex z-span.

Definition at line 400 of file VertexSelectionBaseAlgorithm.h.

Referenced by GetBeamConstants(), and ReadSettings().

std::string lar_content::VertexSelectionBaseAlgorithm::m_outputVertexListName

private

The name under which to save the output vertex list.

Definition at line 395 of file VertexSelectionBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VertexSelectionBaseAlgorithm::m_replaceCurrentVertexList

private

Whether to replace the current vertex list with the output list.

Definition at line 397 of file VertexSelectionBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::VertexSelectionBaseAlgorithm::m_selectSingleVertex

private

Whether to make a final decision and select just one vertex candidate.

Definition at line 402 of file VertexSelectionBaseAlgorithm.h.

Referenced by ReadSettings(), and SelectTopScoreVertices().

bool lar_content::VertexSelectionBaseAlgorithm::m_useDetectorGaps

private

Whether to account for registered detector gaps in vertex selection.

Definition at line 410 of file VertexSelectionBaseAlgorithm.h.

Referenced by IsVertexInGap(), and ReadSettings().

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

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation