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

LArPandora class. More...

#include "LArPandora.h"

Inheritance diagram for lar_pandora::LArPandora:
Inheritance graph
[legend]
Collaboration diagram for lar_pandora::LArPandora:
Collaboration graph
[legend]

Public Member Functions

 LArPandora (fhicl::ParameterSet const &pset)
 Constructor.
 
void beginJob ()
 
void produce (art::Event &evt)
 

Protected Member Functions

void CreatePandoraInput (art::Event &evt, IdToHitMap &idToHitMap)
 Create pandora input hits, mc particles etc.
 
void ProcessPandoraOutput (art::Event &evt, const IdToHitMap &idToHitMap)
 Process pandora output particle flow objects.
 
fhicl::ParameterSet ConstructHitCollectionToolParameterSet (const fhicl::ParameterSet &pset)
 
virtual void CreatePandoraInstances ()=0
 Create pandora instances.
 
virtual void ConfigurePandoraInstances ()=0
 Configure pandora instances.
 
virtual void DeletePandoraInstances ()=0
 Delete pandora instances.
 
virtual void RunPandoraInstances ()=0
 Run all associated pandora instances.
 
virtual void ResetPandoraInstances ()=0
 Reset all associated pandora instances.
 

Protected Attributes

std::string m_configFile
 The config file.
 
bool m_shouldRunAllHitsCosmicReco
 Steering: whether to run all hits cosmic-ray reconstruction.
 
bool m_shouldRunStitching
 Steering: whether to stitch cosmic-ray muons crossing between volumes.
 
bool m_shouldRunCosmicHitRemoval
 Steering: whether to remove hits from tagged cosmic-rays.
 
bool m_shouldRunSlicing
 Steering: whether to slice events into separate regions for processing.
 
bool m_shouldRunNeutrinoRecoOption
 Steering: whether to run neutrino reconstruction for each slice.
 
bool m_shouldRunCosmicRecoOption
 Steering: whether to run cosmic-ray reconstruction for each slice.
 
bool m_shouldPerformSliceId
 Steering: whether to identify slices and select most appropriate pfos.
 
bool m_shouldProduceAllOutcomes
 Steering: whether to produce all reconstruction outcomes.
 
bool m_printOverallRecoStatus
 Steering: whether to print current operation status messages.
 
std::string m_generatorModuleLabel
 The generator module label.
 
std::string m_geantModuleLabel
 The geant module label.
 
std::string m_simChannelModuleLabel
 The SimChannel producer module label.
 
std::string m_hitfinderModuleLabel
 The hit finder module label.
 
std::string m_backtrackerModuleLabel
 The back tracker module label.
 
std::string m_allOutcomesInstanceLabel
 The instance label for all outcomes.
 
bool m_enableProduction
 Whether to persist output products.
 
bool m_enableDetectorGaps
 Whether to pass detector gap information to Pandora instances.
 
bool m_enableMCParticles
 Whether to pass mc information to Pandora instances to aid development.
 
bool m_disableRealDataCheck
 Whether to check if the input file contains real data before accessing MC information.
 
bool m_lineGapsCreated
 Book-keeping: whether line gap creation has been called.
 
std::unique_ptr< IHitCollectionTool > m_collectHitsTool
 art tool used to collect the hits
 
LArPandoraInput::Settings m_inputSettings
 The lar pandora input settings.
 
LArPandoraOutput::Settings m_outputSettings
 The lar pandora output settings.
 
LArDriftVolumeMap m_driftVolumeMap
 The map from volume id to drift volume.
 
const pandora::Pandora * m_pPrimaryPandora
 The address of the primary pandora instance.
 

Detailed Description

LArPandora class.

Definition at line 24 of file LArPandora.h.

Constructor & Destructor Documentation

◆ LArPandora()

lar_pandora::LArPandora::LArPandora ( fhicl::ParameterSet const &  pset)

Constructor.

Parameters
psetthe parameter set

Definition at line 42 of file LArPandora.cxx.

