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

VisualMonitoringAlgorithm class. More...

#include "VisualMonitoringAlgorithm.h"

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

Public Member Functions

 VisualMonitoringAlgorithm ()
 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 Types

typedef std::map< int, float > PdgCodeToEnergyMap
 

Private Member Functions

pandora::StatusCode Run ()
 Run the algorithm.
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
void VisualizeMCParticleList (const std::string &listName) const
 Visualize mc particle list.
 
void VisualizeCaloHitList (const std::string &listName) const
 Visualize a specified calo hit list.
 
void VisualizeTrackList (const std::string &listName) const
 Visualize a specified track list.
 
void VisualizeClusterList (const std::string &listName) const
 Visualize a specified calo hit list.
 
void VisualizeParticleFlowList (const std::string &listName) const
 Visualize a specified pfo list.
 
void VisualizeVertexList (const std::string &listName) const
 Visualize a specified vertex list.
 

Private Attributes

bool m_showCurrentMCParticles
 Whether to show current mc particles.
 
pandora::StringVector m_mcParticleListNames
 Names of mc particles lists to show.
 
bool m_showCurrentCaloHits
 Whether to show current calohitlist.
 
pandora::StringVector m_caloHitListNames
 Names of calo hit lists to show.
 
bool m_showCurrentTracks
 Whether to show current tracks.
 
pandora::StringVector m_trackListNames
 Names of track lists to show.
 
bool m_showCurrentClusters
 Whether to show current clusters.
 
pandora::StringVector m_clusterListNames
 Names of cluster lists to show.
 
bool m_showCurrentPfos
 Whether to show current particle flow object list.
 
pandora::StringVector m_pfoListNames
 Names of pfo lists to show.
 
bool m_showCurrentVertices
 Whether to show current vertex list.
 
pandora::StringVector m_vertexListNames
 Names of vertex lists to show.
 
bool m_displayEvent
 Whether to display the event.
 
std::string m_saveEventPath
 The path to save event displays to. m_displayEvent must also be set.
 
bool m_showDetector
 Whether to display the detector geometry.
 
std::string m_detectorView
 The detector view, default, xy or xz.
 
bool m_showOnlyAvailable
 Whether to show only available (i.e. non-clustered) calohits and tracks.
 
bool m_showAssociatedTracks
 Whether to display tracks associated to clusters when viewing cluster lists.
 
std::string m_hitColors
 Define the hit coloring scheme (default: pfo, choices: pfo, particleid)
 
float m_thresholdEnergy
 Cell energy threshold for display (em scale)
 
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)
 
bool m_showPfoVertices
 Whether to display pfo vertices.
 
bool m_showPfoHierarchy
 Whether to display daughter pfos only under parent pfo elements.
 
pandora::StringVector m_suppressMCParticles
 List of PDG numbers and energies for MC particles to be suppressed (e.g. " 22:0.1 2112:1.0 ")
 
PdgCodeToEnergyMap m_particleSuppressionMap
 Map from pdg-codes to energy for suppression of particles types below specific energies.
 

Detailed Description

VisualMonitoringAlgorithm class.

Definition at line 19 of file VisualMonitoringAlgorithm.h.

Member Typedef Documentation

◆ PdgCodeToEnergyMap

typedef std::map<int, float> lar_content::VisualMonitoringAlgorithm::PdgCodeToEnergyMap
private

Definition at line 73 of file VisualMonitoringAlgorithm.h.

Constructor & Destructor Documentation

◆ VisualMonitoringAlgorithm()

lar_content::VisualMonitoringAlgorithm::VisualMonitoringAlgorithm ( )

Default constructor.

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

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

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

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 43 of file VisualMonitoringAlgorithm.cc.

Here is the call graph for this function:

◆ VisualizeCaloHitList()

void lar_content::VisualMonitoringAlgorithm::VisualizeCaloHitList ( const std::string &  listName) const
private

Visualize a specified calo hit list.

Parameters
listNamethe list name

Definition at line 166 of file VisualMonitoringAlgorithm.cc.

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

◆ VisualizeClusterList()

void lar_content::VisualMonitoringAlgorithm::VisualizeClusterList ( const std::string &  listName) const
private

Visualize a specified calo hit list.

Parameters
listNamethe list name

Definition at line 247 of file VisualMonitoringAlgorithm.cc.

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

◆ VisualizeMCParticleList()

void lar_content::VisualMonitoringAlgorithm::VisualizeMCParticleList ( const std::string &  listName) const
private

Visualize mc particle list.

Parameters
listNamethe list name

Definition at line 137 of file VisualMonitoringAlgorithm.cc.

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

◆ VisualizeParticleFlowList()

void lar_content::VisualMonitoringAlgorithm::VisualizeParticleFlowList ( const std::string &  listName) const
private

Visualize a specified pfo list.

Parameters
listNamethe list name

Definition at line 290 of file VisualMonitoringAlgorithm.cc.

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

◆ VisualizeTrackList()

void lar_content::VisualMonitoringAlgorithm::VisualizeTrackList ( const std::string &  listName) const
private

Visualize a specified track list.

Parameters
listNamethe list name

Definition at line 208 of file VisualMonitoringAlgorithm.cc.

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

◆ VisualizeVertexList()

void lar_content::VisualMonitoringAlgorithm::VisualizeVertexList ( const std::string &  listName) const
private

Visualize a specified vertex list.

Parameters
listNamethe list name

