EnergyKickVertexSelectionAlgorithm class. More...

#include "EnergyKickVertexSelectionAlgorithm.h"

Inheritance diagram for lar_content::EnergyKickVertexSelectionAlgorithm:

[legend]

Collaboration diagram for lar_content::EnergyKickVertexSelectionAlgorithm:

[legend]

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.

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

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

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

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.

Public Member Functions
	EnergyKickVertexSelectionAlgorithm ()
	Default constructor.

const std::string &	GetType () const
	Get the type.

const std::string &	GetInstanceName () const
	Get the instance name.

const Pandora &	GetPandora () const
	Get the associated pandora instance.

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.

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

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

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

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

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

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.

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.

virtual StatusCode	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.

virtual StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

StatusCode	RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
	Register i) the pandora instance that will run the process and ii) the process type.

Protected Attributes
const Pandora *	m_pPandora
	The pandora object that will run the process.

std::string	m_type
	The process type.

std::string	m_instanceName
	The process instance name.

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.

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

pandora::StatusCode	Run ()
	Run the algorithm.

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

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.

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

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

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.

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

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

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

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

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

float	m_epsilon
	The epsilon parameter in the energy score.

float	m_asymmetryConstant
	The asymmetry constant parameter in the energy score.

pandora::StringVector	m_inputCaloHitListNames
	The list of calo hit list names.

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

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

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

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

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

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

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

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

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

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

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

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

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)

Detailed Description

EnergyKickVertexSelectionAlgorithm class.

Definition at line 19 of file EnergyKickVertexSelectionAlgorithm.h.

Member Typedef Documentation

◆ ClusterListMap

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

inherited

Map array of cluster lists for passing to tools.

Definition at line 227 of file VertexSelectionBaseAlgorithm.h.

◆ HitKDNode2D

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

inherited

Definition at line 223 of file VertexSelectionBaseAlgorithm.h.

◆ HitKDNode2DList

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

inherited

Definition at line 224 of file VertexSelectionBaseAlgorithm.h.

◆ HitKDTree2D

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

inherited

Definition at line 225 of file VertexSelectionBaseAlgorithm.h.

◆ KDTreeMap

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

inherited

Map array of hit kd trees for passing to tools.

Definition at line 230 of file VertexSelectionBaseAlgorithm.h.

◆ ShowerClusterList

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

inherited

Definition at line 221 of file VertexSelectionBaseAlgorithm.h.

◆ ShowerClusterListMap

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

inherited

Map of shower cluster lists for passing to tools.

Definition at line 229 of file VertexSelectionBaseAlgorithm.h.

◆ SlidingFitDataList

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

inherited

Definition at line 175 of file VertexSelectionBaseAlgorithm.h.

◆ SlidingFitDataListMap

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

inherited

Map of sliding fit data lists for passing to tools.

Definition at line 228 of file VertexSelectionBaseAlgorithm.h.

◆ VertexFeatureTool

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

inherited

The base type for the vertex feature tools.

Definition at line 234 of file VertexSelectionBaseAlgorithm.h.

◆ VertexScoreList

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

inherited

Definition at line 82 of file VertexSelectionBaseAlgorithm.h.

Constructor & Destructor Documentation

◆ EnergyKickVertexSelectionAlgorithm()

lar_content::EnergyKickVertexSelectionAlgorithm::EnergyKickVertexSelectionAlgorithm ( )

Default constructor.

Definition at line 22 of file EnergyKickVertexSelectionAlgorithm.cc.

Member Function Documentation

◆ AcceptVertexLocation()

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

privateinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateClusterSlidingFits()

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

protectedinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FilterVertexList()

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

protectedvirtualinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBeamConstants()

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

protectedvirtualinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBeamDeweightingScore()

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

inlineprotectedinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClusterLists()

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

protectedinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const

inlineinherited

Get the instance name.

Returns: The instance name

Definition at line 109 of file Process.h.

◆ GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const

inlineinherited

