ClusterCharacterisationBaseAlgorithm class. More...

#include "ClusterCharacterisationBaseAlgorithm.h"

Inheritance diagram for lar_content::ClusterCharacterisationBaseAlgorithm:

[legend]

Collaboration diagram for lar_content::ClusterCharacterisationBaseAlgorithm:

[legend]

Public Member Functions
	ClusterCharacterisationBaseAlgorithm ()
	Default constructor.

	~ClusterCharacterisationBaseAlgorithm ()
	Destructor.

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 bool	IsClearTrack (const pandora::Cluster *const pCluster) const =0
	Whether cluster is identified as a clear track.

pandora::StatusCode	Run ()
	Run the algorithm.

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

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
pandora::StringVector	m_inputClusterListNames
	The names of the input cluster lists.

bool	m_zeroMode
	Whether to zero all existing cluster particle id, overrides all other parameters.

bool	m_overwriteExistingId
	Whether to consider any clusters that already have an assigned particle id.

bool	m_useUnavailableClusters
	Whether to consider clusters that are already constituents of a pfo.

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.

Detailed Description

ClusterCharacterisationBaseAlgorithm class.

Definition at line 19 of file ClusterCharacterisationBaseAlgorithm.h.

Constructor & Destructor Documentation

◆ ClusterCharacterisationBaseAlgorithm()

lar_content::ClusterCharacterisationBaseAlgorithm::ClusterCharacterisationBaseAlgorithm ( )

Default constructor.

Definition at line 21 of file ClusterCharacterisationBaseAlgorithm.cc.

◆ ~ClusterCharacterisationBaseAlgorithm()

lar_content::ClusterCharacterisationBaseAlgorithm::~ClusterCharacterisationBaseAlgorithm ( )

Destructor.

Definition at line 30 of file ClusterCharacterisationBaseAlgorithm.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:

◆ IsClearTrack()

virtual bool lar_content::ClusterCharacterisationBaseAlgorithm::IsClearTrack ( const pandora::Cluster *const pCluster ) const

protectedpure virtual

Whether cluster is identified as a clear track.

Parameters

pCluster address of the relevant cluster

Returns: boolean

Implemented in lar_content::CheatingClusterCharacterisationAlgorithm, lar_content::CutClusterCharacterisationAlgorithm, and lar_dl_content::DlClusterCharacterisationAlgorithm.

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::CutClusterCharacterisationAlgorithm, and lar_dl_content::DlClusterCharacterisationAlgorithm.

Definition at line 93 of file ClusterCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller 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::ClusterCharacterisationBaseAlgorithm::Run ( )

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 36 of file ClusterCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputClusterListNames

pandora::StringVector lar_content::ClusterCharacterisationBaseAlgorithm::m_inputClusterListNames

protected

The names of the input cluster lists.

Definition at line 45 of file ClusterCharacterisationBaseAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_overwriteExistingId

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId

protected

Whether to consider any clusters that already have an assigned particle id.

Definition at line 49 of file ClusterCharacterisationBaseAlgorithm.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_useUnavailableClusters

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_useUnavailableClusters

protected

Whether to consider clusters that are already constituents of a pfo.

Definition at line 50 of file ClusterCharacterisationBaseAlgorithm.h.

◆ m_zeroMode

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_zeroMode

protected

Whether to zero all existing cluster particle id, overrides all other parameters.

Definition at line 47 of file ClusterCharacterisationBaseAlgorithm.h.

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

LArContent/larpandoracontent/LArTrackShowerId/ClusterCharacterisationBaseAlgorithm.h
LArContent/larpandoracontent/LArTrackShowerId/ClusterCharacterisationBaseAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClusterCharacterisationBaseAlgorithm()

◆ ~ClusterCharacterisationBaseAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsClearTrack()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListNames

◆ m_instanceName

◆ m_overwriteExistingId

◆ m_pPandora

◆ m_type

◆ m_useUnavailableClusters

◆ m_zeroMode