#include "DeltaRayMergeTool.h"

Inheritance diagram for lar_content::DeltaRayMergeTool:

[legend]

Collaboration diagram for lar_content::DeltaRayMergeTool:

[legend]

Public Types
typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

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

Public Member Functions
	DeltaRayMergeTool ()
	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	ExamineConnectedElements (TensorType &overlapTensor) const
	Identify ambiguous matches (e.g. 3:2:1) and attempt to merge clusters together.

bool	MakeTwoCommonViewMerges (const TensorType::ElementList &elementList) const
	Search for two matches with two common clusters and attempt to merge the clusters in the third view together.

void	CombineCommonMuonPfoLists (const pandora::PfoList &commonMuonPfoList1, const pandora::PfoList &commonMuonPfoList2, pandora::PfoList &commonMuonPfoList) const
	Create a list of the shared common muon pfos of two elements.

bool	AreAssociated (const TensorType::Element &element1, const TensorType::Element &element2, const pandora::HitType &mergeHitType) const
	Determine, from a topological point of view, whether two delta ray clusters should be merged together.

void	GetConnectedMuons (const pandora::Cluster *const pDeltaRayCluster, const pandora::PfoList &commonMuonPfoList, pandora::PfoList &connectedMuonPfoList) const
	Return the list of muon pfos that a specified delta ray cluster is directly connected to.

bool	IsConnected (const pandora::Cluster const pCluster, const pandora::Pfo const pCommonMuonPfo) const
	Determine whether a given cluster is connected to a cosmic ray pfo.

bool	IsBrokenCluster (const pandora::Cluster const pClusterToEnlarge, const pandora::Cluster const pClusterToDelete) const
	Determine whether two delta ray clusters have been split.

bool	IsHiddenByTrack (const pandora::ParticleFlowObject const pMuonPfo, const pandora::Cluster const pCluster1, const pandora::Cluster *const pCluster2) const
	Determine whether two delta ray clusters are actually a single cluster that is hidden behind a cosmic ray track.

void	FindVertices (const pandora::Pfo const pCommonMuonPfo, const pandora::Cluster const pCluster, pandora::CaloHitList &vertexList) const
	Find all connection points of a delta ray cluster and a cosmic ray pfo.

bool	MakeOneCommonViewMerges (const TensorType::ElementList &elementList) const
	Search for two matches with a single common cluster and attempt to merge the clusters in the other two views together.

Private Attributes
float	m_maxDRSeparationFromTrack
	The maximum distance of a connected delta ray from a cosmic ray track.

float	m_maxClusterSeparation
	The maximum separation of two broken clusters that should be merged.

float	m_maxVertexSeparation
	The maximum separation of the connection points of two delta ray clusters that are hidden by a CR track and should be merged.

float	m_maxGoodMatchReducedChiSquared
	The threshold reduced chi squared value for a potential two view merge to go ahead.

Detailed Description

DeltaRayMergeTool class.

Definition at line 18 of file DeltaRayMergeTool.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

◆ DeltaRayMergeTool()

lar_content::DeltaRayMergeTool::DeltaRayMergeTool ( )

Default constructor.

Definition at line 22 of file DeltaRayMergeTool.cc.

Member Function Documentation

◆ AreAssociated()

bool lar_content::DeltaRayMergeTool::AreAssociated	(	const TensorType::Element &	element1,
		const TensorType::Element &	element2,
		const pandora::HitType &	mergeHitType
	)		const

private

Determine, from a topological point of view, whether two delta ray clusters should be merged together.

Parameters

element1	the first tensor element
element2	the second tensor element
mergeHitType	the hit type of the view in which to assess the merge

Returns: whether the clusters are topologically associated

Definition at line 145 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CombineCommonMuonPfoLists()

void lar_content::DeltaRayMergeTool::CombineCommonMuonPfoLists	(	const pandora::PfoList &	commonMuonPfoList1,
		const pandora::PfoList &	commonMuonPfoList2,
		pandora::PfoList &	commonMuonPfoList
	)		const

private

Create a list of the shared common muon pfos of two elements.

Parameters

commonMuonPfoList1	the common muon pfo list of the first element
commonMuonPfoList2	the common muon pfo list of the second element
commonMuonPfoList	the output common muon pfo list

Definition at line 180 of file DeltaRayMergeTool.cc.

Here is the caller graph for this function:

◆ ExamineConnectedElements()

bool lar_content::DeltaRayMergeTool::ExamineConnectedElements ( TensorType & overlapTensor ) const

private

Identify ambiguous matches (e.g. 3:2:1) and attempt to merge clusters together.

Parameters

overlapTensor the overlap tensor

Returns: whether any merges have been made

Definition at line 44 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindVertices()

void lar_content::DeltaRayMergeTool::FindVertices	(	const pandora::Pfo *const	pCommonMuonPfo,
		const pandora::Cluster *const	pCluster,
		pandora::CaloHitList &	vertexList
	)		const

private

