CheatingSliceSelectionTool class. More...

#include "CheatingSliceSelectionTool.h"

Inheritance diagram for lar_content::CheatingSliceSelectionTool:

[legend]

Collaboration diagram for lar_content::CheatingSliceSelectionTool:

[legend]

Public Types
typedef std::map< float, int, std::greater< float > >	MetricSliceIndexMap

Public Member Functions
	CheatingSliceSelectionTool ()
	Default constructor.

void	SelectSlices (const pandora::Algorithm *const pAlgorithm, const SliceVector &inputSliceVector, SliceVector &outputSliceVector)
	Select which slice(s) to use.

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 bool	IsTarget (const pandora::MCParticle *const mcParticle) const =0
	Template method to determine if an MC particle matches the target criteria for slice selection. Return true if match.

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

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
int	m_maxSlices
	The maximum number of slices to retain (0 to retain all) - default 0.

float	m_threshold
	The minimum cut threshold to retain a slice (< 0 for no threshold) - default -1.

std::string	m_cutVariable
	The variable to cut on ("purity" or "completeness") - default "completeness".

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.

Detailed Description

CheatingSliceSelectionTool class.

Definition at line 19 of file CheatingSliceSelectionTool.h.

Member Typedef Documentation

◆ MetricSliceIndexMap

typedef std::map<float, int, std::greater<float> > lar_content::CheatingSliceSelectionTool::MetricSliceIndexMap

Definition at line 36 of file CheatingSliceSelectionTool.h.

Constructor & Destructor Documentation

◆ CheatingSliceSelectionTool()

lar_content::CheatingSliceSelectionTool::CheatingSliceSelectionTool ( )

Default constructor.

Definition at line 20 of file CheatingSliceSelectionTool.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:

◆ IsTarget()

virtual bool lar_content::CheatingSliceSelectionTool::IsTarget ( const pandora::MCParticle *const mcParticle ) const

protectedpure virtual

Template method to determine if an MC particle matches the target criteria for slice selection. Return true if match.

Parameters

mcParticle the MC particle to check

Implemented in lar_content::CheatingBeamParticleSliceSelectionTool, and lar_content::CheatingNeutrinoSliceSelectionTool.

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 122 of file CheatingSliceSelectionTool.cc.

Here is the call graph for this function:

Here is the caller 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:

◆ SelectSlices()

void lar_content::CheatingSliceSelectionTool::SelectSlices	(	const pandora::Algorithm *const	pAlgorithm,
		const SliceVector &	inputSliceVector,
		SliceVector &	outputSliceVector
	)

virtual

Select which slice(s) to use.

Parameters

pAlgorithm	the address of the master instance, used to access MCParticles when in training mode
inputSliceVector	the initial slice vector
outputSliceVector	the output slice vector

Implements lar_content::SliceSelectionBaseTool.

Definition at line 26 of file CheatingSliceSelectionTool.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_cutVariable

std::string lar_content::CheatingSliceSelectionTool::m_cutVariable

protected

The variable to cut on ("purity" or "completeness") - default "completeness".

Definition at line 51 of file CheatingSliceSelectionTool.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxSlices

int lar_content::CheatingSliceSelectionTool::m_maxSlices

protected

The maximum number of slices to retain (0 to retain all) - default 0.

Definition at line 49 of file CheatingSliceSelectionTool.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_threshold

float lar_content::CheatingSliceSelectionTool::m_threshold

protected

The minimum cut threshold to retain a slice (< 0 for no threshold) - default -1.

Definition at line 50 of file CheatingSliceSelectionTool.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/CheatingSliceSelectionTool.h
LArContent/larpandoracontent/LArCheating/CheatingSliceSelectionTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MetricSliceIndexMap

Constructor & Destructor Documentation

◆ CheatingSliceSelectionTool()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsTarget()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ SelectSlices()

Member Data Documentation

◆ m_cutVariable

◆ m_instanceName

◆ m_maxSlices

◆ m_pPandora

◆ m_threshold

◆ m_type