LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
larg4::CheckSimEnergyDeposit Class Reference
Inheritance diagram for larg4::CheckSimEnergyDeposit:
art::EDAnalyzer art::detail::Analyzer art::detail::LegacyModule art::Observer art::ModuleBase

Public Types

using ModuleType = EDAnalyzer
 

Public Member Functions

 CheckSimEnergyDeposit (fhicl::ParameterSet const &p)
 
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)
 
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)
 
std::unique_ptr< Worker > makeWorker (WorkerParams const &wp)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Protected Member Functions

std::string const & processName () const
 
bool wantAllEvents () const noexcept
 
bool wantEvent (ScheduleID id, Event const &e) const
 
Handle< TriggerResults > getTriggerResults (Event const &e) const
 
ConsumesCollector & consumesCollector ()
 
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 ()
 

Private Member Functions

void beginJob () override
 
void analyze (const art::Event &event) override
 

Private Attributes

TH1F * _hnHits {nullptr}
 
TH1F * _hEdep {nullptr}
 
TH1F * _hnumPhotons {nullptr}
 
TH1F * _hLandauPhotons {nullptr}
 
TH1F * _hLandauEdep {nullptr}
 
TH1F * _hSteplength {nullptr}
 
TNtuple * _ntuple {nullptr}
 

Detailed Description

Definition at line 27 of file CheckSimEnergyDeposit_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer
inherited

Definition at line 22 of file EDAnalyzer.h.

Constructor & Destructor Documentation

larg4::CheckSimEnergyDeposit::CheckSimEnergyDeposit ( fhicl::ParameterSet const &  p)
explicit

Definition at line 44 of file CheckSimEnergyDeposit_module.cc.

45  : art::EDAnalyzer(p)
46 {}

Member Function Documentation

void larg4::CheckSimEnergyDeposit::analyze ( const art::Event &  event)
overrideprivate

Definition at line 62 of file CheckSimEnergyDeposit_module.cc.

References _hEdep, _hLandauEdep, _hLandauPhotons, _hnHits, _hnumPhotons, _hSteplength, util::abs(), and DEFINE_ART_MODULE.

63 {
64  auto allSims = event.getMany<sim::SimEnergyDepositCollection>();
65  for (auto const& sims : allSims) {
66  double sumPhotons = 0.0;
67  double sumE = 0.0;
68  _hnHits->Fill(sims->size());
69  for (auto const& hit : *sims) {
70  // sum up energy deposit in a 1cm slice of liquid Argon.
71  if (std::abs(hit.EndZ()) < 0.5) {
72  sumPhotons = sumPhotons + hit.NumPhotons();
73  sumE = sumE + hit.Energy();
74  }
75  _hnumPhotons->Fill(hit.NumPhotons());
76  _hEdep->Fill(hit.Energy()); // energy deposit in MeV
77  _hSteplength->Fill(hit.StepLength()); // step length in cm
78  }
79  _hLandauPhotons->Fill(sumPhotons);
80  _hLandauEdep->Fill(sumE);
81  }
82 } // end analyze
util::abs
constexpr auto abs(T v)
Returns the absolute value of the argument.
Definition: constexpr_math.h:40
hit
Detector simulation of raw signals on wires.
Definition: DumpHits_module.cc:25
sim::SimEnergyDepositCollection
std::vector< SimEnergyDeposit > SimEnergyDepositCollection
Definition: SimEnergyDeposit.h:226
void larg4::CheckSimEnergyDeposit::beginJob ( )
overrideprivatevirtual

Reimplemented from art::EDAnalyzer.

Definition at line 48 of file CheckSimEnergyDeposit_module.cc.

References _hEdep, _hLandauEdep, _hLandauPhotons, _hnHits, _hnumPhotons, _hSteplength, and _ntuple.

49 {
50  art::ServiceHandle<art::TFileService const> tfs;
51  _hnHits = tfs->make<TH1F>("hnHits", "Number of SimEnergyDeposits", 300, 0, 0);
52  _hEdep = tfs->make<TH1F>("hEdep", "Energy deposition in SimEnergyDeposits", 100, 0., 0.02);
53  _hnumPhotons =
54  tfs->make<TH1F>("hnumPhotons", "number of photons per SimEnergyDeposit", 100, 0., 500.);
55  _hLandauPhotons = tfs->make<TH1F>("hLandauPhotons", "number of photons/cm", 100, 0., 2000000.);
56  _hLandauEdep = tfs->make<TH1F>("hLandauEdep", "Edep/cm", 100, 0., 10.);
57  _hSteplength = tfs->make<TH1F>("hSteplength", "geant 4 step length", 100, 0., 0.05);
58  _ntuple = tfs->make<TNtuple>(
59  "ntuple", "Demo ntuple", "Event:Edep:em_Edep:nonem_Edep:xpos:ypos:zpos:time");
60 } // end beginJob
template<typename T , BranchType BT>
ProductToken< T > art::ModuleBase::consumes ( InputTag const &  tag)
protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

