VisualParticleMonitoringAlgorithm class. More...

#include "VisualParticleMonitoringAlgorithm.h"

Inheritance diagram for lar_content::VisualParticleMonitoringAlgorithm:

[legend]

Collaboration diagram for lar_content::VisualParticleMonitoringAlgorithm:

[legend]

Public Member Functions
	VisualParticleMonitoringAlgorithm ()
	Default constructor.

virtual	~VisualParticleMonitoringAlgorithm ()

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_caloHitListName
	Name of input calo hit list.

std::string	m_pfoListName
	Name of input PFO list.

bool	m_visualizeMC
	Whether or not to visualize MC particles.

bool	m_visualizePfo
	Whether or not to visualize PFOs.

bool	m_visualizeSlice
	Whether or not to visualize reconstructed slices.

bool	m_groupMCByPdg
	Whether or not to group MC particles by particle id.

bool	m_showPfoByPid
	Whether or not to colour PFOs by particle id.

bool	m_showPfoMatchedMC
	Whether or not to display the best matched MC particle for a PFO.

bool	m_isTestBeam
	Whether or not this is a test beam experiment.

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

VisualParticleMonitoringAlgorithm class.

Definition at line 21 of file VisualParticleMonitoringAlgorithm.h.

Constructor & Destructor Documentation

◆ VisualParticleMonitoringAlgorithm()

lar_content::VisualParticleMonitoringAlgorithm::VisualParticleMonitoringAlgorithm ( )

Default constructor.

Definition at line 22 of file VisualParticleMonitoringAlgorithm.cc.

◆ ~VisualParticleMonitoringAlgorithm()

lar_content::VisualParticleMonitoringAlgorithm::~VisualParticleMonitoringAlgorithm ( )

virtual

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 474 of file VisualParticleMonitoringAlgorithm.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

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the 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::VisualParticleMonitoringAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 44 of file VisualParticleMonitoringAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_caloHitListName

std::string lar_content::VisualParticleMonitoringAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 102 of file VisualParticleMonitoringAlgorithm.h.

◆ m_energyScaleThresholdE

float lar_content::VisualParticleMonitoringAlgorithm::m_energyScaleThresholdE

private

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

Definition at line 112 of file VisualParticleMonitoringAlgorithm.h.

◆ m_groupMCByPdg

bool lar_content::VisualParticleMonitoringAlgorithm::m_groupMCByPdg

private

Whether or not to group MC particles by particle id.

Definition at line 107 of file VisualParticleMonitoringAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_isTestBeam

bool lar_content::VisualParticleMonitoringAlgorithm::m_isTestBeam

private

Whether or not this is a test beam experiment.

Definition at line 110 of file VisualParticleMonitoringAlgorithm.h.

◆ m_pfoListName

std::string lar_content::VisualParticleMonitoringAlgorithm::m_pfoListName

private

Name of input PFO list.

Definition at line 103 of file VisualParticleMonitoringAlgorithm.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::VisualParticleMonitoringAlgorithm::m_scalingFactor

private

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

Definition at line 113 of file VisualParticleMonitoringAlgorithm.h.

◆ m_showPfoByPid

bool lar_content::VisualParticleMonitoringAlgorithm::m_showPfoByPid

private

Whether or not to colour PFOs by particle id.

Definition at line 108 of file VisualParticleMonitoringAlgorithm.h.

◆ m_showPfoMatchedMC

bool lar_content::VisualParticleMonitoringAlgorithm::m_showPfoMatchedMC

private

Whether or not to display the best matched MC particle for a PFO.

Definition at line 109 of file VisualParticleMonitoringAlgorithm.h.

◆ m_transparencyThresholdE

float lar_content::VisualParticleMonitoringAlgorithm::m_transparencyThresholdE

private

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

Definition at line 111 of file VisualParticleMonitoringAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_visualizeMC

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizeMC

private

Whether or not to visualize MC particles.

Definition at line 104 of file VisualParticleMonitoringAlgorithm.h.

◆ m_visualizePfo

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizePfo

private

Whether or not to visualize PFOs.

Definition at line 105 of file VisualParticleMonitoringAlgorithm.h.

◆ m_visualizeSlice

bool lar_content::VisualParticleMonitoringAlgorithm::m_visualizeSlice

private

Whether or not to visualize reconstructed slices.

Definition at line 106 of file VisualParticleMonitoringAlgorithm.h.

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

LArContent/larpandoracontent/LArMonitoring/VisualParticleMonitoringAlgorithm.h
LArContent/larpandoracontent/LArMonitoring/VisualParticleMonitoringAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VisualParticleMonitoringAlgorithm()

◆ ~VisualParticleMonitoringAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_caloHitListName

◆ m_energyScaleThresholdE

◆ m_groupMCByPdg

◆ m_instanceName

◆ m_isTestBeam

◆ m_pfoListName

◆ m_pPandora

◆ m_scalingFactor

◆ m_showPfoByPid

◆ m_showPfoMatchedMC

◆ m_transparencyThresholdE

◆ m_type

◆ m_visualizeMC

◆ m_visualizePfo

◆ m_visualizeSlice