Classes | Public Member Functions | Private Member Functions | List of all members
art::detail::Analyzer Class Referenceabstract

#include <Analyzer.h>

Inheritance diagram for art::detail::Analyzer:
art::Observer art::ModuleBase art::EDAnalyzer art::ReplicatedAnalyzer art::SharedAnalyzer AnalysisExample::dEdx art::test::DummyAnalyzer art::test::MyServiceUser arttest::FPCTest arttest::PMTestAnalyzer AssnAnalyzer BackTrackerAna beam::ReadBeamInfo caldata::CalWireAna caldata::DumpWires caldata::FFTTest CalibrationTreeBuilder::CalibrationTreeBuilder calo::CaloChecker calo::PrintCalorimetry ChargedSpacePointProxyTest cheat::CheckBackTracking cheat::RecoCheckAna CheckDPhaseGeometry cluster::ClusterAna cluster::ClusterPCA cluster::ClusterTrackAna cluster::DBclusterAna cluster::HoughLineFinderAna ClusterHitTime ClusteringValidation::ClusteringValidation cnn::RegCNNEventDump cosmic::CosmicEfficiency CRT::CRTSimValidation CRT::CRTTimingValidation CRT::SingleCRTMatching CRT::TimeOffset CRT::TwoCRTMatching CRT::TwoCRTReco CRTOnlineMonitor ctp::CTPTrackDump cvn::CVNEventDump cvn::CVNEventDumpProtoDUNE cvn::CVNSparseROOT cvn::CVNValidation cvn::CVNZlibMaker cvn::CVNZlibMakerProtoDUNE cvn::GCNH5 cvn::GCNZlibMaker cvn::GCNZlibMakerProtoDUNE DAQQuickClustering DAQSimAna DataHit detsim::DumpOpDetWaveforms detsim::DumpRawDigits detsim::SimDriftedElectronClusterAna detsim::SimWireAna detsim::WienerFilterAna disambigcheck::disambigcheck DriftAna DualPhaseOpHitDumper dune::AnalysisTree dune::AnaRootParser dune::CheckAuxDet dune::CheckGeometry dune::CheckRecoEnergy dune::dEdxcalibration dune::FelixIntegrityTest dune::michelremoving DUNE::MuonTrackingEff DUNE::NeutrinoShowerEff DUNE::NeutrinoTrackingEff dune::PFPEfficiency dune::protonanalysis dune::SignalToNoise dune::XYZcalibration dunefd::NueAna dunemva::CAFMaker dunezsanalysis::dunezsanalysis ems::MultiEMShowers emshower::EMEnergyCalib emshower::EMPi0Energy evd::EVD evd::WebEVD ex::HelloAuxDet gar::anatest gar::anatree gar::CAFMaker gar::evd3d::EventDisplay3D gar::evd::EVD gar::garg4::GArG4Ana gar::HNLAnalysis gar::MatchingPerformance gar::MomentumPerformance gar::ParamSim gar::rosim::RawDigitAna gar::StructuredTree geo::DumpChannelMap geo::DumpGeometry geo::GeometryInfoCheck geo::GeometryIteratorLoopTest geo::GeometryTest GoodWireAna hit::DumpHits hit::GausHitFinderAna hit::HitAnaModule hit::HitFinderAna hit::MagDriftAna hit::MCHitAnaExample HitSdpPlotter::HitSdpPlotter icebergpd::ICEBERGPDSSPMonitor Infill::MakeInfillTrainingData issue19191 lar::ComputePi lar::example::AnalysisExample lar::example::Exploder lar::example::tests::AtomicNumberTest lar::example::tests::CheckDataProductSize lar::example::tests::DumpCheatTracks lar::example::tests::ShowerCalibrationGaloreTest lar::ServicePackTest lar::test::AssnsChainTest lar_pandora::ConsolidatedPFParticleAnalysisTemplate lar_pandora::LArPandoraEventDump lar_pandora::PFParticleAnalysis lar_pandora::PFParticleCosmicAna lar_pandora::PFParticleHitDumper lar_pandora::PFParticleMonitoring lar_pandora::PFParticleTrackAna lar_pandora::PFParticleValidation larg4::CheckAuxDetHit larg4::CheckMCParticle larg4::CheckSimEnergyDeposit larg4::ISCalcAna larg4::LArG4Ana larg::LArSimChannelAna lariov::SimpleChannelStatusTest MakeSNeTProfileHistos MCBTDemo MichelReco::MichelReco MichelReco::MichelReco microboone::CosmicRemovalAna myana::RegCNNAna myana::RegCNNVertexAna NeutronDecayN2Ana::NeutronDecayN2Ana nlana::PlotEventDetails nlana::PlotOpticalDetails nlana::PlotTrackDetails nlana::PlotTrackT0 nlana::SPLifetime nlana::SSPMonitor nnet::EvaluateROIEff nnet::PointIdEffTest nnet::PointIdTrainingData nnet::RawWaveformClnSigDump nnet::RawWaveformDump nnet::SPMultiTpcDump NuShowerEff opdet::AverageWaveform opdet::CalibrationAnalysis opdet::FIFOHistogramAna opdet::FlashHypothesisAna opdet::FlashMatchAna opdet::LEDCalibrationAna opdet::OpDetDigiAnaDUNE opdet::OpDigiAna opdet::OpFlashAna opdet::OpFlashMCTruthAna opdet::OpFlashSimpleAna opdet::OpHitAna opdet::ProtoDUNE_opdet_eventdisplay opdet::ProtoDUNE_opdet_eventdisplay opdet::SimPhotonCounter opreco::OpticalRecoAna PackedDump pd_monitor::PDWaveform pddp::recobWireCheck pddpana::CosmicsdQdx pddpana::TrackHitInfo PDDPTPCRawDecoderTest pdsp::CheckCNNScore pdsp::CheckCRT pdsp::CheckT0 pdsp::CRTMatchTrackCaloAna pdsp::EMCNNCheck pdsp::EMCNNCheckCosmics pdsp::HitAnaPDSP pdsp::MDMAna pdsp::MichelTiming pdsp::PDSPmatch pdsp::PDSPmatch pdsp::PDSPmatchmc pdsp::PDSPmatchmc pdsp::VtxScore pdsp::WireChgAna PDSPHitmonitor_module::PDSPHitMonitorModule PDSPNearlineheader_module::PDSPNearlineHeaderModule pdune::DataDump pdune::DataDumpHDF pdune::FakePedestal pdune::RawWaveformDump pdune::RecoEff pdune::RecoHitsEff pdune::RecoStats pduneana::PDSPAnalyzer pdunedp::DEdxdp pdunedp::Purity pfpf::PFPAna phot::CreateHybridLibrary phot::PhotonLibraryAnalyzer pid::DumpParticleIDs pid::PIDAAnalyzer pionana::TruthAnalyzer PionCrossSectionAnalyzer pmtana::PMTAna proto::DEdx proto::ECalibration proto::EdepCal proto::HadCal proto::SaveSpacePoints protoana::BeamExample protoana::diffusioncathodet0 protoana::driftvel protoana::G4RWExampleAnalyzer protoana::hitrms protoana::hitrmsfinding protoana::hitrmsrawdigits protoana::mcsXsection protoana::pionanalysis protoana::pionanalysismc protoana::ProtoDUNEAnalCosmicTree protoana::ProtoDUNEAnalTree protoana::ProtoDUNEAnalysisTree protoana::ProtoDUNEBeamlineReco protoana::ProtoDUNEBeamTPCRecoEfficiency protoana::ProtoDUNEDPAnalCosmicTree protoana::ProtoDUNEelectronAnaTree protoana::ProtoDUNEPizeroAnaTree protoana::ProtoDUNETruthBeamParticle protoana::ProtoFlash protoana::proton4gen protoana::protonbeamana protoana::protonmc protoana::protonmccnn protoana::protonmcnorw protoana::truepion protoana::truepionXsection protoana::UtilityExample protoana::velocity ProtoDUNEelectronWireAna ProtonIdentification::ProtonIdentification ProxyBaseTest PtrMakerAnalyzer quad::EvalVtx raw_event_display::RawEventDisplay reco3d::PlotSpacePoints recob::DumpChargedSpacePoints recob::DumpClusters recob::DumpPCAxes recob::DumpPFParticles recob::DumpSeeds recob::DumpSpacePoints recob::DumpTracks recob::DumpVertices recob::test::HitDataProductChecker RecoProxyUsageExample RecoTrack::RecoTrack shower::TCShowerAnalysis shower::TCShowerElectronLikelihood shower::TCShowerTemplateMaker showerAna::ShowerAnalysis ShowerQuality Signal2Noise sim::DumpGTruth sim::DumpGTruth sim::DumpMCParticles sim::DumpMCParticles sim::DumpMCShowers sim::DumpMCTracks sim::DumpMCTruth sim::DumpMCTruth sim::DumpOpDetBacktrackerRecords sim::DumpOpDetDivRecs sim::DumpSimChannels sim::DumpSimEnergyDeposits sim::DumpSimPhotons sim::DumpSimPhotonsLite sim::POTaccumulator sim::ProtoDUNEBeamTPCMatching SNAna SupernovaAna T0RecoSCE T0RecoSCECalibrations test::HitNormCheck test::pandoraAnalysis TestGeneratedEventTimestamp TestHardwareMapper TimeDist::TimeDist tpc_monitor::IcebergTpcMonitor tpc_monitor::TpcMonitor TrackingEfficiency::TrackingEfficiency TrackProxyTest triggersim::TemplateTriggerAna trk::TrackContainmentAnalyzer trkf::SeedAna trkf::SpacePointAna trkf::TrackAna trkf::TrackAnaCT tutorial::ClusterCounter tutorial::ClusterCounter tutorial::ClusterCounter2 tutorial::ClusterCounter3 tutorial::ClusterCounter4 tutorial::ReadSpacePointAndCnn util::LArPropTest util::SignalShapingDUNE10ktTest util::SignalShapingDUNE35tTest vertex::AggregateVertexAna vertex::FeatureVertexFinderAna VLN::VLNEnergyAnalyzer VLN::VLNEnergyDataGen WaveformAndSimChannelDump WaveformDump WaveformPDSAndTruthDump WaveformsToTree wc::CellTree WebReaderTest

