Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
lar_content::TestBeamParticleCreationAlgorithm Class Reference

TestBeamParticleCreationAlgorithm class. More...

#include "TestBeamParticleCreationAlgorithm.h"

Inheritance diagram for lar_content::TestBeamParticleCreationAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for lar_content::TestBeamParticleCreationAlgorithm:
Collaboration graph
[legend]

Public Member Functions

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 SetupTestBeamPfo (const pandora::Pfo *const pNuPfo, const pandora::Pfo *&pTestBeamPfo, pandora::CartesianVector &testBeamStartVertex) const
 Set up the test beam pfo.
 
pandora::StatusCode SetupTestBeamVertex (const pandora::Pfo *const pNuPfo, const pandora::Pfo *const pTestBeamPfo, const pandora::CartesianVector &testBeamStartVertex) const
 Set up the test beam vertex.
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 

Private Attributes

std::string m_parentPfoListName
 The parent pfo list name.
 
std::string m_trackPfoListName
 The track pfo list name.
 
std::string m_showerPfoListName
 The shower pfo list name.
 
std::string m_parentVertexListName
 The parent vertex list name.
 
std::string m_daughterVertexListName
 The daughter vertex list name.
 

Detailed Description

TestBeamParticleCreationAlgorithm class.

Definition at line 19 of file TestBeamParticleCreationAlgorithm.h.

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

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 149 of file TestBeamParticleCreationAlgorithm.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
pPandoraaddress of the pandora object that will run the process
typethe process type
instanceNamethe 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::TestBeamParticleCreationAlgorithm::Run ( )
privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file TestBeamParticleCreationAlgorithm.cc.

Here is the call graph for this function:

◆ SetupTestBeamPfo()

StatusCode lar_content::TestBeamParticleCreationAlgorithm::SetupTestBeamPfo ( const pandora::Pfo *const  pNuPfo,
const pandora::Pfo *&  pTestBeamPfo,
pandora::CartesianVector &  testBeamStartVertex 
) const
private

Set up the test beam pfo.

Parameters
pNuPfothe input neutrino-hypothesis pfo
pTestBeamPfoto receive the output test-beam-hypothesis pfo
testBeamStartVertexto receive the position of the test beam start-position vertex (position of hit at minimum z)
Returns
status code

Definition at line 55 of file TestBeamParticleCreationAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetupTestBeamVertex()

StatusCode lar_content::TestBeamParticleCreationAlgorithm::SetupTestBeamVertex ( const pandora::Pfo *const  pNuPfo,
const pandora::Pfo *const  pTestBeamPfo,
const pandora::CartesianVector &  testBeamStartVertex 
) const
private

Set up the test beam vertex.

Parameters
pNuPfothe input neutrino-hypothesis pfo
pTestBeamPfothe input test-beam-hypothesis pfo
testBeamStartVertexthe input position of the test beam start-position vertex
Returns
status code

Definition at line 102 of file TestBeamParticleCreationAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_daughterVertexListName

std::string lar_content::TestBeamParticleCreationAlgorithm::m_daughterVertexListName
private

The daughter vertex list name.

Definition at line 55 of file TestBeamParticleCreationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName
protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_parentPfoListName

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentPfoListName
private

The parent pfo list name.

Definition at line 50 of file TestBeamParticleCreationAlgorithm.h.

◆ m_parentVertexListName

std::string lar_content::TestBeamParticleCreationAlgorithm::m_parentVertexListName
private

The parent vertex list name.

Definition at line 54 of file TestBeamParticleCreationAlgorithm.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::TestBeamParticleCreationAlgorithm::m_showerPfoListName
private

The shower pfo list name.

Definition at line 52 of file TestBeamParticleCreationAlgorithm.h.

◆ m_trackPfoListName

std::string lar_content::TestBeamParticleCreationAlgorithm::m_trackPfoListName
private

The track pfo list name.

Definition at line 51 of file TestBeamParticleCreationAlgorithm.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: