TwoDLinearFitFeatureTool class for the calculation of variables related to 2d sliding linear fit. More...

#include "TrackShowerIdFeatureTool.h"

Inheritance diagram for lar_content::TwoDLinearFitFeatureTool:

[legend]

Collaboration diagram for lar_content::TwoDLinearFitFeatureTool:

[legend]

Public Types
typedef std::vector< MvaFeatureTool< Ts... > * >	FeatureToolVector

typedef std::map< std::string, MvaFeatureTool< Ts... > * >	FeatureToolMap

Public Member Functions
	TwoDLinearFitFeatureTool ()
	Default constructor.

void	Run (LArMvaHelper::MvaFeatureVector &featureVector, const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster)

void	Run (LArMvaHelper::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, const pandora::Algorithm const pAlgorithm, const pandora::Cluster const pCluster)

virtual void	Run (MvaTypes::MvaFeatureVector &featureVector, Ts... args)=0
	Run the algorithm tool.

virtual void	Run (MvaTypes::MvaFeatureMap &featureMap, pandora::StringVector &featureOrder, const std::string &featureToolName, Ts...)

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

void	CalculateVariablesSlidingLinearFit (const pandora::Cluster *const pCluster, float &straightLineLengthLarge, float &diffWithStraigthLineMean, float &diffWithStraightLineSigma, float &dTdLWidth, float &maxFitGapLength, float &rmsSlidingLinearFit) const
	Calculation of several variables related to sliding linear fit.

Private Attributes
unsigned int	m_slidingLinearFitWindow
	The sliding linear fit window.

unsigned int	m_slidingLinearFitWindowLarge
	The sliding linear fit window - should be large, providing a simple linear fit.

Detailed Description

TwoDLinearFitFeatureTool class for the calculation of variables related to 2d sliding linear fit.

Definition at line 60 of file TrackShowerIdFeatureTool.h.

Member Typedef Documentation

◆ FeatureToolMap

template<typename... Ts>

typedef std::map<std::string, MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolMap

inherited

Definition at line 37 of file LArMvaHelper.h.

◆ FeatureToolVector

template<typename... Ts>

typedef std::vector<MvaFeatureTool<Ts...> *> lar_content::MvaFeatureTool< Ts >::FeatureToolVector

inherited

Definition at line 36 of file LArMvaHelper.h.

Constructor & Destructor Documentation

◆ TwoDLinearFitFeatureTool()

lar_content::TwoDLinearFitFeatureTool::TwoDLinearFitFeatureTool ( )

Default constructor.

Definition at line 88 of file TrackShowerIdFeatureTool.cc.

Member Function Documentation

◆ CalculateVariablesSlidingLinearFit()

void lar_content::TwoDLinearFitFeatureTool::CalculateVariablesSlidingLinearFit	(	const pandora::Cluster *const	pCluster,
		float &	straightLineLengthLarge,
		float &	diffWithStraigthLineMean,
		float &	diffWithStraightLineSigma,
		float &	dTdLWidth,
		float &	maxFitGapLength,
		float &	rmsSlidingLinearFit
	)		const

private

Calculation of several variables related to sliding linear fit.

Parameters

pCluster	the cluster we are characterizing
straightLineLengthLarge	to receive to length reported by the straight line fit
diffWithStraigthLineMean	to receive the difference with straight line mean variable
diffWithStraightLineSigma	to receive the difference with straight line sigma variable
dTdLWidth	to receive the dTdL width variable
maxFitGapLength	to receive the max fit gap length variable
rmsSlidingLinearFit	to receive the RMS from the linear fit

Definition at line 157 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 245 of file TrackShowerIdFeatureTool.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() [1/4]

void lar_content::TwoDLinearFitFeatureTool::Run	(	LArMvaHelper::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster
	)

Definition at line 123 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

◆ Run() [2/4]

void lar_content::TwoDLinearFitFeatureTool::Run	(	LArMvaHelper::MvaFeatureVector &	featureVector,
		const pandora::Algorithm *const	pAlgorithm,
		const pandora::Cluster *const	pCluster
	)

Definition at line 94 of file TrackShowerIdFeatureTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run() [3/4]

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run	(	MvaTypes::MvaFeatureMap &	featureMap,
		pandora::StringVector &	featureOrder,
		const std::string &	featureToolName,
		Ts...
	)

inlinevirtualinherited

Definition at line 51 of file LArMvaHelper.h.

◆ Run() [4/4]

template<typename... Ts>

virtual void lar_content::MvaFeatureTool< Ts >::Run	(	MvaTypes::MvaFeatureVector &	featureVector,
		Ts...	args
	)

pure virtualinherited

Run the algorithm tool.

Parameters

featureVector	the vector of features to append
args	arguments to pass to the tool

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_slidingLinearFitWindow

unsigned int lar_content::TwoDLinearFitFeatureTool::m_slidingLinearFitWindow

private

The sliding linear fit window.

Definition at line 89 of file TrackShowerIdFeatureTool.h.

◆ m_slidingLinearFitWindowLarge

unsigned int lar_content::TwoDLinearFitFeatureTool::m_slidingLinearFitWindowLarge

private

The sliding linear fit window - should be large, providing a simple linear fit.

Definition at line 90 of file TrackShowerIdFeatureTool.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/LArTrackShowerId/TrackShowerIdFeatureTool.h
LArContent/larpandoracontent/LArTrackShowerId/TrackShowerIdFeatureTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FeatureToolMap

◆ FeatureToolVector

Constructor & Destructor Documentation

◆ TwoDLinearFitFeatureTool()

Member Function Documentation

◆ CalculateVariablesSlidingLinearFit()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run() [1/4]

◆ Run() [2/4]

◆ Run() [3/4]

◆ Run() [4/4]

Member Data Documentation

◆ m_instanceName

◆ m_pPandora

◆ m_slidingLinearFitWindow

◆ m_slidingLinearFitWindowLarge

◆ m_type