Get the associated pandora instance.

Returns: the associated pandora instance

Definition at line 116 of file Process.h.

◆ GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ GetVertexEnergy()

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

protectedinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVertexScoreList()

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.

Here is the call graph for this function:

◆ Initialize()

StatusCode pandora::Process::Initialize ( )

inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

◆ InitializeKDTrees()

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

privateinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsBeamModeOn()

bool lar_content::VertexSelectionBaseAlgorithm::IsBeamModeOn ( ) const

inlineprotectedinherited

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

Returns: boolean

Definition at line 427 of file VertexSelectionBaseAlgorithm.h.

Here is the caller graph for this function:

◆ IsVertexInGap()

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

privateinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsVertexOnHit()

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

privateinherited

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.

Here is the call graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 72 of file EnergyKickVertexSelectionAlgorithm.cc.

Here is the call graph for this function:

◆ RegisterDetails()

StatusCode pandora::Process::RegisterDetails	(	const Pandora *const	pPandora,
		const std::string &	type,
		const std::string &	instanceName
	)

inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode pandora::Process::Reset ( )

inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

◆ Run()

StatusCode lar_content::VertexSelectionBaseAlgorithm::Run ( )

privatevirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 142 of file VertexSelectionBaseAlgorithm.cc.

Here is the call graph for this function:

◆ SelectTopScoreVertices()

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

privateinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SortByVertexZPosition()

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

staticprivateinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VertexHitEnergy()

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

protectedinherited

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.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_asymmetryConstant

float lar_content::EnergyKickVertexSelectionAlgorithm::m_asymmetryConstant

private

The asymmetry constant parameter in the energy score.

Definition at line 39 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_beamMode

bool lar_content::VertexSelectionBaseAlgorithm::m_beamMode

privateinherited

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

Definition at line 399 of file VertexSelectionBaseAlgorithm.h.

◆ m_epsilon

float lar_content::EnergyKickVertexSelectionAlgorithm::m_epsilon

private

The epsilon parameter in the energy score.

Definition at line 38 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_featureToolVector

VertexFeatureTool::FeatureToolVector lar_content::EnergyKickVertexSelectionAlgorithm::m_featureToolVector

private

The feature tool map.

Definition at line 33 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_gapTolerance

float lar_content::VertexSelectionBaseAlgorithm::m_gapTolerance

privateinherited

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

Definition at line 411 of file VertexSelectionBaseAlgorithm.h.

◆ m_inputCaloHitListNames

pandora::StringVector lar_content::VertexSelectionBaseAlgorithm::m_inputCaloHitListNames

privateinherited

The list of calo hit list names.

Definition at line 394 of file VertexSelectionBaseAlgorithm.h.

◆ m_inputClusterListNames

pandora::StringVector lar_content::EnergyKickVertexSelectionAlgorithm::m_inputClusterListNames

private

The list of cluster list names.

Definition at line 35 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_isEmptyViewAcceptable

bool lar_content::VertexSelectionBaseAlgorithm::m_isEmptyViewAcceptable

privateinherited

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

Definition at line 413 of file VertexSelectionBaseAlgorithm.h.

◆ m_maxOnHitDisplacement

float lar_content::VertexSelectionBaseAlgorithm::m_maxOnHitDisplacement

privateinherited

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

Definition at line 405 of file VertexSelectionBaseAlgorithm.h.

◆ m_maxTopScoreSelections

unsigned int lar_content::VertexSelectionBaseAlgorithm::m_maxTopScoreSelections

privateinherited

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

Definition at line 403 of file VertexSelectionBaseAlgorithm.h.

◆ m_minCandidateDisplacement

float lar_content::VertexSelectionBaseAlgorithm::m_minCandidateDisplacement

privateinherited

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

Definition at line 407 of file VertexSelectionBaseAlgorithm.h.

◆ m_minCandidateScoreFraction

float lar_content::VertexSelectionBaseAlgorithm::m_minCandidateScoreFraction

