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::CheatingCosmicRayIdentificationAlg Class Reference

CheatingCosmicRayIdentificationAlg class. More...

#include "CheatingCosmicRayIdentificationAlg.h"

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

Public Member Functions

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

std::string m_inputPfoListName
 The input pfo list name.
 
std::string m_outputPfoListName
 The output pfo list name.
 
std::string m_inputDaughterPfoListName
 The input daughter pfo list name (if not specified, will assume same as main input list)
 
std::string m_outputDaughterPfoListName
 The output daughter pfo list name (if not specified, will assume same as main output list)
 
float m_maxNeutrinoFraction
 The maximum true neutrino fraction in a particle to be labelled as a cosmic ray.
 

Detailed Description

CheatingCosmicRayIdentificationAlg class.

Definition at line 19 of file CheatingCosmicRayIdentificationAlg.h.

Constructor & Destructor Documentation

◆ CheatingCosmicRayIdentificationAlg()

lar_content::CheatingCosmicRayIdentificationAlg::CheatingCosmicRayIdentificationAlg ( )

Default constructor.

Definition at line 22 of file CheatingCosmicRayIdentificationAlg.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::CheatingCosmicRayIdentificationAlg::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
privatevirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 73 of file CheatingCosmicRayIdentificationAlg.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::CheatingCosmicRayIdentificationAlg::Run ( )
privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 28 of file CheatingCosmicRayIdentificationAlg.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputDaughterPfoListName

std::string lar_content::CheatingCosmicRayIdentificationAlg::m_inputDaughterPfoListName
private

The input daughter pfo list name (if not specified, will assume same as main input list)

Definition at line 33 of file CheatingCosmicRayIdentificationAlg.h.

◆ m_inputPfoListName

std::string lar_content::CheatingCosmicRayIdentificationAlg::m_inputPfoListName
private

The input pfo list name.

Definition at line 31 of file CheatingCosmicRayIdentificationAlg.h.

◆ m_instanceName

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

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxNeutrinoFraction

float lar_content::CheatingCosmicRayIdentificationAlg::m_maxNeutrinoFraction
private

The maximum true neutrino fraction in a particle to be labelled as a cosmic ray.

Definition at line 35 of file CheatingCosmicRayIdentificationAlg.h.

◆ m_outputDaughterPfoListName

std::string lar_content::CheatingCosmicRayIdentificationAlg::m_outputDaughterPfoListName
private

The output daughter pfo list name (if not specified, will assume same as main output list)

Definition at line 34 of file CheatingCosmicRayIdentificationAlg.h.

◆ m_outputPfoListName

std::string lar_content::CheatingCosmicRayIdentificationAlg::m_outputPfoListName
private

The output pfo list name.

Definition at line 32 of file CheatingCosmicRayIdentificationAlg.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: