MvaPfoCharacterisationAlgorithm class. More...

#include "MvaPfoCharacterisationAlgorithm.h"

Inheritance diagram for lar_content::MvaPfoCharacterisationAlgorithm< T >:

[legend]

Collaboration diagram for lar_content::MvaPfoCharacterisationAlgorithm< T >:

[legend]

Public Member Functions
	MvaPfoCharacterisationAlgorithm ()
	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 bool	IsClearTrack (const pandora::ParticleFlowObject *const pPfo) const
	Whether pfo is identified as a clear track.

virtual bool	IsClearTrack (const pandora::Cluster *const pCluster) const
	Whether cluster is identified as a clear track.

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

pandora::StatusCode	Run ()
	Run the algorithm.

virtual bool	IsClearTrack3x2D (const pandora::ParticleFlowObject *const pPfo) const
	Whether pfo is identified as a clear track using its three clusters.

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
ClusterCharacterisationFeatureTool::FeatureToolMap	m_featureToolMap
	The feature tool map.

PfoCharacterisationFeatureTool::FeatureToolMap	m_featureToolMapThreeD
	FeatureToolMap as a map for 3D info.

PfoCharacterisationFeatureTool::FeatureToolMap	m_featureToolMapNoChargeInfo
	FeatureToolMap as a map for missing W view.

pandora::StringVector	m_algorithmToolNames
	Vector of strings saving feature tool order for use in feature calculation.

pandora::StringVector	m_algorithmToolNamesNoChargeInfo
	Vector of strings saving feature tool order for use in feature calculation (missing W view)

T	m_mva
	The mva.

T	m_mvaNoChargeInfo
	The mva for missing W view.

bool	m_persistFeatures
	Whether to write the features to the properties map.

bool	m_trainingSetMode
	Whether to train.

bool	m_testBeamMode
	Whether the training set is from a test beam experiment.

bool	m_enableProbability
	Whether to use probabilities instead of binary classification.

bool	m_useThreeDInformation
	Whether to use 3D information.

float	m_minProbabilityCut
	The minimum probability to label a cluster as track-like.

unsigned int	m_minCaloHitsCut
	The minimum number of calo hits to qualify as a track.

bool	m_applyFiducialCut
	Whether to apply a fiducial volume cut during training.

float	m_fiducialMinX
	Fiducial volume minimum x.

float	m_fiducialMaxX
	Fiducial volume maximum x.

float	m_fiducialMinY
	Fiducial volume minimum y.

float	m_fiducialMaxY
	Fiducial volume maximum y.

float	m_fiducialMinZ
	Fiducial volume minimum z.

float	m_fiducialMaxZ
	Fiducial volume maximum z.

bool	m_applyReconstructabilityChecks
	Whether to apply reconstructability checks during training.

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

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

std::string	m_trainingOutputFile
	The training output file.

std::string	m_filePathEnvironmentVariable
	The environment variable providing a list of paths to mva files.

std::string	m_mvaFileName
	The mva input file.

std::string	m_mvaName
	The name of the mva to find.

std::string	m_mvaFileNameNoChargeInfo
	The mva input file for PFOs missing the W view, and thus charge info.

std::string	m_mvaNameNoChargeInfo
	The name of the mva to find for PFOs missing the W view, and thus charge info.

LArMCParticleHelper::PrimaryParameters	m_primaryParameters
	The mc particle primary selection parameters.

std::string	m_trackPfoListName
	The track pfo list name.

std::string	m_showerPfoListName
	The shower pfo list name.

pandora::StringVector	m_inputPfoListNames
	The names of the input pfo lists.

bool	m_updateClusterIds
	Whether to update daughter cluster particle id labels to match pfo id.

bool	m_postBranchAddition
	Whether to use configuration for shower clusters post branch addition.

unsigned int	m_minTrackLikeViews
	The minimum number of track-like views to declare a pfo as track-like.

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
bool	PassesFiducialCut (const pandora::CartesianVector &vertex) const
	Checks if the interaction vertex is within the fiducial volume.

Detailed Description

template<typename T>
class lar_content::MvaPfoCharacterisationAlgorithm< T >

MvaPfoCharacterisationAlgorithm class.

Definition at line 28 of file MvaPfoCharacterisationAlgorithm.h.

Constructor & Destructor Documentation

◆ MvaPfoCharacterisationAlgorithm()

template<typename T >

lar_content::MvaPfoCharacterisationAlgorithm< T >::MvaPfoCharacterisationAlgorithm ( )

Default constructor.

Definition at line 24 of file MvaPfoCharacterisationAlgorithm.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:

◆ IsClearTrack() [1/2]

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::IsClearTrack ( const pandora::Cluster *const pCluster ) const

protectedvirtual

Whether cluster is identified as a clear track.

Parameters

pCluster address of the relevant cluster