Member Function Documentation

◆ beginJob()

void lar_pandora::LArPandora::beginJob ( )

Definition at line 133 of file LArPandora.cxx.

Here is the call graph for this function:

◆ ConfigurePandoraInstances()

virtual void lar_pandora::ILArPandora::ConfigurePandoraInstances ( )
protectedpure virtualinherited

Configure pandora instances.

Implemented in lar_pandora::StandardPandora.

Here is the caller graph for this function:

◆ ConstructHitCollectionToolParameterSet()

fhicl::ParameterSet lar_pandora::LArPandora::ConstructHitCollectionToolParameterSet ( const fhicl::ParameterSet &  pset)
protected

Definition at line 256 of file LArPandora.cxx.

◆ CreatePandoraInput()

void lar_pandora::LArPandora::CreatePandoraInput ( art::Event &  evt,
IdToHitMap &  idToHitMap 
)
protectedvirtual

Create pandora input hits, mc particles etc.

Parameters
evtthe art event
idToHitMapto receive the populated pandora hit id to art hit map

Implements lar_pandora::ILArPandora.

Definition at line 175 of file LArPandora.cxx.

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

◆ CreatePandoraInstances()

virtual void lar_pandora::ILArPandora::CreatePandoraInstances ( )
protectedpure virtualinherited

Create pandora instances.

Implemented in lar_pandora::StandardPandora.

Here is the caller graph for this function:

◆ DeletePandoraInstances()

virtual void lar_pandora::ILArPandora::DeletePandoraInstances ( )
protectedpure virtualinherited

Delete pandora instances.

Implemented in lar_pandora::StandardPandora.

◆ ProcessPandoraOutput()

void lar_pandora::LArPandora::ProcessPandoraOutput ( art::Event &  evt,
const IdToHitMap &  idToHitMap 
)
protectedvirtual

Process pandora output particle flow objects.

Parameters
evtthe art event
idToHitMapthe pandora hit id to art hit map

Implements lar_pandora::ILArPandora.

Definition at line 240 of file LArPandora.cxx.

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

◆ produce()

void lar_pandora::LArPandora::produce ( art::Event &  evt)

Definition at line 164 of file LArPandora.cxx.

Here is the call graph for this function:

◆ ResetPandoraInstances()

virtual void lar_pandora::ILArPandora::ResetPandoraInstances ( )
protectedpure virtualinherited

Reset all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

Here is the caller graph for this function:

◆ RunPandoraInstances()

virtual void lar_pandora::ILArPandora::RunPandoraInstances ( )
protectedpure virtualinherited

Run all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

Here is the caller graph for this function:

Member Data Documentation

◆ m_allOutcomesInstanceLabel

std::string lar_pandora::LArPandora::m_allOutcomesInstanceLabel
protected

The instance label for all outcomes.

Definition at line 66 of file LArPandora.h.

◆ m_backtrackerModuleLabel

std::string lar_pandora::LArPandora::m_backtrackerModuleLabel
protected

The back tracker module label.

Definition at line 64 of file LArPandora.h.

◆ m_collectHitsTool

std::unique_ptr<IHitCollectionTool> lar_pandora::LArPandora::m_collectHitsTool
protected

art tool used to collect the hits

Definition at line 76 of file LArPandora.h.

◆ m_configFile

std::string lar_pandora::LArPandora::m_configFile
protected

The config file.

Definition at line 42 of file LArPandora.h.

◆ m_disableRealDataCheck

bool lar_pandora::LArPandora::m_disableRealDataCheck
protected

Whether to check if the input file contains real data before accessing MC information.

Definition at line 73 of file LArPandora.h.

◆ m_driftVolumeMap

LArDriftVolumeMap lar_pandora::LArPandora::m_driftVolumeMap
protected

The map from volume id to drift volume.

Definition at line 81 of file LArPandora.h.

◆ m_enableDetectorGaps

bool lar_pandora::LArPandora::m_enableDetectorGaps
protected

Whether to pass detector gap information to Pandora instances.