Classes

class  Table
 

Public Member Functions

virtual ~Analyzer () noexcept
 
 Analyzer (fhicl::ParameterSet const &pset)
 
template<typename Config >
 Analyzer (Table< Config > const &config)
 
void doBeginJob (SharedResources const &resources)
 
void doEndJob ()
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenOutputFiles (FileBlock const &fb)
 
void doRespondToCloseOutputFiles (FileBlock const &fb)
 
bool doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doEndRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
 
- Public Member Functions inherited from art::Observer
 ~Observer () noexcept
 
 Observer (Observer const &)=delete
 
 Observer (Observer &&)=delete
 
Observeroperator= (Observer const &)=delete
 
Observeroperator= (Observer &&)=delete
 
void registerProducts (ProductDescriptions &, ModuleDescription const &)
 
void fillDescriptions (ModuleDescription const &)
 
fhicl::ParameterSetID selectorConfig () const
 
- Public Member Functions inherited from art::ModuleBase
virtual ~ModuleBase () noexcept
 
 ModuleBase ()
 
ModuleDescription const & moduleDescription () const
 
void setModuleDescription (ModuleDescription const &)
 
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables () const
 
void sortConsumables (std::string const &current_process_name)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Private Member Functions

virtual void setupQueues (SharedResources const &)=0
 
