#include "UnambiguousDeltaRayTool.h"

Inheritance diagram for lar_content::UnambiguousDeltaRayTool:

[legend]

Collaboration diagram for lar_content::UnambiguousDeltaRayTool:

[legend]

Public Types
typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	UnambiguousDeltaRayTool ()
	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.

Public Attributes
ThreeViewDeltaRayMatchingAlgorithm *	m_pParentAlgorithm
	Address of the parent matching algorithm.

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
bool	Run (ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool.

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

bool	ExamineUnambiguousElements (TensorType::ElementList &elementList)
	Create delta ray pfos out of unambiguous (1:1:1) matches that are connected to a parent cosmic ray.

bool	IsConnected (const TensorType::Element &element) const
	Determine whether the clusters of an element are connected to a cosmic ray pfo.

Private Attributes
float	m_maxSeparation
	The maximum separation between a connected delta ray cluster and a cosmic ray cluster.

unsigned int	m_minNConnectedClusters
	The threshold number of connected delta ray clusters required for particle creation.

Detailed Description

UnambiguousDeltaRayTool class.

Definition at line 18 of file UnambiguousDeltaRayTool.h.

Member Typedef Documentation

◆ IteratorList

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::DeltaRayTensorTool::IteratorList

inherited

Definition at line 102 of file ThreeViewDeltaRayMatchingAlgorithm.h.

◆ TensorType

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType lar_content::DeltaRayTensorTool::TensorType

inherited

Definition at line 101 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Constructor & Destructor Documentation

◆ UnambiguousDeltaRayTool()

lar_content::UnambiguousDeltaRayTool::UnambiguousDeltaRayTool ( )

Default constructor.

Definition at line 21 of file UnambiguousDeltaRayTool.cc.

Member Function Documentation

◆ ExamineUnambiguousElements()

bool lar_content::UnambiguousDeltaRayTool::ExamineUnambiguousElements ( TensorType::ElementList & elementList )

private

Create delta ray pfos out of unambiguous (1:1:1) matches that are connected to a parent cosmic ray.

Parameters

elementList the tensor element list

Returns: whether any delta ray pfos were created

Definition at line 42 of file UnambiguousDeltaRayTool.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:

◆ IsConnected()

bool lar_content::UnambiguousDeltaRayTool::IsConnected ( const TensorType::Element & element ) const

private

Determine whether the clusters of an element are connected to a cosmic ray pfo.

Parameters

elementList the tensor element

Returns: whether the clusters are connected to a cosmic ray pfo

Definition at line 63 of file UnambiguousDeltaRayTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

bool lar_content::UnambiguousDeltaRayTool::Run	(	ThreeViewDeltaRayMatchingAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

privatevirtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns: whether changes have been made by the tool

Implements lar_content::DeltaRayTensorTool.

Definition at line 27 of file UnambiguousDeltaRayTool.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_maxSeparation

float lar_content::UnambiguousDeltaRayTool::m_maxSeparation

private

The maximum separation between a connected delta ray cluster and a cosmic ray cluster.

Definition at line 48 of file UnambiguousDeltaRayTool.h.

◆ m_minNConnectedClusters

unsigned int lar_content::UnambiguousDeltaRayTool::m_minNConnectedClusters

private

The threshold number of connected delta ray clusters required for particle creation.

Definition at line 49 of file UnambiguousDeltaRayTool.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_pParentAlgorithm

ThreeViewDeltaRayMatchingAlgorithm* lar_content::DeltaRayTensorTool::m_pParentAlgorithm

inherited

Address of the parent matching algorithm.

Definition at line 114 of file ThreeViewDeltaRayMatchingAlgorithm.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/LArCosmicRay/UnambiguousDeltaRayTool.h
LArContent/larpandoracontent/LArThreeDReco/LArCosmicRay/UnambiguousDeltaRayTool.cc

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IteratorList

◆ TensorType

Constructor & Destructor Documentation

◆ UnambiguousDeltaRayTool()

Member Function Documentation

◆ ExamineUnambiguousElements()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsConnected()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxSeparation

◆ m_minNConnectedClusters

◆ m_pPandora

◆ m_pParentAlgorithm

◆ m_type