#include "HitCreationBaseTool.h"

Inheritance diagram for lar_content::HitCreationBaseTool:

[legend]

Collaboration diagram for lar_content::HitCreationBaseTool:

[legend]

Public Types
typedef ThreeDHitCreationAlgorithm::ProtoHit	ProtoHit

typedef ThreeDHitCreationAlgorithm::ProtoHitVector	ProtoHitVector

typedef ThreeDHitCreationAlgorithm::TrajectorySample	TrajectorySample

Public Member Functions
	HitCreationBaseTool ()
	Default constructor.

virtual	~HitCreationBaseTool ()
	Destructor.

virtual void	Run (ThreeDHitCreationAlgorithm const pAlgorithm, const pandora::ParticleFlowObject const pPfo, const pandora::CaloHitVector &inputTwoDHits, ProtoHitVector &protoHitVector)=0
	Run the algorithm tool.

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 void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianPointVector &fitPositionList1, const pandora::CartesianPointVector &fitPositionList2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

virtual void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianVector &fitPosition1, const pandora::CartesianVector &fitPosition2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

virtual void	GetBestPosition3D (const pandora::HitType hitType, const pandora::CartesianVector &fitPosition, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view.

virtual 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
double	m_sigmaX2
	The sigmaX squared value, for calculation of chi2 deltaX term.

double	m_chiSquaredCut
	The chi squared cut (accept only values below the cut value)

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

HitCreationBaseTool class.

Definition at line 21 of file HitCreationBaseTool.h.

Member Typedef Documentation

◆ ProtoHit

typedef ThreeDHitCreationAlgorithm::ProtoHit lar_content::HitCreationBaseTool::ProtoHit

Definition at line 24 of file HitCreationBaseTool.h.

◆ ProtoHitVector

typedef ThreeDHitCreationAlgorithm::ProtoHitVector lar_content::HitCreationBaseTool::ProtoHitVector

Definition at line 25 of file HitCreationBaseTool.h.

◆ TrajectorySample

typedef ThreeDHitCreationAlgorithm::TrajectorySample lar_content::HitCreationBaseTool::TrajectorySample

Definition at line 26 of file HitCreationBaseTool.h.

Constructor & Destructor Documentation

◆ HitCreationBaseTool()

lar_content::HitCreationBaseTool::HitCreationBaseTool ( )

Default constructor.

Definition at line 20 of file HitCreationBaseTool.cc.

◆ ~HitCreationBaseTool()

lar_content::HitCreationBaseTool::~HitCreationBaseTool ( )

virtual

Destructor.

Definition at line 26 of file HitCreationBaseTool.cc.

Member Function Documentation

◆ GetBestPosition3D() [1/3]

void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType,
		const pandora::CartesianVector &	fitPosition,
		ProtoHit &	protoHit
	)		const

protectedvirtual

Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view.

Parameters

hitType	the hit type identifying the other view
fitPosition	the candidate sliding fit position in the other view
protoHit	to receive the populated proto hit

Definition at line 112 of file HitCreationBaseTool.cc.

Here is the call graph for this function:

◆ GetBestPosition3D() [2/3]

void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType1,
		const pandora::HitType	hitType2,
		const pandora::CartesianPointVector &	fitPositionList1,
		const pandora::CartesianPointVector &	fitPositionList2,
		ProtoHit &	protoHit
	)		const

protectedvirtual

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPositionList1	the candidate sliding fit position in the first view
fitPositionList2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

Definition at line 32 of file HitCreationBaseTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBestPosition3D() [3/3]

void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType1,
		const pandora::HitType	hitType2,
		const pandora::CartesianVector &	fitPosition1,
		const pandora::CartesianVector &	fitPosition2,
		ProtoHit &	protoHit
	)		const

protectedvirtual

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPosition1	the candidate sliding fit position in the first view
fitPosition2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

Definition at line 73 of file HitCreationBaseTool.cc.

Here is the call 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::HitCreationBaseTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::LongitudinalTrackHitsBaseTool, lar_content::ShowerHitsBaseTool, lar_content::ThreeViewShowerHitsTool, and lar_content::TrackHitsBaseTool.

Definition at line 136 of file HitCreationBaseTool.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:

◆ Run()

virtual void lar_content::HitCreationBaseTool::Run	(	ThreeDHitCreationAlgorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pPfo,
		const pandora::CaloHitVector &	inputTwoDHits,
		ProtoHitVector &	protoHitVector
	)

pure virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
pPfo	the address of the pfo
inputTwoDHits	the vector of input two dimensional hits
protoHitVector	to receive the new three dimensional proto hits

Implemented in lar_content::DeltaRayShowerHitsTool, lar_content::ShowerHitsBaseTool, and lar_content::TrackHitsBaseTool.

Member Data Documentation

◆ m_chiSquaredCut

double lar_content::HitCreationBaseTool::m_chiSquaredCut

protected

The chi squared cut (accept only values below the cut value)

Definition at line 86 of file HitCreationBaseTool.h.

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

double lar_content::HitCreationBaseTool::m_sigmaX2

protected

The sigmaX squared value, for calculation of chi2 deltaX term.

Definition at line 85 of file HitCreationBaseTool.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/LArThreeDReco/LArHitCreation/HitCreationBaseTool.h
LArContent/larpandoracontent/LArThreeDReco/LArHitCreation/HitCreationBaseTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ProtoHit

◆ ProtoHitVector

◆ TrajectorySample

Constructor & Destructor Documentation

◆ HitCreationBaseTool()

◆ ~HitCreationBaseTool()

Member Function Documentation

◆ GetBestPosition3D() [1/3]

◆ GetBestPosition3D() [2/3]

◆ GetBestPosition3D() [3/3]

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_chiSquaredCut

◆ m_instanceName

◆ m_pPandora

◆ m_sigmaX2

◆ m_type