Returns: boolean

Implements lar_content::PfoCharacterisationBaseAlgorithm.

Definition at line 47 of file MvaPfoCharacterisationAlgorithm.cc.

Here is the call graph for this function:

◆ IsClearTrack() [2/2]

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::IsClearTrack ( const pandora::ParticleFlowObject *const pPfo ) const

protectedvirtual

Whether pfo is identified as a clear track.

Parameters

pPfo	address of the relevant pfo

Returns: boolean

Implements lar_content::PfoCharacterisationBaseAlgorithm.

Definition at line 85 of file MvaPfoCharacterisationAlgorithm.cc.

Here is the call graph for this function:

◆ IsClearTrack3x2D()

bool lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack3x2D ( const pandora::ParticleFlowObject *const pPfo ) const

protectedvirtualinherited

Whether pfo is identified as a clear track using its three clusters.

Parameters

pPfo	address of the relevant pfo

Returns: boolean

Definition at line 108 of file PfoCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PassesFiducialCut()

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::PassesFiducialCut ( const pandora::CartesianVector & vertex ) const

private

Checks if the interaction vertex is within the fiducial volume.

Parameters

vertex The coordinates of the vertex

Definition at line 433 of file MvaPfoCharacterisationAlgorithm.cc.

Here is the call graph for this function:

◆ ReadSettings()

template<typename T >

StatusCode lar_content::MvaPfoCharacterisationAlgorithm< T >::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 290 of file MvaPfoCharacterisationAlgorithm.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::PfoCharacterisationBaseAlgorithm::Run ( )

protectedvirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 39 of file PfoCharacterisationBaseAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_algorithmToolNames

template<typename T >

pandora::StringVector lar_content::MvaPfoCharacterisationAlgorithm< T >::m_algorithmToolNames

protected

Vector of strings saving feature tool order for use in feature calculation.

Definition at line 46 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_algorithmToolNamesNoChargeInfo

template<typename T >

pandora::StringVector lar_content::MvaPfoCharacterisationAlgorithm< T >::m_algorithmToolNamesNoChargeInfo

protected

Vector of strings saving feature tool order for use in feature calculation (missing W view)

Definition at line 47 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_applyFiducialCut

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_applyFiducialCut

protected

Whether to apply a fiducial volume cut during training.

Definition at line 59 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_applyReconstructabilityChecks

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_applyReconstructabilityChecks

protected

Whether to apply reconstructability checks during training.

Definition at line 66 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_caloHitListName

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_caloHitListName

protected

Name of input calo hit list.

Definition at line 68 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_enableProbability

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_enableProbability

protected

Whether to use probabilities instead of binary classification.

Definition at line 55 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_featureToolMap

template<typename T >

ClusterCharacterisationFeatureTool::FeatureToolMap lar_content::MvaPfoCharacterisationAlgorithm< T >::m_featureToolMap

protected

The feature tool map.

Definition at line 41 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_featureToolMapNoChargeInfo

template<typename T >

PfoCharacterisationFeatureTool::FeatureToolMap lar_content::MvaPfoCharacterisationAlgorithm< T >::m_featureToolMapNoChargeInfo

protected

FeatureToolMap as a map for missing W view.

Definition at line 44 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_featureToolMapThreeD

template<typename T >

PfoCharacterisationFeatureTool::FeatureToolMap lar_content::MvaPfoCharacterisationAlgorithm< T >::m_featureToolMapThreeD

protected

FeatureToolMap as a map for 3D info.

Definition at line 43 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMaxX

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMaxX

protected

Fiducial volume maximum x.

Definition at line 61 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMaxY

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMaxY

protected

Fiducial volume maximum y.

Definition at line 63 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMaxZ

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMaxZ

protected

Fiducial volume maximum z.

Definition at line 65 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMinX

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMinX

protected

Fiducial volume minimum x.

Definition at line 60 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMinY

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMinY

protected

Fiducial volume minimum y.

Definition at line 62 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_fiducialMinZ

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_fiducialMinZ

protected

Fiducial volume minimum z.

Definition at line 64 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_filePathEnvironmentVariable

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_filePathEnvironmentVariable

protected

The environment variable providing a list of paths to mva files.

Definition at line 72 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_inputPfoListNames

pandora::StringVector lar_content::PfoCharacterisationBaseAlgorithm::m_inputPfoListNames

protectedinherited

The names of the input pfo lists.

Definition at line 66 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_mcParticleListName

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mcParticleListName

protected

Name of input MC particle list.

Definition at line 69 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_minCaloHitsCut

template<typename T >

unsigned int lar_content::MvaPfoCharacterisationAlgorithm< T >::m_minCaloHitsCut

protected

The minimum number of calo hits to qualify as a track.

Definition at line 58 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_minProbabilityCut

template<typename T >

