Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
lar_content::MatchedEndPointsTool Class Reference

MatchedEndPointsTool class. More...

#include "MatchedEndPointsTool.h"

Inheritance diagram for lar_content::MatchedEndPointsTool:
Inheritance graph
[legend]
Collaboration diagram for lar_content::MatchedEndPointsTool:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 MatchedEndPointsTool ()
 Default constructor.
 
bool Run (ThreeViewLongitudinalTracksAlgorithm *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

pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
void FindMatchedTracks (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
 Find matched tracks, hidden by ambiguities in the tensor.
 

Static Private Member Functions

static bool SortByChiSquared (const TensorType::Element &lhs, const TensorType::Element &rhs)
 Sort tensor elements by chi-squared.
 

Private Attributes

float m_minMatchedFraction
 The min matched sampling point fraction for particle creation.
 
float m_maxEndPointChi2
 The max chi2 of matched vertex and end points for particle creation.
 

Detailed Description

MatchedEndPointsTool class.

Definition at line 19 of file MatchedEndPointsTool.h.

Member Typedef Documentation

◆ IteratorList

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::LongitudinalTensorTool::IteratorList
inherited

Definition at line 89 of file ThreeViewLongitudinalTracksAlgorithm.h.

◆ TensorType

typedef ThreeViewLongitudinalTracksAlgorithm::MatchingType::TensorType lar_content::LongitudinalTensorTool::TensorType
inherited

Definition at line 88 of file ThreeViewLongitudinalTracksAlgorithm.h.

Constructor & Destructor Documentation

◆ MatchedEndPointsTool()

lar_content::MatchedEndPointsTool::MatchedEndPointsTool ( )

Default constructor.

Definition at line 18 of file MatchedEndPointsTool.cc.

Member Function Documentation

◆ FindMatchedTracks()

void lar_content::MatchedEndPointsTool::FindMatchedTracks ( const TensorType &  overlapTensor,
ProtoParticleVector &  protoParticleVector 
) const
private

Find matched tracks, hidden by ambiguities in the tensor.

Parameters
overlapTensorthe overlap tensor
protoParticleVectorto receive the list of proto particles

Definition at line 38 of file MatchedEndPointsTool.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:

◆ ReadSettings()

StatusCode lar_content::MatchedEndPointsTool::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
privatevirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 92 of file MatchedEndPointsTool.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
pPandoraaddress of the pandora object that will run the process
typethe process type
instanceNamethe 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::MatchedEndPointsTool::Run ( ThreeViewLongitudinalTracksAlgorithm *const  pAlgorithm,
TensorType &  overlapTensor 
)
virtual

Run the algorithm tool.

Parameters
pAlgorithmaddress of the calling algorithm
overlapTensorthe overlap tensor
Returns
whether changes have been made by the tool

Implements lar_content::LongitudinalTensorTool.

Definition at line 24 of file MatchedEndPointsTool.cc.

Here is the call graph for this function:

◆ SortByChiSquared()

bool lar_content::MatchedEndPointsTool::SortByChiSquared ( const TensorType::Element &  lhs,
const TensorType::Element &  rhs 
)
staticprivate

Sort tensor elements by chi-squared.

Parameters
lhsthe first tensor element
rhsthe second tensor element
Returns
boolean

Definition at line 84 of file MatchedEndPointsTool.cc.

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_maxEndPointChi2

float lar_content::MatchedEndPointsTool::m_maxEndPointChi2
private

The max chi2 of matched vertex and end points for particle creation.

Definition at line 51 of file MatchedEndPointsTool.h.

◆ m_minMatchedFraction

float lar_content::MatchedEndPointsTool::m_minMatchedFraction
private

The min matched sampling point fraction for particle creation.

Definition at line 50 of file MatchedEndPointsTool.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: