#include "CheatingSliceIdBaseTool.h"

Inheritance diagram for lar_content::CheatingSliceIdBaseTool:

[legend]

Collaboration diagram for lar_content::CheatingSliceIdBaseTool:

[legend]

Public Member Functions
virtual void	SelectOutputPfos (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses, const SliceHypotheses &crSliceHypotheses, pandora::PfoList &selectedPfos)=0
	Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice.

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.

Static Public Member Functions
static void	GetTargetParticleWeight (const pandora::PfoList const pPfoList, float &targetParticleWeight, float &totalWeight, std::function< bool(const pandora::MCParticle const)> fCriteria)
	Get the target particle weight in a list of pfos.

static void	GetTargetParticleWeight (const pandora::CaloHit const pCaloHit, float &targetParticleWeight, float &totalWeight, std::function< bool(const pandora::MCParticle const)> fCriteria)
	Get the target particle weight for a calo hit.

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	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

Detailed Description

CheatingSliceIdBaseTool class.

Definition at line 21 of file CheatingSliceIdBaseTool.h.

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.

◆ GetTargetParticleWeight() [1/2]

static void lar_content::CheatingSliceIdBaseTool::GetTargetParticleWeight	(	const pandora::CaloHit *const	pCaloHit,
		float &	targetParticleWeight,
		float &	totalWeight,
		std::function< bool(const pandora::MCParticle *const)>	fCriteria
	)

static

Get the target particle weight for a calo hit.

Parameters

pCaloHit	address of the calo hit
targetParticleWeight	the target particle weight
totalWeight	the total weight
fCriteria	a function which returns a bool (= shouldSelect) for a given input MCParticle

◆ GetTargetParticleWeight() [2/2]

static void lar_content::CheatingSliceIdBaseTool::GetTargetParticleWeight	(	const pandora::PfoList *const	pPfoList,
		float &	targetParticleWeight,
		float &	totalWeight,
		std::function< bool(const pandora::MCParticle *const)>	fCriteria
	)

static

Get the target particle weight in a list of pfos.

Parameters

pPfoList	address of the pfo list
targetParticleWeight	the target particle weight
totalWeight	the total weight
fCriteria	a function which returns a bool (= shouldSelect) for a given input MCParticle

Here is the caller graph for this function:

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 99 of file CheatingSliceIdBaseTool.cc.

◆ 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:

◆ SelectOutputPfos()

virtual void lar_content::CheatingSliceIdBaseTool::SelectOutputPfos	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceHypotheses &	nuSliceHypotheses,
		const SliceHypotheses &	crSliceHypotheses,
		pandora::PfoList &	selectedPfos
	)

pure virtual

Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice.

Parameters

pAlgorithm	the address of the master instance, used to access MCParticles when in training mode
nuSliceHypotheses	the parent pfos representing the neutrino outcome for each slice
crSliceHypotheses	the parent pfos representing the cosmic-ray muon outcome for each slice
sliceNuPfos	to receive the list of selected pfos

Implements lar_content::SliceIdBaseTool.

Implemented in lar_content::CheatingBeamParticleIdTool, and lar_content::CheatingNeutrinoIdTool.

Member Data Documentation

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.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.

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

LArContent/larpandoracontent/LArCheating/CheatingSliceIdBaseTool.h
LArContent/larpandoracontent/LArCheating/CheatingSliceIdBaseTool.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetTargetParticleWeight() [1/2]

◆ GetTargetParticleWeight() [2/2]

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ SelectOutputPfos()

Member Data Documentation

◆ m_instanceName

◆ m_pPandora

◆ m_type