float lar_content::MvaPfoCharacterisationAlgorithm< T >::m_minProbabilityCut

protected

The minimum probability to label a cluster as track-like.

Definition at line 57 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_minTrackLikeViews

unsigned int lar_content::PfoCharacterisationBaseAlgorithm::m_minTrackLikeViews

protectedinherited

The minimum number of track-like views to declare a pfo as track-like.

Definition at line 71 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_mva

template<typename T >

T lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mva

protected

The mva.

Definition at line 49 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_mvaFileName

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mvaFileName

protected

The mva input file.

Definition at line 73 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_mvaFileNameNoChargeInfo

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mvaFileNameNoChargeInfo

protected

The mva input file for PFOs missing the W view, and thus charge info.

Definition at line 75 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_mvaName

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mvaName

protected

The name of the mva to find.

Definition at line 74 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_mvaNameNoChargeInfo

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mvaNameNoChargeInfo

protected

The name of the mva to find for PFOs missing the W view, and thus charge info.

Definition at line 76 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_mvaNoChargeInfo

template<typename T >

T lar_content::MvaPfoCharacterisationAlgorithm< T >::m_mvaNoChargeInfo

protected

The mva for missing W view.

Definition at line 50 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_persistFeatures

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_persistFeatures

protected

Whether to write the features to the properties map.

Definition at line 52 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_postBranchAddition

bool lar_content::PfoCharacterisationBaseAlgorithm::m_postBranchAddition

protectedinherited

Whether to use configuration for shower clusters post branch addition.

Definition at line 69 of file PfoCharacterisationBaseAlgorithm.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_primaryParameters

template<typename T >

LArMCParticleHelper::PrimaryParameters lar_content::MvaPfoCharacterisationAlgorithm< T >::m_primaryParameters

protected

The mc particle primary selection parameters.

Definition at line 78 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_showerPfoListName

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_showerPfoListName

protectedinherited

The shower pfo list name.

Definition at line 65 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_testBeamMode

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_testBeamMode

protected

Whether the training set is from a test beam experiment.

Definition at line 54 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_trackPfoListName

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_trackPfoListName

protectedinherited

The track pfo list name.

Definition at line 64 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_trainingOutputFile

template<typename T >

std::string lar_content::MvaPfoCharacterisationAlgorithm< T >::m_trainingOutputFile

protected

The training output file.

Definition at line 71 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_trainingSetMode

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_trainingSetMode

protected

Whether to train.

Definition at line 53 of file MvaPfoCharacterisationAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_updateClusterIds

bool lar_content::PfoCharacterisationBaseAlgorithm::m_updateClusterIds

protectedinherited

Whether to update daughter cluster particle id labels to match pfo id.

Definition at line 68 of file PfoCharacterisationBaseAlgorithm.h.

◆ m_useThreeDInformation

template<typename T >

bool lar_content::MvaPfoCharacterisationAlgorithm< T >::m_useThreeDInformation

protected

Whether to use 3D information.

Definition at line 56 of file MvaPfoCharacterisationAlgorithm.h.

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

LArContent/larpandoracontent/LArTrackShowerId/MvaPfoCharacterisationAlgorithm.h
LArContent/larpandoracontent/LArTrackShowerId/MvaPfoCharacterisationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MvaPfoCharacterisationAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsClearTrack() [1/2]

◆ IsClearTrack() [2/2]

◆ IsClearTrack3x2D()

◆ PassesFiducialCut()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_algorithmToolNames

◆ m_algorithmToolNamesNoChargeInfo

◆ m_applyFiducialCut

◆ m_applyReconstructabilityChecks

◆ m_caloHitListName

◆ m_enableProbability

◆ m_featureToolMap

◆ m_featureToolMapNoChargeInfo

◆ m_featureToolMapThreeD

◆ m_fiducialMaxX

◆ m_fiducialMaxY

◆ m_fiducialMaxZ

◆ m_fiducialMinX

◆ m_fiducialMinY

◆ m_fiducialMinZ

◆ m_filePathEnvironmentVariable

◆ m_inputPfoListNames

◆ m_instanceName

◆ m_mcParticleListName

◆ m_minCaloHitsCut

◆ m_minProbabilityCut

◆ m_minTrackLikeViews

◆ m_mva

◆ m_mvaFileName

◆ m_mvaFileNameNoChargeInfo

◆ m_mvaName

◆ m_mvaNameNoChargeInfo

◆ m_mvaNoChargeInfo

◆ m_persistFeatures

◆ m_postBranchAddition

◆ m_pPandora

◆ m_primaryParameters

◆ m_showerPfoListName

◆ m_testBeamMode

◆ m_trackPfoListName

◆ m_trainingOutputFile

◆ m_trainingSetMode

◆ m_type

◆ m_updateClusterIds

◆ m_useThreeDInformation