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

VertexMonitoringAlgorithm class. More...

#include "VertexMonitoringAlgorithm.h"

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

Public Member Functions

 VertexMonitoringAlgorithm ()
 Default constructor.
 
virtual ~VertexMonitoringAlgorithm ()
 
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 AssessVertices () const
 
pandora::StatusCode Run ()
 Run the algorithm.
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 

Private Attributes

bool m_visualise
 
bool m_writeFile
 
std::string m_filename
 
std::string m_treename
 
float m_transparencyThresholdE
 Cell energy for which transparency is saturated (0%, fully opaque)
 
float m_energyScaleThresholdE
 Cell energy for which color is at top end of continous color palette.
 
float m_scalingFactor
 TEve works with [cm], Pandora usually works with [mm] (but LArContent went with cm too)
 

Detailed Description

VertexMonitoringAlgorithm class.

Definition at line 19 of file VertexMonitoringAlgorithm.h.

Constructor & Destructor Documentation

◆ VertexMonitoringAlgorithm()

lar_content::VertexMonitoringAlgorithm::VertexMonitoringAlgorithm ( )

Default constructor.

Definition at line 24 of file VertexMonitoringAlgorithm.cc.

◆ ~VertexMonitoringAlgorithm()

lar_content::VertexMonitoringAlgorithm::~VertexMonitoringAlgorithm ( )
virtual

Definition at line 35 of file VertexMonitoringAlgorithm.cc.

Here is the call graph for this function:

Member Function Documentation

◆ AssessVertices()

StatusCode lar_content::VertexMonitoringAlgorithm::AssessVertices ( ) const
private

Definition at line 65 of file VertexMonitoringAlgorithm.cc.

Here is the call graph for this function:
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::VertexMonitoringAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
privatevirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

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

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 45 of file VertexMonitoringAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_energyScaleThresholdE

float lar_content::VertexMonitoringAlgorithm::m_energyScaleThresholdE
private

Cell energy for which color is at top end of continous color palette.

Definition at line 40 of file VertexMonitoringAlgorithm.h.

◆ m_filename

std::string lar_content::VertexMonitoringAlgorithm::m_filename
private

Definition at line 37 of file VertexMonitoringAlgorithm.h.

◆ 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_scalingFactor

float lar_content::VertexMonitoringAlgorithm::m_scalingFactor
private

TEve works with [cm], Pandora usually works with [mm] (but LArContent went with cm too)

Definition at line 41 of file VertexMonitoringAlgorithm.h.

◆ m_transparencyThresholdE

float lar_content::VertexMonitoringAlgorithm::m_transparencyThresholdE
private

Cell energy for which transparency is saturated (0%, fully opaque)

Definition at line 39 of file VertexMonitoringAlgorithm.h.

◆ m_treename

std::string lar_content::VertexMonitoringAlgorithm::m_treename
private

Definition at line 38 of file VertexMonitoringAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type
protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_visualise

bool lar_content::VertexMonitoringAlgorithm::m_visualise
private

Definition at line 35 of file VertexMonitoringAlgorithm.h.

◆ m_writeFile

bool lar_content::VertexMonitoringAlgorithm::m_writeFile
private

Definition at line 36 of file VertexMonitoringAlgorithm.h.

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