TrackParticleBuildingAlgorithm class. More...

#include "TrackParticleBuildingAlgorithm.h"

Inheritance diagram for lar_content::TrackParticleBuildingAlgorithm:

[legend]

Collaboration diagram for lar_content::TrackParticleBuildingAlgorithm:

[legend]

Public Member Functions
	TrackParticleBuildingAlgorithm ()
	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 pandora::StatusCode	Run ()
	Run the algorithm.

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
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

void	CreatePfo (const pandora::ParticleFlowObject const pInputPfo, const pandora::ParticleFlowObject &pOutputPfo) const
	Create specialised Pfo from an generic input Pfo.

Private Attributes
unsigned int	m_slidingFitHalfWindow

std::string	m_pfoListName
	The name of the input pfo list.

std::string	m_vertexListName
	The name of the input vertex list.

Detailed Description

TrackParticleBuildingAlgorithm class.

Definition at line 21 of file TrackParticleBuildingAlgorithm.h.

Constructor & Destructor Documentation

◆ TrackParticleBuildingAlgorithm()

lar_content::TrackParticleBuildingAlgorithm::TrackParticleBuildingAlgorithm ( )

Default constructor.

Definition at line 25 of file TrackParticleBuildingAlgorithm.cc.

Member Function Documentation

◆ CreatePfo()

void lar_content::TrackParticleBuildingAlgorithm::CreatePfo	(	const pandora::ParticleFlowObject *const	pInputPfo,
		const pandora::ParticleFlowObject *&	pOutputPfo
	)		const

privatevirtual

Create specialised Pfo from an generic input Pfo.

Parameters

pInputPfo	the address of the input Pfo
pOutputPfo	the address of the output Pfo

Implements lar_content::CustomParticleCreationAlgorithm.

Definition at line 31 of file TrackParticleBuildingAlgorithm.cc.

Here is the call 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.

◆ 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::TrackParticleBuildingAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::CustomParticleCreationAlgorithm.

Definition at line 105 of file TrackParticleBuildingAlgorithm.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::CustomParticleCreationAlgorithm::Run ( )

protectedvirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file CustomParticleCreationAlgorithm.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_pfoListName

std::string lar_content::CustomParticleCreationAlgorithm::m_pfoListName

privateinherited

The name of the input pfo list.

Definition at line 34 of file CustomParticleCreationAlgorithm.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_slidingFitHalfWindow

unsigned int lar_content::TrackParticleBuildingAlgorithm::m_slidingFitHalfWindow

private

Definition at line 34 of file TrackParticleBuildingAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_vertexListName

std::string lar_content::CustomParticleCreationAlgorithm::m_vertexListName

privateinherited

The name of the input vertex list.

Definition at line 35 of file CustomParticleCreationAlgorithm.h.

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

LArContent/larpandoracontent/LArCustomParticles/TrackParticleBuildingAlgorithm.h
LArContent/larpandoracontent/LArCustomParticles/TrackParticleBuildingAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TrackParticleBuildingAlgorithm()

Member Function Documentation

◆ CreatePfo()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_pfoListName

◆ m_pPandora

◆ m_slidingFitHalfWindow

◆ m_type

◆ m_vertexListName