TwoDParticleCreationAlgorithm class. More...

#include "TwoDParticleCreationAlgorithm.h"

Inheritance diagram for lar_content::TwoDParticleCreationAlgorithm:

[legend]

Collaboration diagram for lar_content::TwoDParticleCreationAlgorithm:

[legend]

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

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

pandora::StatusCode	CreatePFOs (const pandora::ClusterList *const pClusterList) const
	Create pfos for provided clusters.

Private Attributes
std::string	m_inputClusterListNameU
	The input cluster list name for the U view.

std::string	m_inputClusterListNameV
	The input cluster list name for the V view.

std::string	m_inputClusterListNameW
	The input cluster list name for the W view.

std::string	m_outputPfoListName
	The output pfo list name.

unsigned int	m_minHitsInCluster
	Min number of hits for clusters to form pfos.

float	m_minClusterEnergy
	Min energy for clusters to form pfos.

Detailed Description

TwoDParticleCreationAlgorithm class.

Definition at line 19 of file TwoDParticleCreationAlgorithm.h.

Constructor & Destructor Documentation

◆ TwoDParticleCreationAlgorithm()

lar_content::TwoDParticleCreationAlgorithm::TwoDParticleCreationAlgorithm ( )

Default constructor.

Definition at line 18 of file TwoDParticleCreationAlgorithm.cc.

Member Function Documentation

◆ CreatePFOs()

StatusCode lar_content::TwoDParticleCreationAlgorithm::CreatePFOs ( const pandora::ClusterList *const pClusterList ) const

private

Create pfos for provided clusters.

Parameters

pClusterList address of the cluster list

Definition at line 68 of file TwoDParticleCreationAlgorithm.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.

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 24 of file TwoDParticleCreationAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputClusterListNameU

std::string lar_content::TwoDParticleCreationAlgorithm::m_inputClusterListNameU

private

The input cluster list name for the U view.

Definition at line 38 of file TwoDParticleCreationAlgorithm.h.

◆ m_inputClusterListNameV

std::string lar_content::TwoDParticleCreationAlgorithm::m_inputClusterListNameV

private

The input cluster list name for the V view.

Definition at line 39 of file TwoDParticleCreationAlgorithm.h.

◆ m_inputClusterListNameW

std::string lar_content::TwoDParticleCreationAlgorithm::m_inputClusterListNameW

private

The input cluster list name for the W view.

Definition at line 40 of file TwoDParticleCreationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minClusterEnergy

float lar_content::TwoDParticleCreationAlgorithm::m_minClusterEnergy

private

Min energy for clusters to form pfos.

Definition at line 44 of file TwoDParticleCreationAlgorithm.h.

◆ m_minHitsInCluster

unsigned int lar_content::TwoDParticleCreationAlgorithm::m_minHitsInCluster

private

Min number of hits for clusters to form pfos.

Definition at line 43 of file TwoDParticleCreationAlgorithm.h.

◆ m_outputPfoListName

std::string lar_content::TwoDParticleCreationAlgorithm::m_outputPfoListName

private

The output pfo list name.

Definition at line 42 of file TwoDParticleCreationAlgorithm.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/LArTwoDReco/TwoDParticleCreationAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/TwoDParticleCreationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TwoDParticleCreationAlgorithm()

Member Function Documentation

◆ CreatePFOs()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListNameU

◆ m_inputClusterListNameV

◆ m_inputClusterListNameW

◆ m_instanceName

◆ m_minClusterEnergy

◆ m_minHitsInCluster

◆ m_outputPfoListName

◆ m_pPandora

◆ m_type