Find all connection points of a delta ray cluster and a cosmic ray pfo.

Parameters

pCommonMuonPfo	the address of the cosmic ray pfo
pCluster	the address of the delta ray cluster
vertexList	the output list of connection points

Definition at line 253 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetConnectedMuons()

void lar_content::DeltaRayMergeTool::GetConnectedMuons	(	const pandora::Cluster *const	pDeltaRayCluster,
		const pandora::PfoList &	commonMuonPfoList,
		pandora::PfoList &	connectedMuonPfoList
	)		const

private

Return the list of muon pfos that a specified delta ray cluster is directly connected to.

Parameters

pDeltaRayCluster	the address of the input delta ray cluster
commonMuonPfoList	the common muon pfo list of the element to which the DR cluster belongs
connectedMuonPfoList	the output list of connected muon pfos

Definition at line 194 of file DeltaRayMergeTool.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:

◆ IsBrokenCluster()

bool lar_content::DeltaRayMergeTool::IsBrokenCluster	(	const pandora::Cluster *const	pClusterToEnlarge,
		const pandora::Cluster *const	pClusterToDelete
	)		const

private

Determine whether two delta ray clusters have been split.

Parameters

pClusterToEnlarge	the address of one delta ray cluster
pClusterToDelete	the address of the other delta ray cluster

Returns: whether the clusters have been split

Definition at line 222 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsConnected()

bool lar_content::DeltaRayMergeTool::IsConnected	(	const pandora::Cluster *const	pCluster,
		const pandora::Pfo *const	pCommonMuonPfo
	)		const

private

Determine whether a given cluster is connected to a cosmic ray pfo.

Parameters

pCluster	the address of the input cluster
pCommonMuonPfo	the address of the cosmic ray pfo

Returns: whether the cluster is connected to the cosmic ray pfo

Definition at line 205 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsHiddenByTrack()

bool lar_content::DeltaRayMergeTool::IsHiddenByTrack	(	const pandora::ParticleFlowObject *const	pMuonPfo,
		const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2
	)		const

private

Determine whether two delta ray clusters are actually a single cluster that is hidden behind a cosmic ray track.

Parameters

pMuonPfo	the address of the cosmic ray pfo
pCluster1	the address of one delta ray cluster
pCluster2	the address of the other delta ray cluster

Returns: whether the delta ray clusters are one delta ray cluster, hidden behind a cosmic ray track

Definition at line 231 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeOneCommonViewMerges()

bool lar_content::DeltaRayMergeTool::MakeOneCommonViewMerges ( const TensorType::ElementList & elementList ) const

private

Search for two matches with a single common cluster and attempt to merge the clusters in the other two views together.

Parameters

elementList the tensor element list

Returns: whether a merge was made

Definition at line 275 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeTwoCommonViewMerges()

bool lar_content::DeltaRayMergeTool::MakeTwoCommonViewMerges ( const TensorType::ElementList & elementList ) const

private

Search for two matches with two common clusters and attempt to merge the clusters in the third view together.

Parameters

elementList the tensor element list

Returns: whether a merge was made

Definition at line 93 of file DeltaRayMergeTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 353 of file DeltaRayMergeTool.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::DeltaRayMergeTool::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 32 of file DeltaRayMergeTool.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_maxClusterSeparation

float lar_content::DeltaRayMergeTool::m_maxClusterSeparation

private

The maximum separation of two broken clusters that should be merged.

Definition at line 130 of file DeltaRayMergeTool.h.

◆ m_maxDRSeparationFromTrack

float lar_content::DeltaRayMergeTool::m_maxDRSeparationFromTrack

private

The maximum distance of a connected delta ray from a cosmic ray track.

Definition at line 129 of file DeltaRayMergeTool.h.

◆ m_maxGoodMatchReducedChiSquared

float lar_content::DeltaRayMergeTool::m_maxGoodMatchReducedChiSquared

private

The threshold reduced chi squared value for a potential two view merge to go ahead.

Definition at line 132 of file DeltaRayMergeTool.h.

◆ m_maxVertexSeparation

float lar_content::DeltaRayMergeTool::m_maxVertexSeparation

private

The maximum separation of the connection points of two delta ray clusters that are hidden by a CR track and should be merged.

Definition at line 131 of file DeltaRayMergeTool.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/DeltaRayMergeTool.h
LArContent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayMergeTool.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

◆ DeltaRayMergeTool()

Member Function Documentation

◆ AreAssociated()

◆ CombineCommonMuonPfoLists()

◆ ExamineConnectedElements()

◆ FindVertices()

◆ GetConnectedMuons()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsBrokenCluster()

◆ IsConnected()

◆ IsHiddenByTrack()

◆ MakeOneCommonViewMerges()

◆ MakeTwoCommonViewMerges()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxClusterSeparation

◆ m_maxDRSeparationFromTrack

◆ m_maxGoodMatchReducedChiSquared

◆ m_maxVertexSeparation

◆ m_pPandora

◆ m_pParentAlgorithm

◆ m_type