62  {
63  return collector_.consumes<T, BT>(tag);
64  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
art::ConsumesCollector::consumes
ProductToken< T > consumes(InputTag const &)
Definition: ConsumesCollector.h:50
ConsumesCollector & art::ModuleBase::consumesCollector ( )
protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

58  {
59  return collector_;
60  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename T , BranchType BT>
void art::ModuleBase::consumesMany ( )
protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

76  {
77  collector_.consumesMany<T, BT>();
78  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::ModuleBase::consumesView ( InputTag const &  )
protectedinherited
template<typename T , BranchType BT>
ViewToken<T> art::ModuleBase::consumesView ( InputTag const &  tag)
inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

69  {
70  return collector_.consumesView<T, BT>(tag);
71  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
art::ConsumesCollector::consumesView
ViewToken< Element > consumesView(InputTag const &)
void art::detail::Analyzer::doBeginJob ( SharedResources const &  resources)
inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

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

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

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

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

85  {
86  ProcessingFrame const frame{mc.scheduleID()};
87  beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
88  return true;
89  }
art::detail::Analyzer::beginSubRunWithFrame
virtual void beginSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doEndJob ( )
inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

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

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

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

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

93  {
94  ProcessingFrame const frame{mc.scheduleID()};
95  endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
96  return true;
97  }
art::detail::Analyzer::endSubRunWithFrame
virtual void endSubRunWithFrame(SubRun const &, ProcessingFrame const &)=0
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 
)
inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

105  {
106  auto const e = std::as_const(ep).makeEvent(mc);
107  if (wantEvent(mc.scheduleID(), e)) {
108  ++counts_run;
109  ProcessingFrame const frame{mc.scheduleID()};
110  analyzeWithFrame(e, frame);
111  ++counts_passed;
112  }
113  return true;
114  }
art::Observer::wantEvent
bool wantEvent(ScheduleID id, Event const &e) const
Definition: Observer.cc:63
e
Float_t e
Definition: plot.C:35
art::detail::Analyzer::analyzeWithFrame
virtual void analyzeWithFrame(Event const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const &  fb)
inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

48  {
49  ProcessingFrame const frame{ScheduleID{}};
50  respondToCloseInputFileWithFrame(fb, frame);
51  }
fb
TFile fb("Li6.root")
art::detail::Analyzer::respondToCloseInputFileWithFrame
virtual void respondToCloseInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

62  {
63  ProcessingFrame const frame{ScheduleID{}};
64  respondToCloseOutputFilesWithFrame(fb, frame);
65  }
art::detail::Analyzer::respondToCloseOutputFilesWithFrame
virtual void respondToCloseOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
fb
TFile fb("Li6.root")
void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const &  fb)
inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

41  {
42  ProcessingFrame const frame{ScheduleID{}};
43  respondToOpenInputFileWithFrame(fb, frame);
44  }
fb
TFile fb("Li6.root")
art::detail::Analyzer::respondToOpenInputFileWithFrame
virtual void respondToOpenInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

55  {
56  ProcessingFrame const frame{ScheduleID{}};
57  respondToOpenOutputFilesWithFrame(fb, frame);
58  }
art::detail::Analyzer::respondToOpenOutputFilesWithFrame
virtual void respondToOpenOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
fb
TFile fb("Li6.root")
std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const
inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

44  {
45  return collector_.getConsumables();
46  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
art::ConsumesCollector::getConsumables
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables() const
Definition: ConsumesCollector.cc:13
Handle< TriggerResults > art::Observer::getTriggerResults ( Event const &  e) const
protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

76  {
77  if (selectors_) {
78  return selectors_->getOneTriggerResults(e);
79  }
80 
81  // The following applies for cases where no SelectEvents entries
82  // exist.
83  Handle<TriggerResults> h;
84  if (e.get(empty_process_name, h)) {
85  return h;
86  }
87  return Handle<TriggerResults>{};
88  }
e
Float_t e
Definition: plot.C:35
art::Observer::selectors_
std::optional< detail::ProcessAndEventSelectors > selectors_
Definition: Observer.h:79
std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const &  wp)
inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

38  {
39  return doMakeWorker(wp);
40  }
art::ModuleBase::doMakeWorker
virtual std::unique_ptr< Worker > doMakeWorker(WorkerParams const &wp)=0
template<typename T , BranchType BT>
ProductToken< T > art::ModuleBase::mayConsume ( InputTag const &  tag)
protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

83  {
84  return collector_.mayConsume<T, BT>(tag);
85  }
art::ConsumesCollector::mayConsume
ProductToken< T > mayConsume(InputTag const &)
Definition: ConsumesCollector.h:75
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename T , BranchType BT>
void art::ModuleBase::mayConsumeMany ( )
protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

97  {
98  collector_.mayConsumeMany<T, BT>();
99  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const &  )
protectedinherited
template<typename T , BranchType BT>
ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const &  tag)
inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

90  {
91  return collector_.mayConsumeView<T, BT>(tag);
92  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
art::ConsumesCollector::mayConsumeView
ViewToken< Element > mayConsumeView(InputTag const &)
ModuleDescription const & art::ModuleBase::moduleDescription ( ) const
inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

14  {
15  if (md_.has_value()) {
16  return *md_;
17  }
18 
19  throw Exception{errors::LogicError,
20  "There was an error while calling moduleDescription().\n"}
21  << "The moduleDescription() base-class member function cannot be called\n"
22  "during module construction. To determine which module is "
23  "responsible\n"
24  "for calling it, find the '<module type>:<module "
25  "label>@Construction'\n"
26  "tag in the message prefix above. Please contact artists@fnal.gov\n"
27  "for guidance.\n";
28  }
art::Exception
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
art::ModuleBase::md_
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
string const & art::Observer::processName ( ) const
protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

58  {
59  return process_name_;
60  }
art::Observer::process_name_
std::string process_name_
Definition: Observer.h:76
void art::ModuleBase::setModuleDescription ( ModuleDescription const &  md)
inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

32  {
33  md_ = md;
34  }
art::ModuleBase::md_
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
void art::ModuleBase::sortConsumables ( std::string const &  current_process_name)
inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

50  {
51  // Now that we know we have seen all the consumes declarations,
52  // sort the results for fast lookup later.
53  collector_.sortConsumables(current_process_name);
54  }
art::ModuleBase::collector_
ConsumesCollector collector_
Definition: ModuleBase.h:56
art::ConsumesCollector::sortConsumables
void sortConsumables(std::string const &current_process_name)
Definition: ConsumesCollector.cc:19
bool art::Observer::wantAllEvents ( ) const
inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

32  {
33  return wantAllEvents_;
34  }
art::Observer::wantAllEvents_
bool wantAllEvents_
Definition: Observer.h:75
bool art::Observer::wantEvent ( ScheduleID  id,
Event const &  e 
) const
protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

64  {
65  if (wantAllEvents_) {
66  return true;
67  }
68  bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
69  bool const reject_event =
70  rejectors_ ? rejectors_->matchEvent(id, e) : false;
71  return select_event and not reject_event;
72  }
art::Observer::wantAllEvents_
bool wantAllEvents_
Definition: Observer.h:75
art::Observer::rejectors_
std::optional< detail::ProcessAndEventSelectors > rejectors_
Definition: Observer.h:80
e
Float_t e
Definition: plot.C:35
art::Observer::selectors_
std::optional< detail::ProcessAndEventSelectors > selectors_
Definition: Observer.h:79

Member Data Documentation

TH1F* larg4::CheckSimEnergyDeposit::_hEdep {nullptr}
private

Definition at line 36 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TH1F* larg4::CheckSimEnergyDeposit::_hLandauEdep {nullptr}
private

Definition at line 39 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TH1F* larg4::CheckSimEnergyDeposit::_hLandauPhotons {nullptr}
private

Definition at line 38 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TH1F* larg4::CheckSimEnergyDeposit::_hnHits {nullptr}
private

Definition at line 35 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TH1F* larg4::CheckSimEnergyDeposit::_hnumPhotons {nullptr}
private

Definition at line 37 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TH1F* larg4::CheckSimEnergyDeposit::_hSteplength {nullptr}
private

Definition at line 40 of file CheckSimEnergyDeposit_module.cc.

Referenced by analyze(), and beginJob().

TNtuple* larg4::CheckSimEnergyDeposit::_ntuple {nullptr}
private

Definition at line 41 of file CheckSimEnergyDeposit_module.cc.

Referenced by beginJob().

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