privateinherited

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

Definition at line 408 of file VertexSelectionBaseAlgorithm.h.

◆ m_minClusterCaloHits

unsigned int lar_content::EnergyKickVertexSelectionAlgorithm::m_minClusterCaloHits

private

The min number of hits parameter in the energy score.

Definition at line 36 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_minVertexAcceptableViews

unsigned int lar_content::VertexSelectionBaseAlgorithm::m_minVertexAcceptableViews

privateinherited

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.

◆ m_nDecayLengthsInZSpan

float lar_content::VertexSelectionBaseAlgorithm::m_nDecayLengthsInZSpan

privateinherited

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

Definition at line 400 of file VertexSelectionBaseAlgorithm.h.

◆ m_outputVertexListName

std::string lar_content::VertexSelectionBaseAlgorithm::m_outputVertexListName

privateinherited

The name under which to save the output vertex list.

Definition at line 395 of file VertexSelectionBaseAlgorithm.h.

◆ m_pPandora

const Pandora* pandora::Process::m_pPandora

protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

◆ m_replaceCurrentVertexList

bool lar_content::VertexSelectionBaseAlgorithm::m_replaceCurrentVertexList

privateinherited

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

Definition at line 397 of file VertexSelectionBaseAlgorithm.h.

◆ m_selectSingleVertex

bool lar_content::VertexSelectionBaseAlgorithm::m_selectSingleVertex

privateinherited

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

Definition at line 402 of file VertexSelectionBaseAlgorithm.h.

◆ m_slidingFitWindow

unsigned int lar_content::EnergyKickVertexSelectionAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 37 of file EnergyKickVertexSelectionAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_useDetectorGaps

bool lar_content::VertexSelectionBaseAlgorithm::m_useDetectorGaps

privateinherited

Whether to account for registered detector gaps in vertex selection.

Definition at line 410 of file VertexSelectionBaseAlgorithm.h.

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

LArContent/larpandoracontent/LArVertex/EnergyKickVertexSelectionAlgorithm.h
LArContent/larpandoracontent/LArVertex/EnergyKickVertexSelectionAlgorithm.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterListMap

◆ HitKDNode2D

◆ HitKDNode2DList

◆ HitKDTree2D

◆ KDTreeMap

◆ ShowerClusterList

◆ ShowerClusterListMap

◆ SlidingFitDataList

◆ SlidingFitDataListMap

◆ VertexFeatureTool

◆ VertexScoreList

Constructor & Destructor Documentation

◆ EnergyKickVertexSelectionAlgorithm()

Member Function Documentation

◆ AcceptVertexLocation()

◆ CalculateClusterSlidingFits()

◆ FilterVertexList()

◆ GetBeamConstants()

◆ GetBeamDeweightingScore()

◆ GetClusterLists()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ GetVertexEnergy()

◆ GetVertexScoreList()

◆ Initialize()

◆ InitializeKDTrees()

◆ IsBeamModeOn()

◆ IsVertexInGap()

◆ IsVertexOnHit()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectTopScoreVertices()

◆ SortByVertexZPosition()

◆ VertexHitEnergy()

Member Data Documentation

◆ m_asymmetryConstant

◆ m_beamMode

◆ m_epsilon

◆ m_featureToolVector

◆ m_gapTolerance

◆ m_inputCaloHitListNames

◆ m_inputClusterListNames

◆ m_instanceName

◆ m_isEmptyViewAcceptable

◆ m_maxOnHitDisplacement

◆ m_maxTopScoreSelections

◆ m_minCandidateDisplacement

◆ m_minCandidateScoreFraction

◆ m_minClusterCaloHits

◆ m_minVertexAcceptableViews

◆ m_nDecayLengthsInZSpan

◆ m_outputVertexListName

◆ m_pPandora

◆ m_replaceCurrentVertexList

◆ m_selectSingleVertex

◆ m_slidingFitWindow

◆ m_type

◆ m_useDetectorGaps