#include "PostProcessingAlgorithm.h"

Inheritance diagram for lar_content::PostProcessingAlgorithm:

[legend]

Collaboration diagram for lar_content::PostProcessingAlgorithm:

[legend]

Public Member Functions
	PostProcessingAlgorithm ()
	Default constructor.

template<typename T >
StatusCode	RenameList (const std::string &oldListName) const

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.

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
pandora::StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

pandora::StatusCode	Run ()
	Run the algorithm.

template<typename T >
pandora::StatusCode	RenameList (const std::string &oldListName) const
	Rename a list of relevant type with specified name - the new name will be the old name with appended list counter.

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

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

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

pandora::StringVector	m_vertexListNames
	The list of vertex list names.

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

std::string	m_currentPfoListReplacement
	The name of the pfo list to replace the current list.

unsigned int	m_listCounter
	The counter appended to output (and replacement current) list names and reset each event.

Detailed Description

PostProcessingAlgorithm class.

Definition at line 19 of file PostProcessingAlgorithm.h.

Constructor & Destructor Documentation

◆ PostProcessingAlgorithm()

lar_content::PostProcessingAlgorithm::PostProcessingAlgorithm ( )

Default constructor.

Definition at line 18 of file PostProcessingAlgorithm.cc.

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.

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

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 82 of file PostProcessingAlgorithm.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:

◆ RenameList() [1/2]

template<typename T >

StatusCode lar_content::PostProcessingAlgorithm::RenameList ( const std::string & oldListName ) const

Definition at line 73 of file PostProcessingAlgorithm.cc.

Here is the call graph for this function:

◆ RenameList() [2/2]

template<typename T >

pandora::StatusCode lar_content::PostProcessingAlgorithm::RenameList ( const std::string & oldListName ) const

private

Rename a list of relevant type with specified name - the new name will be the old name with appended list counter.

Parameters

oldListName the old list name

◆ Reset()

StatusCode lar_content::PostProcessingAlgorithm::Reset ( )

privatevirtual

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

Reimplemented from pandora::Process.

Definition at line 24 of file PostProcessingAlgorithm.cc.

◆ Run()

StatusCode lar_content::PostProcessingAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 32 of file PostProcessingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_caloHitListNames

pandora::StringVector lar_content::PostProcessingAlgorithm::m_caloHitListNames

private

The list of calo hit list names.

Definition at line 44 of file PostProcessingAlgorithm.h.

◆ m_clusterListNames

pandora::StringVector lar_content::PostProcessingAlgorithm::m_clusterListNames

private

The list of cluster list names.

Definition at line 42 of file PostProcessingAlgorithm.h.

◆ m_currentPfoListReplacement

std::string lar_content::PostProcessingAlgorithm::m_currentPfoListReplacement

private

The name of the pfo list to replace the current list.

Definition at line 46 of file PostProcessingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_listCounter

unsigned int lar_content::PostProcessingAlgorithm::m_listCounter

private

The counter appended to output (and replacement current) list names and reset each event.

Definition at line 48 of file PostProcessingAlgorithm.h.

◆ m_pfoListNames

pandora::StringVector lar_content::PostProcessingAlgorithm::m_pfoListNames

private

The list of pfo list names.

Definition at line 41 of file PostProcessingAlgorithm.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.

◆ m_vertexListNames

pandora::StringVector lar_content::PostProcessingAlgorithm::m_vertexListNames

private

The list of vertex list names.

Definition at line 43 of file PostProcessingAlgorithm.h.

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

LArContent/larpandoracontent/LArControlFlow/PostProcessingAlgorithm.h
LArContent/larpandoracontent/LArControlFlow/PostProcessingAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PostProcessingAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ RenameList() [1/2]

◆ RenameList() [2/2]

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_caloHitListNames

◆ m_clusterListNames

◆ m_currentPfoListReplacement

◆ m_instanceName

◆ m_listCounter

◆ m_pfoListNames

◆ m_pPandora

◆ m_type

◆ m_vertexListNames