Definition at line 69 of file LArPandora.h.

◆ m_enableMCParticles

bool lar_pandora::LArPandora::m_enableMCParticles
protected

Whether to pass mc information to Pandora instances to aid development.

Definition at line 71 of file LArPandora.h.

◆ m_enableProduction

bool lar_pandora::LArPandora::m_enableProduction
protected

Whether to persist output products.

Definition at line 68 of file LArPandora.h.

◆ m_geantModuleLabel

std::string lar_pandora::LArPandora::m_geantModuleLabel
protected

The geant module label.

Definition at line 61 of file LArPandora.h.

◆ m_generatorModuleLabel

std::string lar_pandora::LArPandora::m_generatorModuleLabel
protected

The generator module label.

Definition at line 60 of file LArPandora.h.

◆ m_hitfinderModuleLabel

std::string lar_pandora::LArPandora::m_hitfinderModuleLabel
protected

The hit finder module label.

Definition at line 63 of file LArPandora.h.

◆ m_inputSettings

LArPandoraInput::Settings lar_pandora::LArPandora::m_inputSettings
protected

The lar pandora input settings.

Definition at line 78 of file LArPandora.h.

◆ m_lineGapsCreated

bool lar_pandora::LArPandora::m_lineGapsCreated
protected

Book-keeping: whether line gap creation has been called.

Definition at line 74 of file LArPandora.h.

◆ m_outputSettings

LArPandoraOutput::Settings lar_pandora::LArPandora::m_outputSettings
protected

The lar pandora output settings.

Definition at line 79 of file LArPandora.h.

◆ m_pPrimaryPandora

const pandora::Pandora* lar_pandora::ILArPandora::m_pPrimaryPandora
protectedinherited

The address of the primary pandora instance.

Definition at line 85 of file ILArPandora.h.

◆ m_printOverallRecoStatus

bool lar_pandora::LArPandora::m_printOverallRecoStatus
protected

Steering: whether to print current operation status messages.

Definition at line 58 of file LArPandora.h.

◆ m_shouldPerformSliceId

bool lar_pandora::LArPandora::m_shouldPerformSliceId
protected

Steering: whether to identify slices and select most appropriate pfos.

Definition at line 56 of file LArPandora.h.

◆ m_shouldProduceAllOutcomes

bool lar_pandora::LArPandora::m_shouldProduceAllOutcomes
protected

Steering: whether to produce all reconstruction outcomes.

Definition at line 57 of file LArPandora.h.

◆ m_shouldRunAllHitsCosmicReco

bool lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco
protected

Steering: whether to run all hits cosmic-ray reconstruction.

Definition at line 45 of file LArPandora.h.

◆ m_shouldRunCosmicHitRemoval

bool lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval
protected

Steering: whether to remove hits from tagged cosmic-rays.

Definition at line 48 of file LArPandora.h.

◆ m_shouldRunCosmicRecoOption

bool lar_pandora::LArPandora::m_shouldRunCosmicRecoOption
protected

Steering: whether to run cosmic-ray reconstruction for each slice.

Definition at line 54 of file LArPandora.h.

◆ m_shouldRunNeutrinoRecoOption

bool lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption
protected

Steering: whether to run neutrino reconstruction for each slice.

Definition at line 52 of file LArPandora.h.

◆ m_shouldRunSlicing

bool lar_pandora::LArPandora::m_shouldRunSlicing
protected

Steering: whether to slice events into separate regions for processing.

Definition at line 50 of file LArPandora.h.

◆ m_shouldRunStitching

bool lar_pandora::LArPandora::m_shouldRunStitching
protected

Steering: whether to stitch cosmic-ray muons crossing between volumes.

Definition at line 47 of file LArPandora.h.

◆ m_simChannelModuleLabel

std::string lar_pandora::LArPandora::m_simChannelModuleLabel
protected

The SimChannel producer module label.

Definition at line 62 of file LArPandora.h.

The documentation for this class was generated from the following files: