MCParticleMonitoringAlgorithm class. More...

#include "MCParticleMonitoringAlgorithm.h"

Inheritance diagram for lar_content::MCParticleMonitoringAlgorithm:

[legend]

Collaboration diagram for lar_content::MCParticleMonitoringAlgorithm:

[legend]

Public Member Functions
	MCParticleMonitoringAlgorithm ()
	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 Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

void	PrintPrimaryMCParticles (const LArMCParticleHelper::MCContributionMap &mcContributionMap) const
	Extract details of each mc primary in a given mc contribution map.

void	PrintMCParticle (const pandora::MCParticle *const pMCParticle, const LArMCParticleHelper::MCContributionMap &mcToTrueHitListMap, const int depth) const
	Print information for a given mc particle to screen.

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

std::string	m_mcParticleListName
	Name of input MC particle list.

bool	m_useTrueNeutrinosOnly
	Whether to consider only mc particles that were neutrino induced.

unsigned int	m_minHitsForDisplay
	Min hits associated with mc particle to warrant display to terminal.

Detailed Description

MCParticleMonitoringAlgorithm class.

Definition at line 21 of file MCParticleMonitoringAlgorithm.h.

Constructor & Destructor Documentation

◆ MCParticleMonitoringAlgorithm()

lar_content::MCParticleMonitoringAlgorithm::MCParticleMonitoringAlgorithm ( )

Default constructor.

Definition at line 26 of file MCParticleMonitoringAlgorithm.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:

◆ PrintMCParticle()

void lar_content::MCParticleMonitoringAlgorithm::PrintMCParticle	(	const pandora::MCParticle *const	pMCParticle,
		const LArMCParticleHelper::MCContributionMap &	mcToTrueHitListMap,
		const int	depth
	)		const

private

Print information for a given mc particle to screen.

Parameters

pMCParticle	the address of the mc particle
mcToTrueHitListMap	the mc to true hit list map
depth	the depth in the mc particle decay hierarchy

Definition at line 116 of file MCParticleMonitoringAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintPrimaryMCParticles()

void lar_content::MCParticleMonitoringAlgorithm::PrintPrimaryMCParticles ( const LArMCParticleHelper::MCContributionMap & mcContributionMap ) const

private

Extract details of each mc primary in a given mc contribution map.

Parameters

mcContributionMap the mc contribution map

Definition at line 83 of file MCParticleMonitoringAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

StatusCode lar_content::MCParticleMonitoringAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 32 of file MCParticleMonitoringAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_caloHitListName

std::string lar_content::MCParticleMonitoringAlgorithm::m_caloHitListName

private

Name of input calo hit list.

Definition at line 50 of file MCParticleMonitoringAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_mcParticleListName

std::string lar_content::MCParticleMonitoringAlgorithm::m_mcParticleListName

private

Name of input MC particle list.

Definition at line 51 of file MCParticleMonitoringAlgorithm.h.

◆ m_minHitsForDisplay

unsigned int lar_content::MCParticleMonitoringAlgorithm::m_minHitsForDisplay

private

Min hits associated with mc particle to warrant display to terminal.

Definition at line 54 of file MCParticleMonitoringAlgorithm.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_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_useTrueNeutrinosOnly

bool lar_content::MCParticleMonitoringAlgorithm::m_useTrueNeutrinosOnly

private

Whether to consider only mc particles that were neutrino induced.

Definition at line 53 of file MCParticleMonitoringAlgorithm.h.

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

LArContent/larpandoracontent/LArMonitoring/MCParticleMonitoringAlgorithm.h
LArContent/larpandoracontent/LArMonitoring/MCParticleMonitoringAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MCParticleMonitoringAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ PrintMCParticle()

◆ PrintPrimaryMCParticles()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_caloHitListName

◆ m_instanceName

◆ m_mcParticleListName

◆ m_minHitsForDisplay

◆ m_pPandora

◆ m_type

◆ m_useTrueNeutrinosOnly