Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
lar_content::TwoDSlidingFitSplittingAlgorithm Class Referenceabstract

TwoDSlidingFitSplittingAlgorithm class. More...

#include "TwoDSlidingFitSplittingAlgorithm.h"

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

Public Member Functions

 TwoDSlidingFitSplittingAlgorithm ()
 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.
 

Protected Member Functions

virtual pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
virtual pandora::StatusCode FindBestSplitPosition (const TwoDSlidingFitResult &slidingFitResult, pandora::CartesianVector &splitPosition) const =0
 Use sliding linear fit to identify the best split position.
 
virtual pandora::StatusCode Run ()
 Run the algorithm.
 
pandora::StatusCode RunUsingCurrentList () const
 Run the algorithm using the current cluster list as input.
 
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

unsigned int m_slidingFitHalfWindow
 
float m_minClusterLength
 
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 DivideCaloHits (const pandora::Cluster *const pCluster, pandora::CaloHitList &firstCaloHitList, pandora::CaloHitList &secondCaloHitList) const
 Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster.
 
pandora::StatusCode DivideCaloHits (const TwoDSlidingFitResult &slidingFitResult, const pandora::CartesianVector &splitPosition, pandora::CaloHitList &firstCaloHitList, pandora::CaloHitList &secondCaloHitList) const
 Use sliding linear fit to separate cluster into two fragments.
 
pandora::StatusCode SplitCluster (const pandora::Cluster *const pCluster, pandora::ClusterList &clusterSplittingList) const
 Split cluster into two fragments.
 

Private Attributes

pandora::StringVector m_inputClusterListNames
 The list of input cluster list names - if empty, use the current cluster list.
 

Detailed Description

TwoDSlidingFitSplittingAlgorithm class.

Definition at line 21 of file TwoDSlidingFitSplittingAlgorithm.h.

Constructor & Destructor Documentation

◆ TwoDSlidingFitSplittingAlgorithm()

lar_content::TwoDSlidingFitSplittingAlgorithm::TwoDSlidingFitSplittingAlgorithm ( )

Default constructor.

Definition at line 21 of file TwoDSlidingFitSplittingAlgorithm.cc.

Member Function Documentation

◆ DivideCaloHits() [1/2]

StatusCode lar_content::TwoDSlidingFitSplittingAlgorithm::DivideCaloHits ( const pandora::Cluster *const  pCluster,
pandora::CaloHitList &  firstCaloHitList,
pandora::CaloHitList &  secondCaloHitList 
) const
privatevirtual

Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster.

Parameters
pClusteraddress of the cluster
firstCaloHitListthe hits in the first fragment
secondCaloHitListthe hits in the second fragment

Implements lar_content::ClusterSplittingAlgorithm.

Definition at line 27 of file TwoDSlidingFitSplittingAlgorithm.cc.

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

◆ DivideCaloHits() [2/2]

StatusCode lar_content::TwoDSlidingFitSplittingAlgorithm::DivideCaloHits ( const TwoDSlidingFitResult &  slidingFitResult,
const pandora::CartesianVector &  splitPosition,
pandora::CaloHitList &  firstCaloHitList,
pandora::CaloHitList &  secondCaloHitList 
) const
private

Use sliding linear fit to separate cluster into two fragments.

Parameters
slidingFitResultthe input sliding fit result
splitPositionthe split position
firstCaloHitListthe hits in the first cluster fragment
secondCaloHitListthe hits in the second cluster fragment
Returns
pandora::StatusCode

Definition at line 55 of file TwoDSlidingFitSplittingAlgorithm.cc.

Here is the call graph for this function:

◆ FindBestSplitPosition()

virtual pandora::StatusCode lar_content::TwoDSlidingFitSplittingAlgorithm::FindBestSplitPosition ( const TwoDSlidingFitResult &  slidingFitResult,
pandora::CartesianVector &  splitPosition 
) const
protectedpure virtual

Use sliding linear fit to identify the best split position.

Parameters
slidingFitResultthe input sliding fit result
splitPositionthe best split position
Returns
pandora::StatusCode

Implemented in lar_content::KinkSplittingAlgorithm, and lar_content::VertexSplittingAlgorithm.

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::TwoDSlidingFitSplittingAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
protectedvirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Reimplemented from lar_content::ClusterSplittingAlgorithm.

Reimplemented in lar_content::KinkSplittingAlgorithm, and lar_content::VertexSplittingAlgorithm.

Definition at line 92 of file TwoDSlidingFitSplittingAlgorithm.cc.

Here is the call graph for this function:
Here is the caller 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()

StatusCode lar_content::ClusterSplittingAlgorithm::Run ( )
protectedvirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file ClusterSplittingAlgorithm.cc.

Here is the call graph for this function:

◆ RunUsingCurrentList()

StatusCode lar_content::ClusterSplittingAlgorithm::RunUsingCurrentList ( ) const
protectedinherited

Run the algorithm using the current cluster list as input.

Definition at line 52 of file ClusterSplittingAlgorithm.cc.

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

◆ SplitCluster()

StatusCode lar_content::ClusterSplittingAlgorithm::SplitCluster ( const pandora::Cluster *const  pCluster,
pandora::ClusterList &  clusterSplittingList 
) const
privateinherited

Split cluster into two fragments.

Parameters
pClusteraddress of the cluster
clusterSplittingListto receive the two cluster fragments

Definition at line 77 of file ClusterSplittingAlgorithm.cc.

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

Member Data Documentation

◆ m_inputClusterListNames

pandora::StringVector lar_content::ClusterSplittingAlgorithm::m_inputClusterListNames
privateinherited

The list of input cluster list names - if empty, use the current cluster list.

Definition at line 51 of file ClusterSplittingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName
protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_minClusterLength

float lar_content::TwoDSlidingFitSplittingAlgorithm::m_minClusterLength
protected

Definition at line 43 of file TwoDSlidingFitSplittingAlgorithm.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_slidingFitHalfWindow

unsigned int lar_content::TwoDSlidingFitSplittingAlgorithm::m_slidingFitHalfWindow
protected

Definition at line 42 of file TwoDSlidingFitSplittingAlgorithm.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: