#include "SlicingAlgorithm.h"

Inheritance diagram for lar_content::SlicingAlgorithm:

[legend]

Collaboration diagram for lar_content::SlicingAlgorithm:

[legend]

Classes
class	Slice
	Slice class. More...

Public Types
typedef std::vector< Slice >	SliceList

typedef std::map< pandora::HitType, std::string >	HitTypeToNameMap

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

Private Attributes
EventSlicingBaseTool *	m_pEventSlicingTool
	The address of the event slicing tool.

std::string	m_slicingListDeletionAlgorithm
	The name of the slicing list deletion algorithm.

HitTypeToNameMap	m_caloHitListNames
	The hit type to calo hit list name map.

HitTypeToNameMap	m_clusterListNames
	The hit type to cluster list name map.

std::string	m_sliceClusterListName
	The name of the output slice cluster list.

std::string	m_slicePfoListName
	The name of the output slice pfo list.

Detailed Description

SlicingAlgorithm class.

Definition at line 24 of file SlicingAlgorithm.h.

Class Documentation

◆ lar_content::SlicingAlgorithm::Slice

class lar_content::SlicingAlgorithm::Slice

Slice class.

Definition at line 30 of file SlicingAlgorithm.h.

Class Members
CaloHitList	m_caloHitListU	The u calo hit list.
CaloHitList	m_caloHitListV	The v calo hit list.
CaloHitList	m_caloHitListW	The w calo hit list.

Member Typedef Documentation

◆ HitTypeToNameMap

typedef std::map<pandora::HitType, std::string> lar_content::SlicingAlgorithm::HitTypeToNameMap

Definition at line 39 of file SlicingAlgorithm.h.

◆ SliceList

typedef std::vector<Slice> lar_content::SlicingAlgorithm::SliceList

Definition at line 38 of file SlicingAlgorithm.h.

Constructor & Destructor Documentation

◆ SlicingAlgorithm()

lar_content::SlicingAlgorithm::SlicingAlgorithm ( )

Default constructor.

Definition at line 20 of file SlicingAlgorithm.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:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 26 of file SlicingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_caloHitListNames

HitTypeToNameMap lar_content::SlicingAlgorithm::m_caloHitListNames

private

The hit type to calo hit list name map.

Definition at line 53 of file SlicingAlgorithm.h.

◆ m_clusterListNames

HitTypeToNameMap lar_content::SlicingAlgorithm::m_clusterListNames

private

The hit type to cluster list name map.

Definition at line 54 of file SlicingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_pEventSlicingTool

EventSlicingBaseTool* lar_content::SlicingAlgorithm::m_pEventSlicingTool

private

The address of the event slicing tool.

Definition at line 50 of file SlicingAlgorithm.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_sliceClusterListName

std::string lar_content::SlicingAlgorithm::m_sliceClusterListName

private

The name of the output slice cluster list.

Definition at line 56 of file SlicingAlgorithm.h.

◆ m_slicePfoListName

std::string lar_content::SlicingAlgorithm::m_slicePfoListName

private

The name of the output slice pfo list.

Definition at line 57 of file SlicingAlgorithm.h.

◆ m_slicingListDeletionAlgorithm

std::string lar_content::SlicingAlgorithm::m_slicingListDeletionAlgorithm

private

The name of the slicing list deletion algorithm.

Definition at line 51 of file SlicingAlgorithm.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/LArControlFlow/SlicingAlgorithm.h
LArContent/larpandoracontent/LArControlFlow/SlicingAlgorithm.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Class Documentation

◆ lar_content::SlicingAlgorithm::Slice

Member Typedef Documentation

◆ HitTypeToNameMap

◆ SliceList

Constructor & Destructor Documentation

◆ SlicingAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_caloHitListNames

◆ m_clusterListNames

◆ m_instanceName

◆ m_pEventSlicingTool

◆ m_pPandora

◆ m_sliceClusterListName

◆ m_slicePfoListName

◆ m_slicingListDeletionAlgorithm

◆ m_type