PfoCharacterisationBaseAlgorithm class. More...

#include "PfoCharacterisationBaseAlgorithm.h"

Inheritance diagram for lar_content::PfoCharacterisationBaseAlgorithm:

[legend]

Collaboration diagram for lar_content::PfoCharacterisationBaseAlgorithm:

[legend]

Public Member Functions
	PfoCharacterisationBaseAlgorithm ()
	Default constructor.

virtual	~PfoCharacterisationBaseAlgorithm ()
	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
pandora::StatusCode	Run ()
	Run the algorithm.

virtual bool	IsClearTrack3x2D (const pandora::ParticleFlowObject *const pPfo) const
	Whether pfo is identified as a clear track using its three clusters.

virtual bool	IsClearTrack (const pandora::ParticleFlowObject *const pPfo) const =0
	Whether pfo is identified as a clear track.

virtual bool	IsClearTrack (const pandora::Cluster *const pCluster) const =0
	Whether cluster is identified as a clear track.

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
std::string	m_trackPfoListName
	The track pfo list name.

std::string	m_showerPfoListName
	The shower pfo list name.

pandora::StringVector	m_inputPfoListNames
	The names of the input pfo lists.

bool	m_updateClusterIds
	Whether to update daughter cluster particle id labels to match pfo id.

bool	m_postBranchAddition
	Whether to use configuration for shower clusters post branch addition.

bool	m_useThreeDInformation
	Whether to use PFO and 3D information or clusters for characterisation.

unsigned int	m_minTrackLikeViews
	The minimum number of track-like views to declare a pfo as track-like.

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

PfoCharacterisationBaseAlgorithm class.

Definition at line 19 of file PfoCharacterisationBaseAlgorithm.h.

Constructor & Destructor Documentation

◆ PfoCharacterisationBaseAlgorithm()

lar_content::PfoCharacterisationBaseAlgorithm::PfoCharacterisationBaseAlgorithm ( )

Default constructor.

Definition at line 23 of file PfoCharacterisationBaseAlgorithm.cc.

◆ ~PfoCharacterisationBaseAlgorithm()

lar_content::PfoCharacterisationBaseAlgorithm::~PfoCharacterisationBaseAlgorithm ( )

virtual

Destructor.

Definition at line 33 of file PfoCharacterisationBaseAlgorithm.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() [1/2]

virtual bool lar_content::PfoCharacterisationBaseAlgorithm::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::CheatingPfoCharacterisationAlgorithm, lar_content::CutPfoCharacterisationAlgorithm, lar_content::MvaPfoCharacterisationAlgorithm< T >, and lar_dl_content::DlPfoCharacterisationAlgorithm.

◆ IsClearTrack() [2/2]

virtual bool lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack ( const pandora::ParticleFlowObject *const pPfo ) const

protectedpure virtual

Whether pfo is identified as a clear track.

Parameters

pPfo	address of the relevant pfo

Returns: boolean

Implemented in lar_content::CheatingPfoCharacterisationAlgorithm, lar_content::CutPfoCharacterisationAlgorithm, lar_content::MvaPfoCharacterisationAlgorithm< T >, and lar_dl_content::DlPfoCharacterisationAlgorithm.

Here is the caller graph for this function:

◆ IsClearTrack3x2D()

bool lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack3x2D ( const pandora::ParticleFlowObject *const pPfo ) const

protectedvirtual

Whether pfo is identified as a clear track using its three clusters.

Parameters

pPfo	address of the relevant pfo

Returns: boolean

Definition at line 108 of file PfoCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 39 of file PfoCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputPfoListNames

pandora::StringVector lar_content::PfoCharacterisationBaseAlgorithm::m_inputPfoListNames

protected

The names of the input pfo lists.

Definition at line 66 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minTrackLikeViews

unsigned int lar_content::PfoCharacterisationBaseAlgorithm::m_minTrackLikeViews

protected

The minimum number of track-like views to declare a pfo as track-like.

Definition at line 71 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_postBranchAddition

bool lar_content::PfoCharacterisationBaseAlgorithm::m_postBranchAddition

protected

Whether to use configuration for shower clusters post branch addition.

Definition at line 69 of file PfoCharacterisationBaseAlgorithm.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_showerPfoListName

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_showerPfoListName

protected

The shower pfo list name.

Definition at line 65 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_trackPfoListName

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_trackPfoListName

protected

The track pfo list name.

Definition at line 64 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_updateClusterIds

bool lar_content::PfoCharacterisationBaseAlgorithm::m_updateClusterIds

protected

Whether to update daughter cluster particle id labels to match pfo id.

Definition at line 68 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_useThreeDInformation

bool lar_content::PfoCharacterisationBaseAlgorithm::m_useThreeDInformation

protected

Whether to use PFO and 3D information or clusters for characterisation.

Definition at line 70 of file PfoCharacterisationBaseAlgorithm.h.

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

LArContent/larpandoracontent/LArTrackShowerId/PfoCharacterisationBaseAlgorithm.h
LArContent/larpandoracontent/LArTrackShowerId/PfoCharacterisationBaseAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PfoCharacterisationBaseAlgorithm()

◆ ~PfoCharacterisationBaseAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsClearTrack() [1/2]

◆ IsClearTrack() [2/2]

◆ IsClearTrack3x2D()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputPfoListNames

◆ m_instanceName

◆ m_minTrackLikeViews

◆ m_postBranchAddition

◆ m_pPandora

◆ m_showerPfoListName

◆ m_trackPfoListName

◆ m_type

◆ m_updateClusterIds

◆ m_useThreeDInformation