RecursivePfoMopUpAlgorithm class. More...

#include "RecursivePfoMopUpAlgorithm.h"

Inheritance diagram for lar_content::RecursivePfoMopUpAlgorithm:

[legend]

Collaboration diagram for lar_content::RecursivePfoMopUpAlgorithm:

[legend]

Classes
struct	PfoMergeStats
	PfoMergeStats class: Object to compare PFO before/after merging algs have run to see if anything changed. More...

Public Member Functions
	RecursivePfoMopUpAlgorithm ()
	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::vector< unsigned int >	ClusterNumHitsList

typedef std::vector< PfoMergeStats >	PfoMergeStatsList

Private Member Functions
PfoMergeStatsList	GetPfoMergeStats () const
	Get the PfoMergeStats for all of the particles in the event from m_pfoListNames.

pandora::StatusCode	Run ()
	Run the algorithm.

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

Static Private Member Functions
static bool	PfoMergeStatsComp (const PfoMergeStats &lhs, const PfoMergeStats &rhs)
	Equality comparator for two PfoMergeStats.

Private Attributes
unsigned int	m_maxIterations
	Maximum number of iterations.

pandora::StringVector	m_pfoListNames
	The list of pfo list names.

pandora::StringVector	m_mopUpAlgorithms
	Ordered list of mop up algorithms to run.

Detailed Description

RecursivePfoMopUpAlgorithm class.

Definition at line 20 of file RecursivePfoMopUpAlgorithm.h.

Member Typedef Documentation

◆ ClusterNumHitsList

typedef std::vector<unsigned int> lar_content::RecursivePfoMopUpAlgorithm::ClusterNumHitsList

private

Definition at line 29 of file RecursivePfoMopUpAlgorithm.h.

◆ PfoMergeStatsList

typedef std::vector<PfoMergeStats> lar_content::RecursivePfoMopUpAlgorithm::PfoMergeStatsList

private

Definition at line 49 of file RecursivePfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

◆ RecursivePfoMopUpAlgorithm()

lar_content::RecursivePfoMopUpAlgorithm::RecursivePfoMopUpAlgorithm ( )

inline

Default constructor.

Definition at line 78 of file RecursivePfoMopUpAlgorithm.h.

Member Function Documentation

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

◆ GetPfoMergeStats()

RecursivePfoMopUpAlgorithm::PfoMergeStatsList lar_content::RecursivePfoMopUpAlgorithm::GetPfoMergeStats ( ) const

private

Get the PfoMergeStats for all of the particles in the event from m_pfoListNames.

Returns: List of PfoMergeStats for each Pfo

Definition at line 42 of file RecursivePfoMopUpAlgorithm.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:

◆ PfoMergeStatsComp()

bool lar_content::RecursivePfoMopUpAlgorithm::PfoMergeStatsComp	(	const PfoMergeStats &	lhs,
		const PfoMergeStats &	rhs
	)

inlinestaticprivate

Equality comparator for two PfoMergeStats.

Parameters

lhs	PfoMergeStats for comparison
rhs	PfoMergeStats for comparison

Returns: boolean if the lhs and rhs are the same

Definition at line 92 of file RecursivePfoMopUpAlgorithm.h.

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file RecursivePfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxIterations

unsigned int lar_content::RecursivePfoMopUpAlgorithm::m_maxIterations

private

Maximum number of iterations.

Definition at line 71 of file RecursivePfoMopUpAlgorithm.h.

◆ m_mopUpAlgorithms

pandora::StringVector lar_content::RecursivePfoMopUpAlgorithm::m_mopUpAlgorithms

private

Ordered list of mop up algorithms to run.

Definition at line 73 of file RecursivePfoMopUpAlgorithm.h.

◆ m_pfoListNames

pandora::StringVector lar_content::RecursivePfoMopUpAlgorithm::m_pfoListNames

private

The list of pfo list names.

Definition at line 72 of file RecursivePfoMopUpAlgorithm.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/LArPfoMopUp/RecursivePfoMopUpAlgorithm.h
LArContent/larpandoracontent/LArThreeDReco/LArPfoMopUp/RecursivePfoMopUpAlgorithm.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterNumHitsList

◆ PfoMergeStatsList

Constructor & Destructor Documentation

◆ RecursivePfoMopUpAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetPfoMergeStats()

◆ GetType()

◆ Initialize()

◆ PfoMergeStatsComp()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxIterations

◆ m_mopUpAlgorithms

◆ m_pfoListNames

◆ m_pPandora

◆ m_type