DeltaRayIdentificationAlgorithm class. More...

#include "DeltaRayIdentificationAlgorithm.h"

Inheritance diagram for lar_content::DeltaRayIdentificationAlgorithm:

[legend]

Collaboration diagram for lar_content::DeltaRayIdentificationAlgorithm:

[legend]

Public Member Functions
	DeltaRayIdentificationAlgorithm ()
	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 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 Types
typedef std::unordered_map< const pandora::ParticleFlowObject , const pandora::ParticleFlowObject >	PfoAssociationMap

Private Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

void	GetPfos (const std::string &inputPfoListName, pandora::PfoVector &outputPfoVector) const
	Get the vector of Pfos, given the input list name.

void	BuildAssociationMap (const pandora::PfoVector &inputPfos, const pandora::PfoVector &outputPfos, PfoAssociationMap &pfoAssociationMap) const
	Build parent/daughter associations between PFOs.

bool	IsAssociated (const pandora::ParticleFlowObject const pDaughterPfo, const pandora::ParticleFlowObject const pParentPfo, float &displacement) const
	Determine if a given pair of Pfos have a parent/daughter association.

float	GetTwoDSeparation (const pandora::ParticleFlowObject const pDaughterPfo, const pandora::ParticleFlowObject const pParentPfo) const
	Calculate 2D separation between two Pfos.

void	GetTwoDVertices (const pandora::ParticleFlowObject *const pPfo, const pandora::HitType &hitType, pandora::CartesianPointVector &vertexVector) const
	Calculate 2D separation between two Pfos.

float	GetClosestDistance (const pandora::CartesianPointVector &vertexVector, const pandora::ClusterList &clusterList) const
	Calculate closest 2D separation between a set of vertices and a set of clusters.

void	BuildParentDaughterLinks (const PfoAssociationMap &pfoAssociationMap, pandora::PfoList &outputPfoList) const
	Build the parent/daughter links from the map of parent/daughter associations.

const pandora::ParticleFlowObject *	GetParent (const PfoAssociationMap &pfoAssociationMap, const pandora::ParticleFlowObject *const pPfo) const
	For a given daughter, follow the parent/daughter links to find the overall parent.

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

Private Attributes
std::string	m_parentPfoListName
	The parent pfo list name.

std::string	m_daughterPfoListName
	The daughter pfo list name.

float	m_distanceForMatching
	Maximum allowed distance of delta ray from parent cosmic ray.

float	m_minParentLengthSquared
	Minimum allowed length of parent cosmic ray.

float	m_maxDaughterLengthSquared
	Maximum allowed length of daughter delta ray.

Detailed Description

DeltaRayIdentificationAlgorithm class.

Definition at line 21 of file DeltaRayIdentificationAlgorithm.h.

Member Typedef Documentation

◆ PfoAssociationMap

typedef std::unordered_map<const pandora::ParticleFlowObject *, const pandora::ParticleFlowObject *> lar_content::DeltaRayIdentificationAlgorithm::PfoAssociationMap

private

Definition at line 32 of file DeltaRayIdentificationAlgorithm.h.

Constructor & Destructor Documentation

◆ DeltaRayIdentificationAlgorithm()

lar_content::DeltaRayIdentificationAlgorithm::DeltaRayIdentificationAlgorithm ( )

Default constructor.

Definition at line 21 of file DeltaRayIdentificationAlgorithm.cc.

Member Function Documentation

◆ BuildAssociationMap()

void lar_content::DeltaRayIdentificationAlgorithm::BuildAssociationMap	(	const pandora::PfoVector &	inputPfos,
		const pandora::PfoVector &	outputPfos,
		PfoAssociationMap &	pfoAssociationMap
	)		const

private

Build parent/daughter associations between PFOs.

Parameters

inputPfos	the input vector of current parent Pfos
outputPfos	the input vector of current daughter Pfos
pfoAssociationMap	the output map of parent/daughter associations

Definition at line 76 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildParentDaughterLinks()

void lar_content::DeltaRayIdentificationAlgorithm::BuildParentDaughterLinks	(	const PfoAssociationMap &	pfoAssociationMap,
		pandora::PfoList &	outputPfoList
	)		const

private

Build the parent/daughter links from the map of parent/daughter associations.

Parameters

pfoAssociationMap	the map of parent/daughter associations
outputPfoList	the output list of daughter Pfos

Definition at line 275 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClosestDistance()

float lar_content::DeltaRayIdentificationAlgorithm::GetClosestDistance	(	const pandora::CartesianPointVector &	vertexVector,
		const pandora::ClusterList &	clusterList
	)		const

private

Calculate closest 2D separation between a set of vertices and a set of clusters.

Parameters

vertexVector	the vector of possible vertex positions
clusterList	the list of clusters

