#include "StreamSelectionAlgorithm.h"

Inheritance diagram for lar_content::StreamSelectionAlgorithm:

[legend]

Collaboration diagram for lar_content::StreamSelectionAlgorithm:

[legend]

Public Member Functions
	StreamSelectionAlgorithm ()
	Default constructor.

virtual	~StreamSelectionAlgorithm ()=default

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 Types
typedef std::map< std::string, pandora::ClusterList >	ClusterListMap

Protected Member Functions
virtual pandora::StatusCode	AllocateToStreams (const pandora::Cluster *const pCluster)=0
	Allocate a cluster to the appropriate streams.

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_inputListName
	The input list name if not using the current list.

std::string	m_listType
	The type of the input lists (currently only Cluster is supported)

pandora::StringVector	m_listNames
	The name of the output lists.

ClusterListMap	m_clusterListMap
	The map from cluster list names to cluster lists.

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.

Detailed Description

StreamSelectionAlgorithm class.

Definition at line 19 of file StreamSelectionAlgorithm.h.

Member Typedef Documentation

◆ ClusterListMap

typedef std::map<std::string, pandora::ClusterList> lar_content::StreamSelectionAlgorithm::ClusterListMap

protected

Definition at line 30 of file StreamSelectionAlgorithm.h.

Constructor & Destructor Documentation

◆ StreamSelectionAlgorithm()

lar_content::StreamSelectionAlgorithm::StreamSelectionAlgorithm ( )

Default constructor.

Definition at line 25 of file StreamSelectionAlgorithm.cc.

◆ ~StreamSelectionAlgorithm()

virtual lar_content::StreamSelectionAlgorithm::~StreamSelectionAlgorithm ( )

virtualdefault

Member Function Documentation

◆ AllocateToStreams()

virtual pandora::StatusCode lar_content::StreamSelectionAlgorithm::AllocateToStreams ( const pandora::Cluster *const pCluster )

protectedpure virtual

Allocate a cluster to the appropriate streams.

Parameters

pCluster The cluster to allocate to a stream

Returns: The StatusCode

Implemented in lar_dl_content::DlTrackShowerStreamSelectionAlgorithm.

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 31 of file StreamSelectionAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_clusterListMap

ClusterListMap lar_content::StreamSelectionAlgorithm::m_clusterListMap

protected

The map from cluster list names to cluster lists.

Definition at line 46 of file StreamSelectionAlgorithm.h.

◆ m_inputListName

std::string lar_content::StreamSelectionAlgorithm::m_inputListName

protected

The input list name if not using the current list.

Definition at line 43 of file StreamSelectionAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_listNames

pandora::StringVector lar_content::StreamSelectionAlgorithm::m_listNames

protected

The name of the output lists.

Definition at line 45 of file StreamSelectionAlgorithm.h.

◆ m_listType

std::string lar_content::StreamSelectionAlgorithm::m_listType

protected

The type of the input lists (currently only Cluster is supported)

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ ClusterListMap

Constructor & Destructor Documentation

◆ StreamSelectionAlgorithm()

◆ ~StreamSelectionAlgorithm()

Member Function Documentation

◆ AllocateToStreams()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_clusterListMap

◆ m_inputListName

◆ m_instanceName

◆ m_listNames

◆ m_listType

◆ m_pPandora

◆ m_type