#include "ClearShowersTool.h"

Inheritance diagram for lar_content::ClearShowersTool:

[legend]

Collaboration diagram for lar_content::ClearShowersTool:

[legend]

Public Types
typedef ThreeViewShowersAlgorithm::MatchingType::TensorType	TensorType

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

Public Member Functions
	ClearShowersTool ()
	Default constructor.

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

Static Public Member Functions
static bool	HasLargeDirectConnections (IteratorList::const_iterator iIter, const IteratorList &iteratorList)
	Whether a large shower-like element shares clusters with any other long elements.

static bool	IsLargerThanDirectConnections (IteratorList::const_iterator iIter, const TensorType::ElementList &elementList, const unsigned int minMatchedSamplingPointRatio, const float minXOverlapSpanRatio, const pandora::ClusterSet &usedClusters)
	Whether a large shower-like element is significantly larger that other elements with which it shares a cluster.

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.

void	FindClearShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Find clear shower matches, hidden by simple ambiguities in the tensor.

void	SelectLargeShowerElements (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select a list of large shower-like elements from a set of connected tensor elements.

Private Attributes
float	m_minMatchedFraction
	The min matched sampling point fraction for particle creation.

unsigned int	m_minMatchedSamplingPoints
	The min number of matched sampling points for particle creation.

float	m_minXOverlapFraction
	The min x overlap fraction (in each view) for particle creation.

unsigned int	m_minMatchedSamplingPointRatio
	The min ratio between 1st and 2nd highest msps for simple ambiguity resolution.

float	m_minXOverlapSpanRatio
	The min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution.

bool	m_visualize
	Visualize cluster split locations.

Detailed Description

ClearShowersTool class.

Definition at line 19 of file ClearShowersTool.h.

Member Typedef Documentation

◆ IteratorList

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

inherited

Definition at line 175 of file ThreeViewShowersAlgorithm.h.

◆ TensorType

typedef ThreeViewShowersAlgorithm::MatchingType::TensorType lar_content::ShowerTensorTool::TensorType

inherited

Definition at line 174 of file ThreeViewShowersAlgorithm.h.

Constructor & Destructor Documentation

◆ ClearShowersTool()

lar_content::ClearShowersTool::ClearShowersTool ( )

Default constructor.

Definition at line 18 of file ClearShowersTool.cc.

Member Function Documentation

◆ FindClearShowers()

void lar_content::ClearShowersTool::FindClearShowers	(	const TensorType &	overlapTensor,
		ProtoParticleVector &	protoParticleVector
	)		const

private

Find clear shower matches, hidden by simple ambiguities in the tensor.

Parameters

overlapTensor	the overlap tensor
protoParticleVector	to receive the list of proto particles

Definition at line 91 of file ClearShowersTool.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.

◆ HasLargeDirectConnections()

bool lar_content::ClearShowersTool::HasLargeDirectConnections	(	IteratorList::const_iterator	iIter,
		const IteratorList &	iteratorList
	)

static

Whether a large shower-like element shares clusters with any other long elements.

Parameters

iIter	specifies the large element under consideration
iteratorList	list of iterators to other large elements

Returns: boolean

Definition at line 30 of file ClearShowersTool.cc.

Here is the caller graph for this function:

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

◆ IsLargerThanDirectConnections()

bool lar_content::ClearShowersTool::IsLargerThanDirectConnections	(	IteratorList::const_iterator	iIter,
		const TensorType::ElementList &	elementList,
		const unsigned int	minMatchedSamplingPointRatio,
		const float	minXOverlapSpanRatio,
		const pandora::ClusterSet &	usedClusters
	)

static

Whether a large shower-like element is significantly larger that other elements with which it shares a cluster.

Parameters

iIter	specifies the large element under consideration
elementList	the full list of connected tensor elements
minMatchedSamplingPointRatio	the min ratio between 1st and 2nd highest msps for simple ambiguity resolution
minMatchedSamplingPointRatio	the min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution
usedClusters	the list of clusters already marked as to be added to a pfo

Definition at line 47 of file ClearShowersTool.cc.

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 180 of file ClearShowersTool.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::ClearShowersTool::Run	(	ThreeViewShowersAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

virtual

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::ShowerTensorTool.

Definition at line 77 of file ClearShowersTool.cc.

Here is the call graph for this function:

◆ SelectLargeShowerElements()

void lar_content::ClearShowersTool::SelectLargeShowerElements	(	const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	usedClusters,
		IteratorList &	iteratorList
	)		const

private

Select a list of large shower-like elements from a set of connected tensor elements.

Parameters

elementList	the full list of connected tensor elements
usedClusters	the list of clusters already marked as to be added to a pfo
iteratorList	to receive a list of iterators to large shower-like elements

Definition at line 140 of file ClearShowersTool.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_minMatchedFraction

float lar_content::ClearShowersTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 71 of file ClearShowersTool.h.

◆ m_minMatchedSamplingPointRatio

unsigned int lar_content::ClearShowersTool::m_minMatchedSamplingPointRatio

private

The min ratio between 1st and 2nd highest msps for simple ambiguity resolution.

Definition at line 74 of file ClearShowersTool.h.

◆ m_minMatchedSamplingPoints

unsigned int lar_content::ClearShowersTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 72 of file ClearShowersTool.h.

◆ m_minXOverlapFraction

float lar_content::ClearShowersTool::m_minXOverlapFraction

private

The min x overlap fraction (in each view) for particle creation.

Definition at line 73 of file ClearShowersTool.h.

◆ m_minXOverlapSpanRatio

float lar_content::ClearShowersTool::m_minXOverlapSpanRatio

private

The min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution.

Definition at line 75 of file ClearShowersTool.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_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_visualize

bool lar_content::ClearShowersTool::m_visualize

private

Visualize cluster split locations.

Definition at line 76 of file ClearShowersTool.h.

The documentation for this class was generated from the following files:

LArContent/larpandoracontent/LArThreeDReco/LArShowerMatching/ClearShowersTool.h
LArContent/larpandoracontent/LArThreeDReco/LArShowerMatching/ClearShowersTool.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IteratorList

◆ TensorType

Constructor & Destructor Documentation

◆ ClearShowersTool()

Member Function Documentation

◆ FindClearShowers()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ HasLargeDirectConnections()

◆ Initialize()

◆ IsLargerThanDirectConnections()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectLargeShowerElements()

Member Data Documentation

◆ m_instanceName

◆ m_minMatchedFraction

◆ m_minMatchedSamplingPointRatio

◆ m_minMatchedSamplingPoints

◆ m_minXOverlapFraction

◆ m_minXOverlapSpanRatio

◆ m_pPandora

◆ m_type

◆ m_visualize