Definition at line 249 of file DeltaRayIdentificationAlgorithm.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.

◆ GetParent()

const ParticleFlowObject * lar_content::DeltaRayIdentificationAlgorithm::GetParent	(	const PfoAssociationMap &	pfoAssociationMap,
		const pandora::ParticleFlowObject *const	pPfo
	)		const

private

For a given daughter, follow the parent/daughter links to find the overall parent.

Parameters

pfoAssociationMap	the map of parent/daughter associations
pPfo	the daughter Pfo

Returns: the parent Pfo

Definition at line 304 of file DeltaRayIdentificationAlgorithm.cc.

Here is the caller graph for this function:

◆ GetPfos()

void lar_content::DeltaRayIdentificationAlgorithm::GetPfos	(	const std::string &	inputPfoListName,
		pandora::PfoVector &	outputPfoVector
	)		const

private

Get the vector of Pfos, given the input list name.

Parameters

inputPfoListName	the input Pfo list name
outputPfoVector	the output vector of Pfos

Definition at line 62 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTwoDSeparation()

float lar_content::DeltaRayIdentificationAlgorithm::GetTwoDSeparation	(	const pandora::ParticleFlowObject *const	pDaughterPfo,
		const pandora::ParticleFlowObject *const	pParentPfo
	)		const

private

Calculate 2D separation between two Pfos.

Parameters

pDaughterPfo	the input daughter Pfo
pParentPfo	the input parent Pfo

Returns: average displacement between parent and daughter

Definition at line 186 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTwoDVertices()

void lar_content::DeltaRayIdentificationAlgorithm::GetTwoDVertices	(	const pandora::ParticleFlowObject *const	pPfo,
		const pandora::HitType &	hitType,
		pandora::CartesianPointVector &	vertexVector
	)		const

private

Calculate 2D separation between two Pfos.

Parameters

pPfo	the input daughter Pfo
hitType	the hit type
vertexVector	the vector of possible vertex positions

Definition at line 230 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetType()

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

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ 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:

◆ IsAssociated()

bool lar_content::DeltaRayIdentificationAlgorithm::IsAssociated	(	const pandora::ParticleFlowObject *const	pDaughterPfo,
		const pandora::ParticleFlowObject *const	pParentPfo,
		float &	displacement
	)		const

private

Determine if a given pair of Pfos have a parent/daughter association.

Parameters

pDaughterPfo	the input daughter Pfo
pParentPfo	the input parent Pfo
displacement	the average displacement between parent and daughter

Returns: boolean

Definition at line 149 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 324 of file DeltaRayIdentificationAlgorithm.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::DeltaRayIdentificationAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 30 of file DeltaRayIdentificationAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_daughterPfoListName

std::string lar_content::DeltaRayIdentificationAlgorithm::m_daughterPfoListName

private

The daughter pfo list name.

Definition at line 110 of file DeltaRayIdentificationAlgorithm.h.

◆ m_distanceForMatching

float lar_content::DeltaRayIdentificationAlgorithm::m_distanceForMatching

private

Maximum allowed distance of delta ray from parent cosmic ray.

Definition at line 112 of file DeltaRayIdentificationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxDaughterLengthSquared

float lar_content::DeltaRayIdentificationAlgorithm::m_maxDaughterLengthSquared

private

Maximum allowed length of daughter delta ray.

Definition at line 114 of file DeltaRayIdentificationAlgorithm.h.

◆ m_minParentLengthSquared

float lar_content::DeltaRayIdentificationAlgorithm::m_minParentLengthSquared

private

Minimum allowed length of parent cosmic ray.

Definition at line 113 of file DeltaRayIdentificationAlgorithm.h.

◆ m_parentPfoListName

std::string lar_content::DeltaRayIdentificationAlgorithm::m_parentPfoListName

private

The parent pfo list name.

Definition at line 109 of file DeltaRayIdentificationAlgorithm.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_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

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

LArContent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayIdentificationAlgorithm.h
LArContent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayIdentificationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PfoAssociationMap

Constructor & Destructor Documentation

◆ DeltaRayIdentificationAlgorithm()

Member Function Documentation

◆ BuildAssociationMap()

◆ BuildParentDaughterLinks()

◆ GetClosestDistance()

◆ GetInstanceName()

◆ GetPandora()

◆ GetParent()

◆ GetPfos()

◆ GetTwoDSeparation()

◆ GetTwoDVertices()

◆ GetType()

◆ Initialize()

◆ IsAssociated()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_daughterPfoListName

◆ m_distanceForMatching

◆ m_instanceName

◆ m_maxDaughterLengthSquared

◆ m_minParentLengthSquared

◆ m_parentPfoListName

◆ m_pPandora

◆ m_type