LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
LArPandora.h
Go to the documentation of this file.
1 
8 #ifndef LAR_PANDORA_H
9 #define LAR_PANDORA_H 1
10 
11 #include "larpandora/LArPandoraInterface/ILArPandora.h"
12 #include "larpandora/LArPandoraInterface/LArPandoraInput.h"
13 #include "larpandora/LArPandoraInterface/LArPandoraOutput.h"
14 
15 #include "larpandora/LArPandoraInterface/LArPandoraHitCollectionTool.h"
16 
17 #include <string>
18 
19 namespace lar_pandora {
20 
24  class LArPandora : public ILArPandora {
25  public:
31  LArPandora(fhicl::ParameterSet const& pset);
32 
33  void beginJob();
34  void produce(art::Event& evt);
35 
36  protected:
37  void CreatePandoraInput(art::Event& evt, IdToHitMap& idToHitMap);
38  void ProcessPandoraOutput(art::Event& evt, const IdToHitMap& idToHitMap);
39 
40  fhicl::ParameterSet ConstructHitCollectionToolParameterSet(const fhicl::ParameterSet& pset);
41 
42  std::string m_configFile;
43 
44  bool
45  m_shouldRunAllHitsCosmicReco;
46  bool
47  m_shouldRunStitching;
48  bool m_shouldRunCosmicHitRemoval;
49  bool
50  m_shouldRunSlicing;
51  bool
52  m_shouldRunNeutrinoRecoOption;
53  bool
54  m_shouldRunCosmicRecoOption;
55  bool
56  m_shouldPerformSliceId;
57  bool m_shouldProduceAllOutcomes;
58  bool m_printOverallRecoStatus;
59 
60  std::string m_generatorModuleLabel;
61  std::string m_geantModuleLabel;
62  std::string m_simChannelModuleLabel;
63  std::string m_hitfinderModuleLabel;
64  std::string m_backtrackerModuleLabel;
65 
66  std::string m_allOutcomesInstanceLabel;
67 
68  bool m_enableProduction;
69  bool m_enableDetectorGaps;
70  bool
71  m_enableMCParticles;
72  bool
73  m_disableRealDataCheck;
74  bool m_lineGapsCreated;
75 
76  std::unique_ptr<IHitCollectionTool> m_collectHitsTool;
77 
78  LArPandoraInput::Settings m_inputSettings;
79  LArPandoraOutput::Settings m_outputSettings;
80 
81  LArDriftVolumeMap m_driftVolumeMap;
82  };
83 
84 } // namespace lar_pandora
85 
86 #endif // #ifndef LAR_PANDORA_H
lar_pandora::IdToHitMap
std::map< int, art::Ptr< recob::Hit > > IdToHitMap
Definition: ILArPandora.h:24
ILArPandora.h
Interface class for LArPandora producer modules, which reconstruct recob::PFParticles from recob::Hit...
lar_pandora::LArPandora::m_allOutcomesInstanceLabel
std::string m_allOutcomesInstanceLabel
The instance label for all outcomes.
Definition: LArPandora.h:66
lar_pandora::LArPandora::CreatePandoraInput
void CreatePandoraInput(art::Event &evt, IdToHitMap &idToHitMap)
Create pandora input hits, mc particles etc.
Definition: LArPandora.cxx:175
lar_pandora::ILArPandora
ILArPandora class.
Definition: ILArPandora.h:29
lar_pandora
Definition: ConsolidatedPFParticleAnalysisTemplate_module.cc:18
lar_pandora::LArDriftVolumeMap
std::map< unsigned int, LArDriftVolume > LArDriftVolumeMap
Definition: LArPandoraGeometryComponents.h:315
lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco
bool m_shouldRunAllHitsCosmicReco
Steering: whether to run all hits cosmic-ray reconstruction.
Definition: LArPandora.h:45
lar_pandora::LArPandoraOutput::Settings
Settings class.
Definition: LArPandoraOutput.h:80
lar_pandora::LArPandora::m_disableRealDataCheck
bool m_disableRealDataCheck
Whether to check if the input file contains real data before accessing MC information.
Definition: LArPandora.h:73
lar_pandora::LArPandora::m_shouldProduceAllOutcomes
bool m_shouldProduceAllOutcomes
Steering: whether to produce all reconstruction outcomes.
Definition: LArPandora.h:57
LArPandoraOutput.h
Helper functions for processing outputs from pandora.
lar_pandora::LArPandora::m_backtrackerModuleLabel
std::string m_backtrackerModuleLabel
The back tracker module label.
Definition: LArPandora.h:64
lar_pandora::LArPandoraInput::Settings
Settings class.
Definition: LArPandoraInput.h:34
lar_pandora::LArPandora::m_lineGapsCreated
bool m_lineGapsCreated
Book-keeping: whether line gap creation has been called.
Definition: LArPandora.h:74
lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval
bool m_shouldRunCosmicHitRemoval
Steering: whether to remove hits from tagged cosmic-rays.
Definition: LArPandora.h:48
lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption
bool m_shouldRunNeutrinoRecoOption
Steering: whether to run neutrino reconstruction for each slice.
Definition: LArPandora.h:52
lar_pandora::LArPandora::ConstructHitCollectionToolParameterSet
fhicl::ParameterSet ConstructHitCollectionToolParameterSet(const fhicl::ParameterSet &pset)
Definition: LArPandora.cxx:256
lar_pandora::LArPandora::m_driftVolumeMap
LArDriftVolumeMap m_driftVolumeMap
The map from volume id to drift volume.
Definition: LArPandora.h:81
lar_pandora::LArPandora::m_printOverallRecoStatus
bool m_printOverallRecoStatus
Steering: whether to print current operation status messages.
Definition: LArPandora.h:58
lar_pandora::LArPandora::m_generatorModuleLabel
std::string m_generatorModuleLabel
The generator module label.
Definition: LArPandora.h:60
lar_pandora::LArPandora::m_geantModuleLabel
std::string m_geantModuleLabel
The geant module label.
Definition: LArPandora.h:61
lar_pandora::LArPandora::ProcessPandoraOutput
void ProcessPandoraOutput(art::Event &evt, const IdToHitMap &idToHitMap)
Process pandora output particle flow objects.
Definition: LArPandora.cxx:240
lar_pandora::LArPandora::m_shouldRunCosmicRecoOption
bool m_shouldRunCosmicRecoOption
Steering: whether to run cosmic-ray reconstruction for each slice.
Definition: LArPandora.h:54
lar_pandora::LArPandora::LArPandora
LArPandora(fhicl::ParameterSet const &pset)
Constructor.
Definition: LArPandora.cxx:42
lar_pandora::LArPandora::m_configFile
std::string m_configFile
The config file.
Definition: LArPandora.h:42
lar_pandora::LArPandora::m_enableDetectorGaps
bool m_enableDetectorGaps
Whether to pass detector gap information to Pandora instances.
Definition: LArPandora.h:69
lar_pandora::LArPandora::produce
void produce(art::Event &evt)
Definition: LArPandora.cxx:164
lar_pandora::LArPandora::m_shouldRunStitching
bool m_shouldRunStitching
Steering: whether to stitch cosmic-ray muons crossing between volumes.
Definition: LArPandora.h:47
lar_pandora::LArPandora::m_inputSettings
LArPandoraInput::Settings m_inputSettings
The lar pandora input settings.
Definition: LArPandora.h:78
lar_pandora::LArPandora::beginJob
void beginJob()
Definition: LArPandora.cxx:133
lar_pandora::LArPandora::m_outputSettings
LArPandoraOutput::Settings m_outputSettings
The lar pandora output settings.
Definition: LArPandora.h:79
lar_pandora::LArPandora::m_collectHitsTool
std::unique_ptr< IHitCollectionTool > m_collectHitsTool
art tool used to collect the hits
Definition: LArPandora.h:76
LArPandoraInput.h
Helper functions for providing inputs to pandora.
lar_pandora::LArPandora::m_shouldRunSlicing
bool m_shouldRunSlicing
Steering: whether to slice events into separate regions for processing.
Definition: LArPandora.h:50
tca::evt
TCEvent evt
Definition: DataStructs.cxx:8
lar_pandora::LArPandora::m_enableMCParticles
bool m_enableMCParticles
Whether to pass mc information to Pandora instances to aid development.
Definition: LArPandora.h:71
lar_pandora::LArPandora
LArPandora class.
Definition: LArPandora.h:24
lar_pandora::LArPandora::m_enableProduction
bool m_enableProduction
Whether to persist output products.
Definition: LArPandora.h:68
lar_pandora::LArPandora::m_simChannelModuleLabel
std::string m_simChannelModuleLabel
The SimChannel producer module label.
Definition: LArPandora.h:62
lar_pandora::LArPandora::m_shouldPerformSliceId
bool m_shouldPerformSliceId
Steering: whether to identify slices and select most appropriate pfos.
Definition: LArPandora.h:56
lar_pandora::LArPandora::m_hitfinderModuleLabel
std::string m_hitfinderModuleLabel
The hit finder module label.
Definition: LArPandora.h:63