#include "ProtoShowerMatchingTool.h"

Inheritance diagram for lar_content::ProtoShowerMatchingTool:

[legend]

Collaboration diagram for lar_content::ProtoShowerMatchingTool:

[legend]

Public Member Functions
	ProtoShowerMatchingTool ()
	Default constructor.

pandora::StatusCode	Run (const ProtoShowerVector &protoShowerVectorU, const ProtoShowerVector &protoShowerVectorV, const ProtoShowerVector &protoShowerVectorW, ProtoShowerMatchVector &protoShowerMatchVector)

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.

bool	ArePathwaysConsistent (const ProtoShower &protoShowerU, const ProtoShower &protoShowerV, const ProtoShower &protoShowerW, Consistency &consistency) const
	Determine whether three 2D connection pathways form a consistent 3D connection pathway.

bool	AreShowerStartsConsistent (const ProtoShower &protoShowerU, const ProtoShower &protoShowerV, const ProtoShower &protoShowerW) const
	Determine whether three 2D shower start positions correspond to the same 3D shower start position.

bool	AreDirectionsConsistent (const ProtoShower &protoShowerU, const ProtoShower &protoShowerV, const ProtoShower &protoShowerW) const
	Determine whether three 2D initial spine directions correspond to the same 3D initial spine direction.

bool	AreDirectionsConsistent (pandora::CartesianVector directionU, pandora::CartesianVector directionV, pandora::CartesianVector directionW) const
	Determine whether three 2D initial spine directions correspond to the same 3D initial spine direction.

Private Attributes
unsigned int	m_spineSlidingFitWindow
	The shower spine sliding fit window.

float	m_maxXSeparation
	The max. drift-coordinate separation between matched 2D shower start positions.

float	m_maxSeparation
	The max. average separation between true and projected 2D shower start positions for a match.

float	m_maxAngularDeviation
	The max. opening angle between true and projected 2D initial directions for a match.

Detailed Description

Definition at line 19 of file ProtoShowerMatchingTool.h.

Constructor & Destructor Documentation

◆ ProtoShowerMatchingTool()

lar_content::ProtoShowerMatchingTool::ProtoShowerMatchingTool ( )

Default constructor.

Definition at line 25 of file ProtoShowerMatchingTool.cc.

Member Function Documentation

◆ AreDirectionsConsistent() [1/2]

bool lar_content::ProtoShowerMatchingTool::AreDirectionsConsistent	(	const ProtoShower &	protoShowerU,
		const ProtoShower &	protoShowerV,
		const ProtoShower &	protoShowerW
	)		const

private

Determine whether three 2D initial spine directions correspond to the same 3D initial spine direction.

Parameters

protoShowerU	the U view ProtoShower
protoShowerV	the V view ProtoShower
protoShowerW	the W view ProtoShower

Returns: whether three 2D initial spine directions correspond to the same 3D initial spine direction

Definition at line 141 of file ProtoShowerMatchingTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AreDirectionsConsistent() [2/2]

bool lar_content::ProtoShowerMatchingTool::AreDirectionsConsistent	(	pandora::CartesianVector	directionU,
		pandora::CartesianVector	directionV,
		pandora::CartesianVector	directionW
	)		const

private

Determine whether three 2D initial spine directions correspond to the same 3D initial spine direction.

Parameters

directionU	the U view initial spine direction
directionU	the V view initial spine direction
directionU	the W view initial spine direction

Returns: whether three 2D initial spine directions correspond to the same 3D initial spine direction

Definition at line 183 of file ProtoShowerMatchingTool.cc.

Here is the call graph for this function:

◆ ArePathwaysConsistent()

bool lar_content::ProtoShowerMatchingTool::ArePathwaysConsistent	(	const ProtoShower &	protoShowerU,
		const ProtoShower &	protoShowerV,
		const ProtoShower &	protoShowerW,
		Consistency &	consistency
	)		const

private

Determine whether three 2D connection pathways form a consistent 3D connection pathway.

Parameters

protoShowerU	the U view ProtoShower
protoShowerV	the V view ProtoShower
protoShowerW	the W view ProtoShower
consistency	the basis of the match

Returns: whether three 2D connection pathways form a consistent 3D connection pathway

Definition at line 89 of file ProtoShowerMatchingTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AreShowerStartsConsistent()

bool lar_content::ProtoShowerMatchingTool::AreShowerStartsConsistent	(	const ProtoShower &	protoShowerU,
		const ProtoShower &	protoShowerV,
		const ProtoShower &	protoShowerW
	)		const

private

Determine whether three 2D shower start positions correspond to the same 3D shower start position.

Parameters

protoShowerU	the U view ProtoShower
protoShowerV	the V view ProtoShower
protoShowerW	the W view ProtoShower

Returns: whether three 2D shower start positions correspond to the same 3D shower start position

Definition at line 110 of file ProtoShowerMatchingTool.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::ProtoShowerMatchingTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 239 of file ProtoShowerMatchingTool.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::ProtoShowerMatchingTool::Run	(	const ProtoShowerVector &	protoShowerVectorU,
		const ProtoShowerVector &	protoShowerVectorV,
		const ProtoShowerVector &	protoShowerVectorW,
		ProtoShowerMatchVector &	protoShowerMatchVector
	)

Definition at line 35 of file ProtoShowerMatchingTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

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_maxAngularDeviation

float lar_content::ProtoShowerMatchingTool::m_maxAngularDeviation

private

The max. opening angle between true and projected 2D initial directions for a match.

Definition at line 82 of file ProtoShowerMatchingTool.h.

◆ m_maxSeparation

float lar_content::ProtoShowerMatchingTool::m_maxSeparation

private

The max. average separation between true and projected 2D shower start positions for a match.

Definition at line 81 of file ProtoShowerMatchingTool.h.

◆ m_maxXSeparation

float lar_content::ProtoShowerMatchingTool::m_maxXSeparation

private

The max. drift-coordinate separation between matched 2D shower start positions.

Definition at line 80 of file ProtoShowerMatchingTool.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_spineSlidingFitWindow

unsigned int lar_content::ProtoShowerMatchingTool::m_spineSlidingFitWindow

private

The shower spine sliding fit window.

Definition at line 79 of file ProtoShowerMatchingTool.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/LArShowerRefinement/ProtoShowerMatchingTool.h
LArContent/larpandoracontent/LArShowerRefinement/ProtoShowerMatchingTool.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProtoShowerMatchingTool()

Member Function Documentation

◆ AreDirectionsConsistent() [1/2]

◆ AreDirectionsConsistent() [2/2]

◆ ArePathwaysConsistent()

◆ AreShowerStartsConsistent()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxAngularDeviation

◆ m_maxSeparation

◆ m_maxXSeparation

◆ m_pPandora

◆ m_spineSlidingFitWindow

◆ m_type