pandora::ShowerProfilePlugin Class Reference

ShowerProfilePlugin class. More...

#include "ShowerProfilePlugin.h"

Inheritance diagram for pandora::ShowerProfilePlugin:

Collaboration diagram for pandora::ShowerProfilePlugin:

Classes
class	ShowerPeak
	ShowerPeak class. More...

Public Types
typedef std::vector< ShowerPeak >	ShowerPeakList

Public Member Functions
virtual void	CalculateShowerStartLayer (const Cluster *const pCluster, unsigned int &showerStartLayer) const =0
	Get the layer at which shower can be considered to start; this function evaluates the the starting point of a series of "showerStartNonMipLayers" successive layers, each with mip fraction below "showerLayerMipFraction".
virtual void	CalculateLongitudinalProfile (const Cluster *const pCluster, float &profileStart, float &profileDiscrepancy) const =0
	Calculate longitudinal shower profile for a cluster and compare it with the expected profile for a photon.
virtual void	CalculateTransverseProfile (const Cluster *const pCluster, const unsigned int maxPseudoLayer, ShowerPeakList &showerPeakList) const =0
	Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile.
virtual void	CalculateTransverseProfile (const Cluster *const pCluster, const unsigned int maxPseudoLayer, ShowerPeakList &showerPeakList, const bool inclusiveMode) const =0
	Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile.
virtual void	CalculateTrackBasedTransverseProfile (const Cluster *const pCluster, const unsigned int maxPseudoLayer, const Track *const pClosestTrack, const TrackVector &trackVector, ShowerPeakList &showerPeakListPhoton, ShowerPeakList &showerPeakListNonPhoton) const =0
	Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile, for clusters close to tracks.
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	ReadSettings (const TiXmlHandle xmlHandle)=0
	Read the algorithm settings.
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.

Friends
class	PluginManager

Detailed Description

ShowerProfilePlugin class.

Definition at line 20 of file ShowerProfilePlugin.h.

Member Typedef Documentation

ShowerPeakList

typedef std::vector<ShowerPeak> pandora::ShowerProfilePlugin::ShowerPeakList

Definition at line 74 of file ShowerProfilePlugin.h.

Member Function Documentation

CalculateLongitudinalProfile()

virtual void pandora::ShowerProfilePlugin::CalculateLongitudinalProfile ( const Cluster *const  pCluster, float &  profileStart, float &  profileDiscrepancy  ) const

pure virtual

Calculate longitudinal shower profile for a cluster and compare it with the expected profile for a photon.

Parameters

pCluster	address of the cluster to investigate
profileStart	to receive the profile start, in radiation lengths
profileDiscrepancy	to receive the profile discrepancy

Here is the caller graph for this function:

CalculateShowerStartLayer()

virtual void pandora::ShowerProfilePlugin::CalculateShowerStartLayer ( const Cluster *const  pCluster, unsigned int &  showerStartLayer  ) const

pure virtual

Get the layer at which shower can be considered to start; this function evaluates the the starting point of a series of "showerStartNonMipLayers" successive layers, each with mip fraction below "showerLayerMipFraction".

Parameters

pCluster	address of the cluster
showerStartLayer	to receive the shower start layer

Here is the caller graph for this function:

CalculateTrackBasedTransverseProfile()

virtual void pandora::ShowerProfilePlugin::CalculateTrackBasedTransverseProfile ( const Cluster *const  pCluster, const unsigned int  maxPseudoLayer, const Track *const  pClosestTrack, const TrackVector &  trackVector, ShowerPeakList &  showerPeakListPhoton, ShowerPeakList &  showerPeakListNonPhoton  ) const

pure virtual

Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile, for clusters close to tracks.

Parameters

pCluster	the address of the cluster
maxPseudoLayer	the maximum pseudo layer to consider
pClosestTrack	the address of the closest track
trackVector	the vector of nearby tracks
showerPeakListPhoton	to receive the shower peak list that are photon candidates
showerPeakListNonPhoton	to receive the shower peak list that are not photon candidates

CalculateTransverseProfile() [1/2]

