#include "BranchAssociatedPfosTool.h"

Inheritance diagram for lar_content::BranchAssociatedPfosTool:

[legend]

Collaboration diagram for lar_content::BranchAssociatedPfosTool:

[legend]

Public Member Functions
	BranchAssociatedPfosTool ()
	Default constructor.

void	Run (const NeutrinoHierarchyAlgorithm const pAlgorithm, const pandora::Vertex const pNeutrinoVertex, NeutrinoHierarchyAlgorithm::PfoInfoMap &pfoInfoMap)
	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 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.

Private Attributes
float	m_minNeutrinoVertexDistance
	Branch association: min distance from branch vertex to neutrino vertex.

float	m_trackBranchAdditionFraction
	Branch association: min fraction of length along parent track before association allowed.

float	m_maxParentClusterDistance
	Branch association: max distance from branch vertex to a hit in parent 3D cluster.

Detailed Description

BranchAssociatedPfosTool class.

Definition at line 19 of file BranchAssociatedPfosTool.h.

Constructor & Destructor Documentation

◆ BranchAssociatedPfosTool()

lar_content::BranchAssociatedPfosTool::BranchAssociatedPfosTool ( )

Default constructor.

Definition at line 27 of file BranchAssociatedPfosTool.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:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 105 of file BranchAssociatedPfosTool.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()

void lar_content::BranchAssociatedPfosTool::Run	(	const NeutrinoHierarchyAlgorithm *const	pAlgorithm,
		const pandora::Vertex *const	pNeutrinoVertex,
		NeutrinoHierarchyAlgorithm::PfoInfoMap &	pfoInfoMap
	)

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
pNeutrinoVertex	the address of the three dimensional neutrino interaction vertex
pfoInfoMap	mapping from pfos to three dimensional clusters, sliding fits, vertices, etc.

Implements lar_content::PfoRelationTool.

Definition at line 36 of file BranchAssociatedPfosTool.cc.

Here is the call 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_maxParentClusterDistance

float lar_content::BranchAssociatedPfosTool::m_maxParentClusterDistance

private

Branch association: max distance from branch vertex to a hit in parent 3D cluster.

Definition at line 35 of file BranchAssociatedPfosTool.h.

◆ m_minNeutrinoVertexDistance

float lar_content::BranchAssociatedPfosTool::m_minNeutrinoVertexDistance

private

Branch association: min distance from branch vertex to neutrino vertex.

Definition at line 33 of file BranchAssociatedPfosTool.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_trackBranchAdditionFraction

float lar_content::BranchAssociatedPfosTool::m_trackBranchAdditionFraction

private

Branch association: min fraction of length along parent track before association allowed.

Definition at line 34 of file BranchAssociatedPfosTool.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/LArEventBuilding/BranchAssociatedPfosTool.h
LArContent/larpandoracontent/LArThreeDReco/LArEventBuilding/BranchAssociatedPfosTool.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BranchAssociatedPfosTool()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxParentClusterDistance

◆ m_minNeutrinoVertexDistance

◆ m_pPandora

◆ m_trackBranchAdditionFraction

◆ m_type