#include "SimpleShowersTool.h"

Inheritance diagram for lar_content::SimpleShowersTool:

[legend]

Collaboration diagram for lar_content::SimpleShowersTool:

[legend]

Public Types
typedef ThreeViewShowersAlgorithm::MatchingType::TensorType	TensorType

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

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

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
void	FindBestShower (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Find best shower match as a simple way to (try to) resolve ambiguities in the tensor.

bool	PassesElementCuts (TensorType::ElementList::const_iterator eIter) const
	Whether a provided (iterator to a) tensor element passes the selection cuts for particle creation.

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

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.

Detailed Description

SimpleShowersTool class.

Definition at line 19 of file SimpleShowersTool.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

◆ SimpleShowersTool()

lar_content::SimpleShowersTool::SimpleShowersTool ( )

Default constructor.

Definition at line 18 of file SimpleShowersTool.cc.

Member Function Documentation

◆ FindBestShower()

void lar_content::SimpleShowersTool::FindBestShower	(	const TensorType &	overlapTensor,
		ProtoParticleVector &	protoParticleVector
	)		const

private

Find best shower match as a simple way to (try to) resolve ambiguities in the tensor.

Parameters

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

Definition at line 38 of file SimpleShowersTool.cc.

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:

◆ PassesElementCuts()

bool lar_content::SimpleShowersTool::PassesElementCuts ( TensorType::ElementList::const_iterator eIter ) const

private

Whether a provided (iterator to a) tensor element passes the selection cuts for particle creation.

Parameters

eIter the iterator to the tensor element

Definition at line 75 of file SimpleShowersTool.cc.

Here is the call graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 97 of file SimpleShowersTool.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::SimpleShowersTool::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 24 of file SimpleShowersTool.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_minMatchedFraction

float lar_content::SimpleShowersTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 47 of file SimpleShowersTool.h.

◆ m_minMatchedSamplingPoints

unsigned int lar_content::SimpleShowersTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 48 of file SimpleShowersTool.h.

◆ m_minXOverlapFraction

float lar_content::SimpleShowersTool::m_minXOverlapFraction

private

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

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

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IteratorList

◆ TensorType

Constructor & Destructor Documentation

◆ SimpleShowersTool()

Member Function Documentation

◆ FindBestShower()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ PassesElementCuts()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_minMatchedFraction

◆ m_minMatchedSamplingPoints

◆ m_minXOverlapFraction

◆ m_pPandora

◆ m_type