virtual void pandora::ShowerProfilePlugin::CalculateTransverseProfile ( const Cluster *const  pCluster, const unsigned int  maxPseudoLayer, ShowerPeakList &  showerPeakList  ) const

pure virtual

Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile.

Parameters

pCluster	the address of the cluster
maxPseudoLayer	the maximum pseudo layer to consider
showerPeakList	to receive the shower peak list

CalculateTransverseProfile() [2/2]

virtual void pandora::ShowerProfilePlugin::CalculateTransverseProfile ( const Cluster *const  pCluster, const unsigned int  maxPseudoLayer, ShowerPeakList &  showerPeakList, const bool  inclusiveMode  ) const

pure virtual

Calculate transverse shower profile for a cluster and get the list of peaks identified in the profile.

Parameters

pCluster	the address of the cluster
maxPseudoLayer	the maximum pseudo layer to consider
showerPeakList	to receive the shower peak list
inclusiveMode	whether to operate inclusive shower peak finding

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

virtual StatusCode pandora::Process::ReadSettings ( const TiXmlHandle  xmlHandle )

protectedpure virtualinherited

Read the algorithm settings.

Parameters

xmlHandle

the relevant xml handle

Implemented in lar_content::CheatingBeamParticleIdTool, lar_content::CheatingBeamParticleSliceSelectionTool, lar_content::CheatingClusterCreationAlgorithm, lar_content::CheatingCosmicRayIdentificationAlg, lar_content::CheatingCosmicRayRemovalAlgorithm, lar_content::CheatingCosmicRayShowerMatchingAlg, lar_content::CheatingCosmicRayTaggingTool, lar_content::CheatingEventSlicingTool, lar_content::CheatingNeutrinoCreationAlgorithm, lar_content::CheatingNeutrinoDaughterVerticesAlgorithm, lar_content::CheatingNeutrinoIdTool, lar_content::CheatingNeutrinoSliceSelectionTool, lar_content::CheatingPfoCreationAlgorithm, lar_content::CheatingSliceIdBaseTool, lar_content::CheatingSliceSelectionTool, lar_content::CheatingVertexCreationAlgorithm, lar_content::CheatingVertexSelectionAlgorithm, lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::MasterAlgorithm, lar_content::NeutrinoIdTool< T >, lar_content::PostProcessingAlgorithm, lar_content::PreProcessingAlgorithm, lar_content::SimpleNeutrinoIdTool, lar_content::SlicingAlgorithm, lar_content::StitchingCosmicRayMergingTool, lar_content::StreamingAlgorithm, lar_content::CustomParticleCreationAlgorithm, lar_content::PcaShowerParticleBuildingAlgorithm, lar_content::TrackParticleBuildingAlgorithm, lar_content::CosmicRayTaggingMonitoringTool, lar_content::EventValidationBaseAlgorithm, lar_content::HierarchyMonitoringAlgorithm, lar_content::HierarchyValidationAlgorithm, lar_content::MCParticleMonitoringAlgorithm, lar_content::MuonLeadingEventValidationAlgorithm, lar_content::NeutrinoEventValidationAlgorithm, lar_content::PfoValidationAlgorithm, lar_content::ShowerTensorVisualizationTool, lar_content::TestBeamEventValidationAlgorithm, lar_content::TestBeamHierarchyEventValidationAlgorithm, lar_content::TransverseMatrixVisualizationTool, lar_content::TransverseTensorVisualizationTool, lar_content::VertexMonitoringAlgorithm, lar_content::VisualMonitoringAlgorithm, lar_content::VisualParticleMonitoringAlgorithm, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArParticleIdPlugins::LArMuonId, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, lar_content::InitialRegionFeatureTool, lar_content::ConnectionRegionFeatureTool, lar_content::ShowerRegionFeatureTool, lar_content::AmbiguousRegionFeatureTool, lar_content::ElectronInitialRegionRefinementAlgorithm, lar_content::PeakDirectionFinderTool, lar_content::ProtoShowerMatchingTool, lar_content::ShowerSpineFinderTool, lar_content::ShowerStartFinderTool, lar_content::AmbiguousDeltaRayTool, lar_content::CosmicRayBaseMatchingAlgorithm, lar_content::CosmicRayRemovalTool, lar_content::CosmicRayShowerMatchingAlgorithm, lar_content::CosmicRayTrackMatchingAlgorithm, lar_content::CosmicRayTrackRecoveryAlgorithm, lar_content::CosmicRayVertexBuildingAlgorithm, lar_content::DeltaRayIdentificationAlgorithm, lar_content::DeltaRayMatchingAlgorithm, lar_content::DeltaRayMergeTool, lar_content::DeltaRayParentAlgorithm, lar_content::DeltaRayRemovalTool, lar_content::NViewDeltaRayMatchingAlgorithm< T >, lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, lar_content::OneViewDeltaRayMatchingAlgorithm, lar_content::ThreeViewDeltaRayMatchingAlgorithm, lar_content::TwoViewAmbiguousDeltaRayTool, lar_content::TwoViewCosmicRayRemovalTool, lar_content::TwoViewDeltaRayMatchingAlgorithm, lar_content::UnambiguousDeltaRayTool, lar_content::UnattachedDeltaRaysAlgorithm, lar_content::BranchAssociatedPfosTool, lar_content::EndAssociatedPfosTool, lar_content::EventSlicingTool, lar_content::NeutrinoCreationAlgorithm, lar_content::NeutrinoDaughterVerticesAlgorithm, lar_content::NeutrinoHierarchyAlgorithm, lar_content::NeutrinoPropertiesAlgorithm, lar_content::TestBeamParticleCreationAlgorithm, lar_content::VertexAssociatedPfosTool, lar_content::HitCreationBaseTool, lar_content::LongitudinalTrackHitsBaseTool, lar_content::ShowerHitsBaseTool, lar_content::ThreeDHitCreationAlgorithm, lar_content::ThreeViewShowerHitsTool, lar_content::TrackHitsBaseTool, lar_content::ClearLongitudinalTracksTool, lar_content::MatchedEndPointsTool, lar_content::ThreeViewLongitudinalTracksAlgorithm, lar_content::RecursivePfoMopUpAlgorithm, lar_content::ShowerHierarchyMopUpAlgorithm, lar_content::ShowerPfoMopUpAlgorithm, lar_content::SlidingConePfoMopUpAlgorithm, lar_content::VertexBasedPfoMopUpAlgorithm, lar_content::ParticleRecoveryAlgorithm, lar_content::VertexBasedPfoRecoveryAlgorithm, lar_content::ClearRemnantsTool, lar_content::ConnectedRemnantsTool, lar_content::MopUpRemnantsTool, lar_content::ThreeViewRemnantsAlgorithm, lar_content::ClearShowersTool, lar_content::SimpleShowersTool, lar_content::SplitShowersTool, lar_content::ThreeViewShowersAlgorithm, lar_content::MatchingBaseAlgorithm, lar_content::NViewMatchingAlgorithm< T >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::ClearTrackFragmentsTool, lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ClearTracksTool, lar_content::LongTracksTool, lar_content::MissingTrackSegmentTool, lar_content::MissingTrackTool, lar_content::OvershootTracksTool, lar_content::ThreeDKinkBaseTool, lar_content::ThreeViewTransverseTracksAlgorithm, lar_content::TracksCrossingGapsTool, lar_content::TrackSplittingTool, lar_content::UndershootTracksTool, lar_content::TwoViewClearTracksTool, lar_content::TwoViewLongTracksTool, lar_content::TwoViewSimpleTracksTool, lar_content::TwoViewThreeDKinkTool, lar_content::TwoViewTransverseTracksAlgorithm, lar_content::BranchGrowingAlgorithm, lar_content::ClusterCharacterisationBaseAlgorithm, lar_content::CutClusterCharacterisationAlgorithm, lar_content::CutPfoCharacterisationAlgorithm, lar_content::MvaPfoCharacterisationAlgorithm< T >, lar_content::PfoCharacterisationBaseAlgorithm, lar_content::ShowerGrowingAlgorithm, lar_content::TwoDShowerFitFeatureTool, lar_content::TwoDLinearFitFeatureTool, lar_content::TwoDVertexDistanceFeatureTool, lar_content::PfoHierarchyFeatureTool, lar_content::ThreeDLinearFitFeatureTool, lar_content::ThreeDVertexDistanceFeatureTool, lar_content::ConeChargeFeatureTool, lar_content::ThreeDOpeningAngleFeatureTool, lar_content::ThreeDPCAFeatureTool, lar_content::ThreeDChargeFeatureTool, lar_content::ClusterAssociationAlgorithm, lar_content::ClusterGrowingAlgorithm, lar_content::ClusterMergingAlgorithm, lar_content::CrossGapsAssociationAlgorithm, lar_content::CrossGapsExtensionAlgorithm, lar_content::HitWidthClusterMergingAlgorithm, lar_content::LongitudinalAssociationAlgorithm, lar_content::LongitudinalExtensionAlgorithm, lar_content::SimpleClusterGrowingAlgorithm, lar_content::SimpleClusterMergingAlgorithm, lar_content::TransverseAssociationAlgorithm, lar_content::TransverseExtensionAlgorithm, lar_content::ClusteringParentAlgorithm, lar_content::SimpleClusterCreationAlgorithm, lar_content::TrackClusterCreationAlgorithm, lar_content::BoundedClusterMopUpAlgorithm, lar_content::ClusterMopUpBaseAlgorithm, lar_content::ConeClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, lar_content::NearbyClusterMopUpAlgorithm, lar_content::SlidingConeClusterMopUpAlgorithm, lar_content::BranchSplittingAlgorithm, lar_content::ClusterSplittingAlgorithm, lar_content::CrossedTrackSplittingAlgorithm, lar_content::DeltaRaySplittingAlgorithm, lar_content::KinkSplittingAlgorithm, lar_content::LayerSplittingAlgorithm, lar_content::OvershootSplittingAlgorithm, lar_content::TrackConsolidationAlgorithm, lar_content::TwoDSlidingFitConsolidationAlgorithm, lar_content::TwoDSlidingFitMultiSplitAlgorithm, lar_content::TwoDSlidingFitSplittingAlgorithm, lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm, lar_content::TwoDSlidingFitSplittingAndSwitchingAlgorithm, lar_content::VertexSplittingAlgorithm, lar_content::CosmicRayExtensionAlgorithm, lar_content::CosmicRaySplittingAlgorithm, lar_content::DeltaRayExtensionAlgorithm, lar_content::DeltaRayGrowingAlgorithm, 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::MopUpBaseAlgorithm, lar_content::PfoHitCleaningAlgorithm, lar_content::PfoMopUpBaseAlgorithm, lar_content::AsymmetryFeatureBaseTool, lar_content::CandidateVertexCreationAlgorithm, lar_content::EnergyKickFeatureTool, lar_content::EnergyKickVertexSelectionAlgorithm, lar_content::HitAngleVertexSelectionAlgorithm, lar_content::MvaVertexSelectionAlgorithm< T >, lar_content::RPhiFeatureTool, lar_content::TrainedVertexSelectionAlgorithm, lar_content::VertexRefinementAlgorithm, lar_content::VertexSelectionBaseAlgorithm, lar_dl_content::DLMasterAlgorithm, lar_dl_content::DlHitValidationAlgorithm, lar_dl_content::DlClusterCharacterisationAlgorithm, lar_dl_content::DlHitTrackShowerIdAlgorithm, lar_dl_content::DlPfoCharacterisationAlgorithm, lar_dl_content::DlTrackShowerStreamSelectionAlgorithm, lar_dl_content::DlVertexingAlgorithm, EventReadingAlgorithm, EventWritingAlgorithm, TemplateAlgorithm, TemplateAlgorithmTool, lar_content::EnergyDepositionAsymmetryFeatureTool, lar_content::GlobalAsymmetryFeatureTool, lar_content::LocalAsymmetryFeatureTool, lar_content::ShowerAsymmetryFeatureTool, lar_content::RemovalBaseTool, and lar_content::TrackRefinementBaseAlgorithm.

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

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:

Friends And Related Symbol Documentation

PluginManager

friend class PluginManager

friend

Definition at line 128 of file ShowerProfilePlugin.h.

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

• PandoraSDK/include/Plugins/ShowerProfilePlugin.h