Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
lar_content::TrackSplittingTool Class Reference

TrackSplittingTool class. More...

#include "TrackSplittingTool.h"

Inheritance diagram for lar_content::TrackSplittingTool:
Collaboration diagram for lar_content::TrackSplittingTool:

Classes

class  Particle
 Particle class. More...
 

Public Types

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

Public Member Functions

 TrackSplittingTool ()
 Default constructor.
 
bool Run (ThreeViewTransverseTracksAlgorithm *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 PandoraGetPandora () 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 Pandoram_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 FindTracks (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, const TensorType &overlapTensor, SplitPositionMap &splitPositionMap) const
 Find remaining tracks, hidden by spurious track segments (and maybe other ambiguities) in the tensor.
 
void SelectElements (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
 Select a list of the relevant elements from a set of connected tensor elements.
 
bool PassesChecks (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, const TensorType::Element &element, const bool isMinX, pandora::ClusterSet &usedClusters, SplitPositionMap &splitPositionMap) const
 Whether a provided tensor element can be used to construct a pfo.
 
bool CheckSplitPosition (const pandora::CartesianVector &splitPosition, const float splitX, const TwoDSlidingFitResult &longFitResult) const
 Check a candidate split position for consistency with the associated track cluster sliding linear fit.
 

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 (between long clusters and short cluster vs. shared overlap)
 
unsigned int m_minMatchedSamplingPointRatio
 The min ratio between 1st and 2nd highest msps for simple ambiguity resolution.
 
float m_maxShortDeltaXFraction
 Max x distance between ends of two short clusters (measured as fraction of long cluster x length)
 
float m_maxAbsoluteShortDeltaX
 Max x distance between ends of two short clusters (measured as an absolute distance)
 
float m_minLongDeltaXFraction
 Min x distance between ends of short and long clusters (measured as fraction of long cluster x length)
 
float m_minAbsoluteLongDeltaX
 Min x distance between ends of short and long clusters (measured as an absolute distance)
 
float m_minSplitToVertexProjection
 Min projected distance between split position and either inner or outer vertex of long cluster.
 
float m_maxSplitVsFitPositionDistance
 Max allowed distance between split position and sliding linear fit position at the split x coordinate.
 

Detailed Description

TrackSplittingTool class.

Definition at line 19 of file TrackSplittingTool.h.

Member Typedef Documentation

◆ IteratorList

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

Definition at line 131 of file ThreeViewTransverseTracksAlgorithm.h.

◆ TensorType

typedef ThreeViewTransverseTracksAlgorithm::MatchingType::TensorType lar_content::TransverseTensorTool::TensorType
inherited

Definition at line 130 of file ThreeViewTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

◆ TrackSplittingTool()

lar_content::TrackSplittingTool::TrackSplittingTool ( )

Default constructor.

Definition at line 23 of file TrackSplittingTool.cc.

Member Function Documentation

◆ CheckSplitPosition()

bool lar_content::TrackSplittingTool::CheckSplitPosition ( const pandora::CartesianVector splitPosition,
const float  splitX,
const TwoDSlidingFitResult longFitResult 
) const
private

Check a candidate split position for consistency with the associated track cluster sliding linear fit.

Parameters
splitPositionthe candidate split position
splitXthe split x coordinate
longFitResultthe sliding linear fit for the long cluster

Definition at line 212 of file TrackSplittingTool.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FindTracks()

void lar_content::TrackSplittingTool::FindTracks ( ThreeViewTransverseTracksAlgorithm *const  pAlgorithm,
const TensorType overlapTensor,
SplitPositionMap splitPositionMap 
) const
private

Find remaining tracks, hidden by spurious track segments (and maybe other ambiguities) in the tensor.

Parameters
pAlgorithmaddress of the calling algorithm
overlapTensorthe overlap tensor
splitPositionMapto receive the split position map

Definition at line 53 of file TrackSplittingTool.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:

◆ PassesChecks()

bool lar_content::TrackSplittingTool::PassesChecks ( ThreeViewTransverseTracksAlgorithm *const  pAlgorithm,
const TensorType::Element &  element,
const bool  isMinX,
pandora::ClusterSet usedClusters,
SplitPositionMap splitPositionMap 
) const
private

Whether a provided tensor element can be used to construct a pfo.

Parameters
pAlgorithmaddress of the calling algorithm
elementthe tensor element
isMinXwhether to look for track splits at min or max x coordinate
usedClustersthe list of used clusters
splitPositionMapto receive the split position map

Definition at line 134 of file TrackSplittingTool.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadSettings()

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

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Definition at line 259 of file TrackSplittingTool.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::TrackSplittingTool::Run ( ThreeViewTransverseTracksAlgorithm *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::TransverseTensorTool.

Definition at line 39 of file TrackSplittingTool.cc.

Here is the call graph for this function:

◆ SelectElements()

void lar_content::TrackSplittingTool::SelectElements ( const TensorType::ElementList &  elementList,
const pandora::ClusterSet usedClusters,
IteratorList iteratorList 
) const
private

Select a list of the relevant elements from a set of connected tensor elements.

Parameters
elementListthe full list of connected tensor elements
usedClustersthe list of clusters already marked as to be added to a pfo
iteratorListto receive a list of iterators to long track-like elements

Definition at line 95 of file TrackSplittingTool.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_maxAbsoluteShortDeltaX

float lar_content::TrackSplittingTool::m_maxAbsoluteShortDeltaX
private

Max x distance between ends of two short clusters (measured as an absolute distance)

Definition at line 101 of file TrackSplittingTool.h.

◆ m_maxShortDeltaXFraction

float lar_content::TrackSplittingTool::m_maxShortDeltaXFraction
private

Max x distance between ends of two short clusters (measured as fraction of long cluster x length)

Definition at line 100 of file TrackSplittingTool.h.

◆ m_maxSplitVsFitPositionDistance

float lar_content::TrackSplittingTool::m_maxSplitVsFitPositionDistance
private

Max allowed distance between split position and sliding linear fit position at the split x coordinate.

Definition at line 105 of file TrackSplittingTool.h.

◆ m_minAbsoluteLongDeltaX

float lar_content::TrackSplittingTool::m_minAbsoluteLongDeltaX
private

Min x distance between ends of short and long clusters (measured as an absolute distance)

Definition at line 103 of file TrackSplittingTool.h.

◆ m_minLongDeltaXFraction

float lar_content::TrackSplittingTool::m_minLongDeltaXFraction
private

Min x distance between ends of short and long clusters (measured as fraction of long cluster x length)

Definition at line 102 of file TrackSplittingTool.h.

◆ m_minMatchedFraction

float lar_content::TrackSplittingTool::m_minMatchedFraction
private

The min matched sampling point fraction for particle creation.

Definition at line 95 of file TrackSplittingTool.h.

◆ m_minMatchedSamplingPointRatio

unsigned int lar_content::TrackSplittingTool::m_minMatchedSamplingPointRatio
private

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

Definition at line 98 of file TrackSplittingTool.h.

◆ m_minMatchedSamplingPoints

unsigned int lar_content::TrackSplittingTool::m_minMatchedSamplingPoints
private

The min number of matched sampling points for particle creation.

Definition at line 96 of file TrackSplittingTool.h.

◆ m_minSplitToVertexProjection

float lar_content::TrackSplittingTool::m_minSplitToVertexProjection
private

Min projected distance between split position and either inner or outer vertex of long cluster.

Definition at line 104 of file TrackSplittingTool.h.

◆ m_minXOverlapFraction

float lar_content::TrackSplittingTool::m_minXOverlapFraction
private

The min x overlap fraction (between long clusters and short cluster vs. shared overlap)

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