lar_content::LArPseudoLayerPlugin Class Reference

LarPandoraPseudoLayerPlugin class. More...

#include "LArPseudoLayerPlugin.h"

Inheritance diagram for lar_content::LArPseudoLayerPlugin:

Collaboration diagram for lar_content::LArPseudoLayerPlugin:

Public Member Functions
	LArPseudoLayerPlugin ()
	Constructor.
unsigned int	GetPseudoLayer (const pandora::CartesianVector &positionVector) const
	Get the appropriate pseudolayer for a specified position vector.
unsigned int	GetPseudoLayerAtIp () const
	Get the pseudolayer assigned to a point at the ip, i.e. the initial offset for pseudolayer values and the start of the pseudolayer scale.
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	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	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

Private Attributes
float	m_zPitch
	The z pitch.
float	m_zOffset
	The z offset.
unsigned int	m_zerothLayer
	The zeroth layer.

Detailed Description

LarPandoraPseudoLayerPlugin class.

Definition at line 19 of file LArPseudoLayerPlugin.h.

Constructor & Destructor Documentation

LArPseudoLayerPlugin()

lar_content::LArPseudoLayerPlugin::LArPseudoLayerPlugin

(

)

Constructor.

Definition at line 27 of file LArPseudoLayerPlugin.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.

GetPseudoLayer()

unsigned int lar_content::LArPseudoLayerPlugin::GetPseudoLayer ( const pandora::CartesianVector &  positionVector ) const

virtual

Get the appropriate pseudolayer for a specified position vector.

Parameters

positionVector

the specified position

Returns

the appropriate pseudolayer

Implements pandora::PseudoLayerPlugin.

Definition at line 33 of file LArPseudoLayerPlugin.cc.

Here is the call graph for this function:

GetPseudoLayerAtIp()

unsigned int lar_content::LArPseudoLayerPlugin::GetPseudoLayerAtIp ( ) const

inlinevirtual

Get the pseudolayer assigned to a point at the ip, i.e. the initial offset for pseudolayer values and the start of the pseudolayer scale.

Returns

the pseudolayer assigned to a point at the ip

Implements pandora::PseudoLayerPlugin.

Definition at line 41 of file LArPseudoLayerPlugin.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 lar_content::LArPseudoLayerPlugin::Initialize ( )

privatevirtual

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented from pandora::Process.

Definition at line 45 of file LArPseudoLayerPlugin.cc.

Here is the call graph for this function:

ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle

the relevant xml handle

Implements pandora::Process.

Definition at line 74 of file LArPseudoLayerPlugin.cc.

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:

Member Data Documentation

m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.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_zerothLayer

unsigned int lar_content::LArPseudoLayerPlugin::m_zerothLayer

private

The zeroth layer.

Definition at line 36 of file LArPseudoLayerPlugin.h.

m_zOffset

float lar_content::LArPseudoLayerPlugin::m_zOffset

private

The z offset.

Definition at line 35 of file LArPseudoLayerPlugin.h.

m_zPitch

float lar_content::LArPseudoLayerPlugin::m_zPitch

private

The z pitch.

Definition at line 34 of file LArPseudoLayerPlugin.h.

---

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

• LArContent/larpandoracontent/LArPlugins/LArPseudoLayerPlugin.h
• LArContent/larpandoracontent/LArPlugins/LArPseudoLayerPlugin.cc