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

BranchGrowingAlgorithm class. More...

#include "BranchGrowingAlgorithm.h"

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

Classes

class  Association
 Association class. More...
 

Public Member Functions

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 Types

enum  AssociationType { NONE = 0 , SINGLE_ORDER = 1 , STANDARD = 2 , STRONG = 3 }
 AssociationType enum. More...
 
typedef std::unordered_map< const pandora::Cluster *, Association > ClusterAssociationMap
 
typedef std::unordered_map< const pandora::Cluster *, ClusterAssociationMap > ClusterUsageMap
 
typedef std::unordered_map< const pandora::Cluster *, pandora::ClusterVector > SeedAssociationList
 

Protected Member Functions

virtual AssociationType AreClustersAssociated (const pandora::Cluster *const pClusterSeed, const pandora::Cluster *const pCluster) const =0
 Determine whether two clusters are associated.
 
void FindAssociatedClusters (const pandora::Cluster *const pParticleSeed, pandora::ClusterVector &candidateClusters, ClusterUsageMap &forwardUsageMap, ClusterUsageMap &backwardUsageMap) const
 Find clusters associated with a particle seed.
 
void IdentifyClusterMerges (const pandora::ClusterVector &particleSeedVector, const ClusterUsageMap &backwardUsageMap, SeedAssociationList &seedAssociationList) const
 Identify cluster merges.
 
virtual pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
virtual StatusCode Run ()=0
 Run the algorithm.
 
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.
 

Detailed Description

BranchGrowingAlgorithm class.

Definition at line 21 of file BranchGrowingAlgorithm.h.

Member Typedef Documentation

◆ ClusterAssociationMap

typedef std::unordered_map<const pandora::Cluster *, Association> lar_content::BranchGrowingAlgorithm::ClusterAssociationMap
protected

Definition at line 87 of file BranchGrowingAlgorithm.h.

◆ ClusterUsageMap

typedef std::unordered_map<const pandora::Cluster *, ClusterAssociationMap> lar_content::BranchGrowingAlgorithm::ClusterUsageMap
protected

Definition at line 88 of file BranchGrowingAlgorithm.h.

◆ SeedAssociationList

typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterVector> lar_content::BranchGrowingAlgorithm::SeedAssociationList
protected

Definition at line 111 of file BranchGrowingAlgorithm.h.

Member Enumeration Documentation

◆ AssociationType

enum lar_content::BranchGrowingAlgorithm::AssociationType
protected

AssociationType enum.

Enumerator
NONE 
SINGLE_ORDER 
STANDARD 
STRONG 

Definition at line 27 of file BranchGrowingAlgorithm.h.

Member Function Documentation

◆ AreClustersAssociated()

virtual AssociationType lar_content::BranchGrowingAlgorithm::AreClustersAssociated ( const pandora::Cluster *const  pClusterSeed,
const pandora::Cluster *const  pCluster 
) const
protectedpure virtual

Determine whether two clusters are associated.

Parameters
pClusterSeedaddress of cluster seed (may be daughter of primary seed)
pClusteraddress of cluster
Returns
the association type

Implemented in lar_content::ShowerGrowingAlgorithm.

Here is the caller graph for this function:

◆ FindAssociatedClusters()

void lar_content::BranchGrowingAlgorithm::FindAssociatedClusters ( const pandora::Cluster *const  pParticleSeed,
pandora::ClusterVector &  candidateClusters,
ClusterUsageMap &  forwardUsageMap,
ClusterUsageMap &  backwardUsageMap 
) const
protected

Find clusters associated with a particle seed.

Parameters
pParticleSeedaddress of the particle seed
candidateClusterslist of clusters which may be associated with seed
forwardUsageMapthe particle seed usage map
backwardUsageMapthe cluster usage map

Definition at line 20 of file BranchGrowingAlgorithm.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.

◆ IdentifyClusterMerges()

void lar_content::BranchGrowingAlgorithm::IdentifyClusterMerges ( const pandora::ClusterVector &  particleSeedVector,
const ClusterUsageMap &  backwardUsageMap,
SeedAssociationList &  seedAssociationList 
) const
protected

Identify cluster merges.

Parameters
particleSeedVectorthe list of all particle seeds
backwardUsageMapthe map from cluster to particle seed associations
seedAssociationListto receive the populated seed association list

Definition at line 73 of file BranchGrowingAlgorithm.cc.

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

◆ ReadSettings()

StatusCode lar_content::BranchGrowingAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
protectedvirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::ShowerGrowingAlgorithm.