Definition at line 322 of file VisualMonitoringAlgorithm.cc.

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

Member Data Documentation

◆ m_caloHitListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_caloHitListNames
private

Names of calo hit lists to show.

Definition at line 79 of file VisualMonitoringAlgorithm.h.

◆ m_clusterListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_clusterListNames
private

Names of cluster lists to show.

Definition at line 85 of file VisualMonitoringAlgorithm.h.

◆ m_detectorView

std::string lar_content::VisualMonitoringAlgorithm::m_detectorView
private

The detector view, default, xy or xz.

Definition at line 96 of file VisualMonitoringAlgorithm.h.

◆ m_displayEvent

bool lar_content::VisualMonitoringAlgorithm::m_displayEvent
private

Whether to display the event.

Definition at line 93 of file VisualMonitoringAlgorithm.h.

◆ m_energyScaleThresholdE

float lar_content::VisualMonitoringAlgorithm::m_energyScaleThresholdE
private

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

Definition at line 103 of file VisualMonitoringAlgorithm.h.

◆ m_hitColors

std::string lar_content::VisualMonitoringAlgorithm::m_hitColors
private

Define the hit coloring scheme (default: pfo, choices: pfo, particleid)

Definition at line 100 of file VisualMonitoringAlgorithm.h.

◆ m_instanceName

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

The process instance name.

Definition at line 89 of file Process.h.

◆ m_mcParticleListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_mcParticleListNames
private

Names of mc particles lists to show.

Definition at line 76 of file VisualMonitoringAlgorithm.h.

◆ m_particleSuppressionMap

PdgCodeToEnergyMap lar_content::VisualMonitoringAlgorithm::m_particleSuppressionMap
private

Map from pdg-codes to energy for suppression of particles types below specific energies.

Definition at line 110 of file VisualMonitoringAlgorithm.h.

◆ m_pfoListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_pfoListNames
private

Names of pfo lists to show.

Definition at line 88 of file VisualMonitoringAlgorithm.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_saveEventPath

std::string lar_content::VisualMonitoringAlgorithm::m_saveEventPath
private

The path to save event displays to. m_displayEvent must also be set.

Definition at line 94 of file VisualMonitoringAlgorithm.h.

◆ m_scalingFactor

float lar_content::VisualMonitoringAlgorithm::m_scalingFactor
private

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

Definition at line 104 of file VisualMonitoringAlgorithm.h.

◆ m_showAssociatedTracks

bool lar_content::VisualMonitoringAlgorithm::m_showAssociatedTracks
private

Whether to display tracks associated to clusters when viewing cluster lists.

Definition at line 99 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentCaloHits

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentCaloHits
private

Whether to show current calohitlist.

Definition at line 78 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentClusters

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentClusters
private

Whether to show current clusters.

Definition at line 84 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentMCParticles

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentMCParticles
private

Whether to show current mc particles.

Definition at line 75 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentPfos

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentPfos
private

Whether to show current particle flow object list.

Definition at line 87 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentTracks

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentTracks
private

Whether to show current tracks.

Definition at line 81 of file VisualMonitoringAlgorithm.h.

◆ m_showCurrentVertices

bool lar_content::VisualMonitoringAlgorithm::m_showCurrentVertices
private

Whether to show current vertex list.

Definition at line 90 of file VisualMonitoringAlgorithm.h.

◆ m_showDetector

bool lar_content::VisualMonitoringAlgorithm::m_showDetector
private

Whether to display the detector geometry.

Definition at line 95 of file VisualMonitoringAlgorithm.h.

◆ m_showOnlyAvailable

bool lar_content::VisualMonitoringAlgorithm::m_showOnlyAvailable
private

Whether to show only available (i.e. non-clustered) calohits and tracks.

Definition at line 98 of file VisualMonitoringAlgorithm.h.

◆ m_showPfoHierarchy

bool lar_content::VisualMonitoringAlgorithm::m_showPfoHierarchy
private

Whether to display daughter pfos only under parent pfo elements.

Definition at line 107 of file VisualMonitoringAlgorithm.h.

◆ m_showPfoVertices

bool lar_content::VisualMonitoringAlgorithm::m_showPfoVertices
private

Whether to display pfo vertices.

Definition at line 106 of file VisualMonitoringAlgorithm.h.

◆ m_suppressMCParticles

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_suppressMCParticles
private

List of PDG numbers and energies for MC particles to be suppressed (e.g. " 22:0.1 2112:1.0 ")

Definition at line 109 of file VisualMonitoringAlgorithm.h.

◆ m_thresholdEnergy

float lar_content::VisualMonitoringAlgorithm::m_thresholdEnergy
private

Cell energy threshold for display (em scale)

Definition at line 101 of file VisualMonitoringAlgorithm.h.

◆ m_trackListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_trackListNames
private

Names of track lists to show.

Definition at line 82 of file VisualMonitoringAlgorithm.h.

◆ m_transparencyThresholdE

float lar_content::VisualMonitoringAlgorithm::m_transparencyThresholdE
private

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

Definition at line 102 of file VisualMonitoringAlgorithm.h.

◆ m_type

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

The process type.

Definition at line 88 of file Process.h.

◆ m_vertexListNames

pandora::StringVector lar_content::VisualMonitoringAlgorithm::m_vertexListNames
private

Names of vertex lists to show.

Definition at line 91 of file VisualMonitoringAlgorithm.h.

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