virtual void analyzeWithFrame (Event const &, ProcessingFrame const &)=0
 
virtual void beginJobWithFrame (ProcessingFrame const &)=0
 
virtual void endJobWithFrame (ProcessingFrame const &)=0
 
virtual void respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &)=0
 
virtual void respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &)=0
 
virtual void respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &)=0
 
virtual void respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &)=0
 
virtual void beginRunWithFrame (Run const &, ProcessingFrame const &)=0
 
virtual void endRunWithFrame (Run const &, ProcessingFrame const &)=0
 
virtual void beginSubRunWithFrame (SubRun const &, ProcessingFrame const &)=0
 
virtual void endSubRunWithFrame (SubRun const &, ProcessingFrame const &)=0
 

Additional Inherited Members

- Protected Member Functions inherited from art::Observer
std::string const & processName () const
 
bool wantAllEvents () const noexcept
 
bool wantEvent (ScheduleID id, Event const &e) const
 
Handle< TriggerResultsgetTriggerResults (Event const &e) const
 
 Observer (fhicl::ParameterSet const &config)
 
 Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollectorconsumesCollector ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 

Detailed Description

Definition at line 33 of file Analyzer.h.

Constructor & Destructor Documentation

art::detail::Analyzer::~Analyzer ( )
virtualdefaultnoexcept
art::detail::Analyzer::Analyzer ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 21 of file Analyzer.cc.

21 : Observer{pset} {}
Observer(Observer const &)=delete
template<typename Config >
art::detail::Analyzer::Analyzer ( Table< Config > const &  config)
inlineexplicit

Definition at line 94 of file Analyzer.h.

95  : Observer{config.eoFragment().selectEvents(), config.get_PSet()}
96  {}
static Config * config
Definition: config.cpp:1054
Observer(Observer const &)=delete

Member Function Documentation

