CutClusterCharacterisationAlgorithm class. More...

#include "CutClusterCharacterisationAlgorithm.h"

Inheritance diagram for lar_content::CutClusterCharacterisationAlgorithm:

[legend]

Collaboration diagram for lar_content::CutClusterCharacterisationAlgorithm:

[legend]

Public Member Functions
	CutClusterCharacterisationAlgorithm ()
	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.

Static Public Member Functions
static float	GetVertexDistance (const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster)
	Get the distance between the interaction vertex (if present in the current vertex list) and a provided cluster.

static float	GetShowerFitWidth (const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster, const unsigned int showerFitWindow)
	Get a measure of the width of a cluster, using a sliding shower fit result.

Protected Member Functions
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
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.

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

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

Private Attributes
unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits.

unsigned int	m_slidingShowerFitWindow
	The layer window for the sliding shower fits.

unsigned int	m_minCaloHitsCut
	The minimum number of calo hits to qualify as a track.

float	m_maxShowerLengthCut
	The maximum cluster length to qualify as a shower.

float	m_pathLengthRatioCut
	The maximum ratio of path length to straight line length to qualify as a track.

float	m_rTWidthRatioCut
	The maximum ratio of transverse fit position width to straight line length to qualify as a track.

float	m_vertexDistanceRatioCut
	The maximum ratio of vertex separation to straight line length to qualify as a track.

float	m_showerWidthRatioCut
	The maximum ratio of shower fit width to straight line length to qualify as a track.

Detailed Description

CutClusterCharacterisationAlgorithm class.

Definition at line 19 of file CutClusterCharacterisationAlgorithm.h.

Constructor & Destructor Documentation

◆ CutClusterCharacterisationAlgorithm()

lar_content::CutClusterCharacterisationAlgorithm::CutClusterCharacterisationAlgorithm ( )

Default constructor.

Definition at line 24 of file CutClusterCharacterisationAlgorithm.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.

◆ GetShowerFitWidth()

float lar_content::CutClusterCharacterisationAlgorithm::GetShowerFitWidth	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster,
		const unsigned int	showerFitWindow
	)

static

Get a measure of the width of a cluster, using a sliding shower fit result.

Parameters

pAlgorithm	the address of the calling algorithm
pCluster	address of the cluster
showerFitWindow	the layer window used for the sliding shower fit

Returns: the shower fit width

Definition at line 55 of file CutClusterCharacterisationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ GetVertexDistance()

float lar_content::CutClusterCharacterisationAlgorithm::GetVertexDistance	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster
	)

static

Get the distance between the interaction vertex (if present in the current vertex list) and a provided cluster.

Parameters

pAlgorithm	the address of the calling algorithm
pCluster	address of the cluster

Returns: the vertex distance

Definition at line 38 of file CutClusterCharacterisationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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()

bool lar_content::CutClusterCharacterisationAlgorithm::IsClearTrack ( const pandora::Cluster *const pCluster ) const

privatevirtual

Whether cluster is identified as a clear track.

Parameters

pCluster address of the relevant cluster

Returns: boolean

Implements lar_content::ClusterCharacterisationBaseAlgorithm.

Definition at line 89 of file CutClusterCharacterisationAlgorithm.cc.

Here is the call graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::ClusterCharacterisationBaseAlgorithm.

Definition at line 148 of file CutClusterCharacterisationAlgorithm.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::ClusterCharacterisationBaseAlgorithm::Run ( )

protectedvirtualinherited

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

protectedinherited

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_maxShowerLengthCut

float lar_content::CutClusterCharacterisationAlgorithm::m_maxShowerLengthCut

private

The maximum cluster length to qualify as a shower.

Definition at line 55 of file CutClusterCharacterisationAlgorithm.h.

◆ m_minCaloHitsCut

unsigned int lar_content::CutClusterCharacterisationAlgorithm::m_minCaloHitsCut

private

The minimum number of calo hits to qualify as a track.

Definition at line 54 of file CutClusterCharacterisationAlgorithm.h.

◆ m_overwriteExistingId

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId

protectedinherited

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

Definition at line 49 of file ClusterCharacterisationBaseAlgorithm.h.

◆ m_pathLengthRatioCut

float lar_content::CutClusterCharacterisationAlgorithm::m_pathLengthRatioCut

private

The maximum ratio of path length to straight line length to qualify as a track.

Definition at line 56 of file CutClusterCharacterisationAlgorithm.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_rTWidthRatioCut

float lar_content::CutClusterCharacterisationAlgorithm::m_rTWidthRatioCut

private

The maximum ratio of transverse fit position width to straight line length to qualify as a track.

Definition at line 57 of file CutClusterCharacterisationAlgorithm.h.

◆ m_showerWidthRatioCut

float lar_content::CutClusterCharacterisationAlgorithm::m_showerWidthRatioCut

private

The maximum ratio of shower fit width to straight line length to qualify as a track.

Definition at line 59 of file CutClusterCharacterisationAlgorithm.h.

◆ m_slidingFitWindow

unsigned int lar_content::CutClusterCharacterisationAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 52 of file CutClusterCharacterisationAlgorithm.h.

◆ m_slidingShowerFitWindow

unsigned int lar_content::CutClusterCharacterisationAlgorithm::m_slidingShowerFitWindow

private

The layer window for the sliding shower fits.

Definition at line 53 of file CutClusterCharacterisationAlgorithm.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

protectedinherited

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

Definition at line 50 of file ClusterCharacterisationBaseAlgorithm.h.

◆ m_vertexDistanceRatioCut

float lar_content::CutClusterCharacterisationAlgorithm::m_vertexDistanceRatioCut

private

The maximum ratio of vertex separation to straight line length to qualify as a track.

Definition at line 58 of file CutClusterCharacterisationAlgorithm.h.

◆ m_zeroMode

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_zeroMode

protectedinherited

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/CutClusterCharacterisationAlgorithm.h
LArContent/larpandoracontent/LArTrackShowerId/CutClusterCharacterisationAlgorithm.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CutClusterCharacterisationAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetShowerFitWidth()

◆ GetType()

◆ GetVertexDistance()

◆ Initialize()

◆ IsClearTrack()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListNames

◆ m_instanceName

◆ m_maxShowerLengthCut

◆ m_minCaloHitsCut

◆ m_overwriteExistingId

◆ m_pathLengthRatioCut

◆ m_pPandora

◆ m_rTWidthRatioCut

◆ m_showerWidthRatioCut

◆ m_slidingFitWindow

◆ m_slidingShowerFitWindow

◆ m_type

◆ m_useUnavailableClusters

◆ m_vertexDistanceRatioCut

◆ m_zeroMode