HierarchyValidationAlgorithm class. More...

#include "HierarchyValidationAlgorithm.h"

Inheritance diagram for lar_content::HierarchyValidationAlgorithm:

[legend]

Collaboration diagram for lar_content::HierarchyValidationAlgorithm:

[legend]

Public Member Functions
	HierarchyValidationAlgorithm ()
	Default constructor.

virtual	~HierarchyValidationAlgorithm ()

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
int	m_event
	The current event.

std::string	m_caloHitListName
	Name of input calo hit list.

std::string	m_pfoListName
	Name of input PFO list.

std::string	m_detector
	Name of the detector.

bool	m_writeTree
	Whether or not to output validation information to a ROOT file.

std::string	m_filename
	The name of the ROOT file to write.

std::string	m_treename
	The name of the ROOT tree to write.

bool	m_foldToPrimaries
	Whether or not to fold the hierarchy back to primary particles.

bool	m_foldDynamic
	Whether or not to fold the hierarchy dynamically.

bool	m_foldToLeadingShowers
	Whether or not to fold the hierarchy back to leading shower particles.

bool	m_validateEvent
	Whether to validate at the level of an event.

bool	m_validateMC
	Whether to validate at the level of MC nodes.

float	m_minPurity
	Minimum purity to tag a node as being of good quality.

float	m_minCompleteness
	Minimum completeness to tag a node as being of good quality.

Detailed Description

HierarchyValidationAlgorithm class.

Definition at line 22 of file HierarchyValidationAlgorithm.h.

Constructor & Destructor Documentation

◆ HierarchyValidationAlgorithm()

lar_content::HierarchyValidationAlgorithm::HierarchyValidationAlgorithm ( )

Default constructor.

Definition at line 21 of file HierarchyValidationAlgorithm.cc.

◆ ~HierarchyValidationAlgorithm()

lar_content::HierarchyValidationAlgorithm::~HierarchyValidationAlgorithm ( )

virtual

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 442 of file HierarchyValidationAlgorithm.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::HierarchyValidationAlgorithm::Run ( )

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 47 of file HierarchyValidationAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_caloHitListName

std::string lar_content::HierarchyValidationAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 54 of file HierarchyValidationAlgorithm.h.

◆ m_detector

std::string lar_content::HierarchyValidationAlgorithm::m_detector

private

Name of the detector.

Definition at line 56 of file HierarchyValidationAlgorithm.h.

◆ m_event

int lar_content::HierarchyValidationAlgorithm::m_event

private

The current event.

Definition at line 53 of file HierarchyValidationAlgorithm.h.

◆ m_filename

std::string lar_content::HierarchyValidationAlgorithm::m_filename

private

The name of the ROOT file to write.

Definition at line 58 of file HierarchyValidationAlgorithm.h.

◆ m_foldDynamic

bool lar_content::HierarchyValidationAlgorithm::m_foldDynamic

private

Whether or not to fold the hierarchy dynamically.

Definition at line 61 of file HierarchyValidationAlgorithm.h.

◆ m_foldToLeadingShowers

bool lar_content::HierarchyValidationAlgorithm::m_foldToLeadingShowers

private

Whether or not to fold the hierarchy back to leading shower particles.

Definition at line 62 of file HierarchyValidationAlgorithm.h.

◆ m_foldToPrimaries

bool lar_content::HierarchyValidationAlgorithm::m_foldToPrimaries

private

Whether or not to fold the hierarchy back to primary particles.

Definition at line 60 of file HierarchyValidationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minCompleteness

float lar_content::HierarchyValidationAlgorithm::m_minCompleteness

private

Minimum completeness to tag a node as being of good quality.

Definition at line 66 of file HierarchyValidationAlgorithm.h.

◆ m_minPurity

float lar_content::HierarchyValidationAlgorithm::m_minPurity

private

Minimum purity to tag a node as being of good quality.

Definition at line 65 of file HierarchyValidationAlgorithm.h.

◆ m_pfoListName

std::string lar_content::HierarchyValidationAlgorithm::m_pfoListName

private

Name of input PFO list.

Definition at line 55 of file HierarchyValidationAlgorithm.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_treename

std::string lar_content::HierarchyValidationAlgorithm::m_treename

private

The name of the ROOT tree to write.

Definition at line 59 of file HierarchyValidationAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_validateEvent

bool lar_content::HierarchyValidationAlgorithm::m_validateEvent

private

Whether to validate at the level of an event.

Definition at line 63 of file HierarchyValidationAlgorithm.h.

◆ m_validateMC

bool lar_content::HierarchyValidationAlgorithm::m_validateMC

private

Whether to validate at the level of MC nodes.

Definition at line 64 of file HierarchyValidationAlgorithm.h.

◆ m_writeTree

bool lar_content::HierarchyValidationAlgorithm::m_writeTree

private

Whether or not to output validation information to a ROOT file.

Definition at line 57 of file HierarchyValidationAlgorithm.h.

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

LArContent/larpandoracontent/LArMonitoring/HierarchyValidationAlgorithm.h
LArContent/larpandoracontent/LArMonitoring/HierarchyValidationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HierarchyValidationAlgorithm()

◆ ~HierarchyValidationAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_caloHitListName

◆ m_detector

◆ m_event

◆ m_filename

◆ m_foldDynamic

◆ m_foldToLeadingShowers

◆ m_foldToPrimaries

◆ m_instanceName

◆ m_minCompleteness

◆ m_minPurity

◆ m_pfoListName

◆ m_pPandora

◆ m_treename

◆ m_type

◆ m_validateEvent

◆ m_validateMC

◆ m_writeTree