virtual void art::detail::Analyzer::analyzeWithFrame ( Event const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::beginJobWithFrame ( ProcessingFrame const &  )
privatepure virtual
virtual void art::detail::Analyzer::beginRunWithFrame ( Run const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::beginSubRunWithFrame ( SubRun const &  ,
ProcessingFrame const &   
)
privatepure virtual
void art::detail::Analyzer::doBeginJob ( SharedResources const &  resources)

Definition at line 24 of file Analyzer.cc.

25  {
26  setupQueues(resources);
27  ProcessingFrame const frame{ScheduleID{}};
28  beginJobWithFrame(frame);
29  }
virtual void beginJobWithFrame(ProcessingFrame const &)=0
virtual void setupQueues(SharedResources const &)=0
bool art::detail::Analyzer::doBeginRun ( RunPrincipal rp,
ModuleContext const &  mc 
)

Definition at line 67 of file Analyzer.cc.

68  {
69  Run const r{rp, mc};
70  ProcessingFrame const frame{mc.scheduleID()};
71  beginRunWithFrame(r, frame);
72  return true;
73  }
virtual void beginRunWithFrame(Run const &, ProcessingFrame const &)=0
bool art::detail::Analyzer::doBeginSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)

Definition at line 85 of file Analyzer.cc.

86  {
87  SubRun const sr{srp, mc};
88  ProcessingFrame const frame{mc.scheduleID()};
89  beginSubRunWithFrame(sr, frame);
90  return true;
91  }
virtual void beginSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
static constexpr double sr
Definition: Units.h:166
void art::detail::Analyzer::doEndJob ( )

Definition at line 32 of file Analyzer.cc.

33  {
34  ProcessingFrame const frame{ScheduleID{}};
35  endJobWithFrame(frame);
36  }
virtual void endJobWithFrame(ProcessingFrame const &)=0
bool art::detail::Analyzer::doEndRun ( RunPrincipal rp,
ModuleContext const &  mc 
)

Definition at line 76 of file Analyzer.cc.

77  {
78  Run const r{rp, mc};
79  ProcessingFrame const frame{mc.scheduleID()};
80  endRunWithFrame(r, frame);
81  return true;
82  }
virtual void endRunWithFrame(Run const &, ProcessingFrame const &)=0
bool art::detail::Analyzer::doEndSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)

Definition at line 94 of file Analyzer.cc.

95  {
96  SubRun const sr{srp, mc};
97  ProcessingFrame const frame{mc.scheduleID()};
98  endSubRunWithFrame(sr, frame);
99  return true;
100  }
virtual void endSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
static constexpr double sr
Definition: Units.h:166
bool art::detail::Analyzer::doEvent ( EventPrincipal ep,
ModuleContext const &  mc,
std::atomic< std::size_t > &  counts_run,
std::atomic< std::size_t > &  counts_passed,
std::atomic< std::size_t > &  counts_failed 
)

Definition at line 103 of file Analyzer.cc.

108  {
109  Event const e{ep, mc};
110  if (wantEvent(mc.scheduleID(), e)) {
111  ++counts_run;
112  ProcessingFrame const frame{mc.scheduleID()};
113  analyzeWithFrame(e, frame);
114  ++counts_passed;
115  }
116  return true;
117  }
const double e
bool wantEvent(ScheduleID id, Event const &e) const
Definition: Observer.cc:74
Definition: types.h:32
virtual void analyzeWithFrame(Event const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const &  fb)

Definition at line 46 of file Analyzer.cc.

47  {
48  ProcessingFrame const frame{ScheduleID{}};
50  }
virtual void respondToCloseInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const &  fb)

Definition at line 60 of file Analyzer.cc.

61  {
62  ProcessingFrame const frame{ScheduleID{}};
64  }
virtual void respondToCloseOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const &  fb)

Definition at line 39 of file Analyzer.cc.

40  {
41  ProcessingFrame const frame{ScheduleID{}};
43  }
virtual void respondToOpenInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const &  fb)

Definition at line 53 of file Analyzer.cc.

54  {
55  ProcessingFrame const frame{ScheduleID{}};
57  }
virtual void respondToOpenOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
virtual void art::detail::Analyzer::endJobWithFrame ( ProcessingFrame const &  )
privatepure virtual
virtual void art::detail::Analyzer::endRunWithFrame ( Run const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::endSubRunWithFrame ( SubRun const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::respondToCloseInputFileWithFrame ( FileBlock const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::respondToCloseOutputFilesWithFrame ( FileBlock const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::respondToOpenInputFileWithFrame ( FileBlock const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::respondToOpenOutputFilesWithFrame ( FileBlock const &  ,
ProcessingFrame const &   
)
privatepure virtual
virtual void art::detail::Analyzer::setupQueues ( SharedResources const &  )
privatepure virtual

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