Definition at line 137 of file BranchGrowingAlgorithm.cc.

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

virtual StatusCode pandora::Algorithm::Run ( )
protectedpure virtualinherited

Run the algorithm.

Implemented in lar_content::CheatingClusterCreationAlgorithm, lar_content::CheatingCosmicRayIdentificationAlg, lar_content::CheatingCosmicRayRemovalAlgorithm, lar_content::CheatingCosmicRayShowerMatchingAlg, lar_content::CheatingNeutrinoCreationAlgorithm, lar_content::CheatingNeutrinoDaughterVerticesAlgorithm, lar_content::CheatingPfoCreationAlgorithm, lar_content::CheatingVertexCreationAlgorithm, lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, lar_content::PreProcessingAlgorithm, lar_content::SlicingAlgorithm, lar_content::StreamingAlgorithm, lar_content::CustomParticleCreationAlgorithm, lar_content::EventValidationBaseAlgorithm, lar_content::HierarchyMonitoringAlgorithm, lar_content::HierarchyValidationAlgorithm, lar_content::MCParticleMonitoringAlgorithm, lar_content::PfoValidationAlgorithm, lar_content::VertexMonitoringAlgorithm, lar_content::VisualMonitoringAlgorithm, lar_content::VisualParticleMonitoringAlgorithm, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::ElectronInitialRegionRefinementAlgorithm, lar_content::CosmicRayBaseMatchingAlgorithm, lar_content::CosmicRayTrackRecoveryAlgorithm, lar_content::CosmicRayVertexBuildingAlgorithm, lar_content::DeltaRayIdentificationAlgorithm, lar_content::DeltaRayMatchingAlgorithm, lar_content::DeltaRayParentAlgorithm, lar_content::OneViewDeltaRayMatchingAlgorithm, lar_content::UnattachedDeltaRaysAlgorithm, lar_content::NeutrinoCreationAlgorithm, lar_content::NeutrinoDaughterVerticesAlgorithm, lar_content::NeutrinoHierarchyAlgorithm, lar_content::NeutrinoPropertiesAlgorithm, lar_content::TestBeamParticleCreationAlgorithm, lar_content::ThreeDHitCreationAlgorithm, lar_content::RecursivePfoMopUpAlgorithm, lar_content::ShowerHierarchyMopUpAlgorithm, lar_content::SlidingConePfoMopUpAlgorithm, lar_content::VertexBasedPfoMopUpAlgorithm, lar_content::ParticleRecoveryAlgorithm, lar_content::VertexBasedPfoRecoveryAlgorithm, lar_content::MatchingBaseAlgorithm, lar_content::ClusterCharacterisationBaseAlgorithm, lar_content::PfoCharacterisationBaseAlgorithm, lar_content::ShowerGrowingAlgorithm, lar_content::ClusterAssociationAlgorithm, lar_content::ClusterGrowingAlgorithm, lar_content::ClusterMergingAlgorithm, lar_content::ClusteringParentAlgorithm, lar_content::SimpleClusterCreationAlgorithm, lar_content::TrackClusterCreationAlgorithm, lar_content::ClusterMopUpBaseAlgorithm, lar_content::SlidingConeClusterMopUpAlgorithm, lar_content::ClusterSplittingAlgorithm, lar_content::TwoDSlidingFitConsolidationAlgorithm, lar_content::TwoDSlidingFitMultiSplitAlgorithm, lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm, lar_content::TwoDSlidingFitSplittingAndSwitchingAlgorithm, lar_content::CosmicRaySplittingAlgorithm, lar_content::TrackMergeRefinementAlgorithm, lar_content::StreamSelectionAlgorithm, lar_content::TwoDParticleCreationAlgorithm, lar_content::InteractionSelectionAlgorithm, lar_content::ListChangingAlgorithm, lar_content::ListDeletionAlgorithm, lar_content::ListMergingAlgorithm, lar_content::ListPruningAlgorithm, lar_content::PfoHitCleaningAlgorithm, lar_content::CandidateVertexCreationAlgorithm, lar_content::VertexRefinementAlgorithm, lar_content::VertexSelectionBaseAlgorithm, lar_dl_content::DLMasterAlgorithm, lar_dl_content::DlHitValidationAlgorithm, lar_dl_content::DlHitTrackShowerIdAlgorithm, lar_dl_content::DlVertexingAlgorithm, EventReadingAlgorithm, EventWritingAlgorithm, TemplateAlgorithm, and lar_content::TrackRefinementBaseAlgorithm.

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