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

HierarchyMonitoringAlgorithm class. More...

#include "HierarchyMonitoringAlgorithm.h"

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

Public Member Functions

 HierarchyMonitoringAlgorithm ()
 Default constructor.
 
virtual ~HierarchyMonitoringAlgorithm ()
 
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.
 
std::string ToStringSF (const float val, const int sf=3) const
 

Private Attributes

std::string m_caloHitListName
 Name of input calo hit list.
 
std::string m_pfoListName
 Name of input PFO list.
 
std::string m_rootFileName
 Name of the output ROOT file (optional)
 
bool m_visualizeMC
 Whether or not to visualize the MC nodes.
 
bool m_visualizeReco
 Whether or not to visualize the reco nodes.
 
bool m_visualizeDistinct
 If true, allocate colours without consideration of particle id.
 
bool m_visualizeProcess
 If true, allocate colours based on the MC process.
 
bool m_match
 Whether or not to visualize the reco to MC matches.
 
bool m_collectionOnly
 Limit display to the collection plane only.
 
bool m_foldToPrimaries
 Whether or not to fold everything back to primaries.
 
bool m_foldDynamic
 Whether or not to fold based on process information.
 
float m_minPurity
 The minimum purity for a match to be considered good.
 
float m_minCompleteness
 The minimum completeness for a match to be considered good.
 
float m_minMatchCompleteness
 The minimum completeness at which to a PFO should be considered matching at all.
 
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

HierarchyMonitoringAlgorithm class.

Definition at line 22 of file HierarchyMonitoringAlgorithm.h.

Constructor & Destructor Documentation

◆ HierarchyMonitoringAlgorithm()

lar_content::HierarchyMonitoringAlgorithm::HierarchyMonitoringAlgorithm ( )

Default constructor.

Definition at line 18 of file HierarchyMonitoringAlgorithm.cc.

◆ ~HierarchyMonitoringAlgorithm()

lar_content::HierarchyMonitoringAlgorithm::~HierarchyMonitoringAlgorithm ( )
virtual

Definition at line 38 of file HierarchyMonitoringAlgorithm.cc.

Here is the call graph for this function:

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

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

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

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 48 of file HierarchyMonitoringAlgorithm.cc.

Here is the call graph for this function:

◆ ToStringSF()

std::string lar_content::HierarchyMonitoringAlgorithm::ToStringSF ( const float  val,
const int  sf = 3 
) const
private

Definition at line 469 of file HierarchyMonitoringAlgorithm.cc.

Member Data Documentation

◆ m_caloHitListName

std::string lar_content::HierarchyMonitoringAlgorithm::m_caloHitListName
private

Name of input calo hit list.

Definition at line 94 of file HierarchyMonitoringAlgorithm.h.

◆ m_collectionOnly

bool lar_content::HierarchyMonitoringAlgorithm::m_collectionOnly
private

Limit display to the collection plane only.

Definition at line 102 of file HierarchyMonitoringAlgorithm.h.

◆ m_energyScaleThresholdE

float lar_content::HierarchyMonitoringAlgorithm::m_energyScaleThresholdE
private

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

Definition at line 109 of file HierarchyMonitoringAlgorithm.h.

◆ m_foldDynamic

bool lar_content::HierarchyMonitoringAlgorithm::m_foldDynamic
private

Whether or not to fold based on process information.

Definition at line 104 of file HierarchyMonitoringAlgorithm.h.

◆ m_foldToPrimaries

bool lar_content::HierarchyMonitoringAlgorithm::m_foldToPrimaries
private

Whether or not to fold everything back to primaries.

Definition at line 103 of file HierarchyMonitoringAlgorithm.h.

◆ m_instanceName

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

The process instance name.

Definition at line 89 of file Process.h.

◆ m_match

bool lar_content::HierarchyMonitoringAlgorithm::m_match
private

Whether or not to visualize the reco to MC matches.

Definition at line 101 of file HierarchyMonitoringAlgorithm.h.

◆ m_minCompleteness

float lar_content::HierarchyMonitoringAlgorithm::m_minCompleteness
private

The minimum completeness for a match to be considered good.

Definition at line 106 of file HierarchyMonitoringAlgorithm.h.

◆ m_minMatchCompleteness

float lar_content::HierarchyMonitoringAlgorithm::m_minMatchCompleteness
private

The minimum completeness at which to a PFO should be considered matching at all.

Definition at line 107 of file HierarchyMonitoringAlgorithm.h.

◆ m_minPurity

float lar_content::HierarchyMonitoringAlgorithm::m_minPurity
private

The minimum purity for a match to be considered good.

Definition at line 105 of file HierarchyMonitoringAlgorithm.h.

◆ m_pfoListName

std::string lar_content::HierarchyMonitoringAlgorithm::m_pfoListName
private

Name of input PFO list.

Definition at line 95 of file HierarchyMonitoringAlgorithm.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_rootFileName

std::string lar_content::HierarchyMonitoringAlgorithm::m_rootFileName
private

Name of the output ROOT file (optional)

Definition at line 96 of file HierarchyMonitoringAlgorithm.h.

◆ m_scalingFactor

float lar_content::HierarchyMonitoringAlgorithm::m_scalingFactor
private

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

Definition at line 110 of file HierarchyMonitoringAlgorithm.h.

◆ m_transparencyThresholdE

float lar_content::HierarchyMonitoringAlgorithm::m_transparencyThresholdE
private

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

Definition at line 108 of file HierarchyMonitoringAlgorithm.h.

◆ m_type

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

The process type.

Definition at line 88 of file Process.h.

◆ m_visualizeDistinct

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeDistinct
private

If true, allocate colours without consideration of particle id.

Definition at line 99 of file HierarchyMonitoringAlgorithm.h.

◆ m_visualizeMC

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeMC
private

Whether or not to visualize the MC nodes.

Definition at line 97 of file HierarchyMonitoringAlgorithm.h.

◆ m_visualizeProcess

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeProcess
private

If true, allocate colours based on the MC process.

Definition at line 100 of file HierarchyMonitoringAlgorithm.h.

◆ m_visualizeReco

bool lar_content::HierarchyMonitoringAlgorithm::m_visualizeReco
private

Whether or not to visualize the reco nodes.

Definition at line 98 of file HierarchyMonitoringAlgorithm.h.

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