LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
opdet::OpHitAna Class Reference
Inheritance diagram for opdet::OpHitAna:
art::EDAnalyzer art::EventObserverBase art::Consumer art::EngineCreator

Public Types

using WorkerType = WorkerT< EDAnalyzer >
 
using ModuleType = EDAnalyzer
 

Public Member Functions

 OpHitAna (const fhicl::ParameterSet &)
 
virtual ~OpHitAna ()
 
void beginJob ()
 
void analyze (const art::Event &)
 
std::string workerType () const
 
bool modifiesEvent () const
 
void registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
 
std::string const & processName () const
 
bool wantAllEvents () const
 
bool wantEvent (Event const &e)
 
fhicl::ParameterSetID selectorConfig () const
 
art::Handle< art::TriggerResultsgetTriggerResults (Event const &e) const
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > consumes (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > consumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > mayConsume (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > mayConsumeView (InputTag const &it)
 
base_engine_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
 
seed_t get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)
 

Static Public Member Functions

static cet::exempt_ptr< Consumernon_module_context ()
 

Protected Member Functions

CurrentProcessingContext const * currentContext () const
 
detail::CachedProducts & cachedProducts ()
 
void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Attributes

std::string fInputModule
 
float fSampleFreq
 
float fTimeBegin
 
float fTimeEnd
 
bool fMakeHistPerChannel
 
bool fMakeHistAllChannels
 
bool fMakeHitTree
 
TTree * fHitTree
 
Int_t fEventID
 
Int_t fOpChannel
 
Float_t fPeakTime
 
Float_t fNPe
 

Detailed Description

Definition at line 28 of file OpHitAna_module.cc.

Member Typedef Documentation

Definition at line 39 of file EDAnalyzer.h.

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

opdet::OpHitAna::OpHitAna ( const fhicl::ParameterSet )

Definition at line 130 of file OpHitAna_module.cc.

References fEventID, fHitTree, fInputModule, fMakeHistAllChannels, fMakeHistPerChannel, fMakeHitTree, fNPe, fOpChannel, fPeakTime, fSampleFreq, fTimeBegin, fTimeEnd, fhicl::ParameterSet::get(), and art::TFileDirectory::make().

131  : EDAnalyzer(pset)
132  {
133 
134  // Indicate that the Input Module comes from .fcl
135  fInputModule = pset.get<std::string>("InputModule");
136 
138  fTimeBegin = odp->TimeBegin();
139  fTimeEnd = odp->TimeEnd();
140  fSampleFreq = odp->SampleFreq();
141 
142 
143  fMakeHistPerChannel = pset.get<bool>("MakeHistPerChannel");
144  fMakeHistAllChannels = pset.get<bool>("MakeHistAllChannels");
145  fMakeHitTree = pset.get<bool>("MakeHitTree");
146 
147  // If required, make TTree for output
148 
149  if(fMakeHitTree)
150  {
152  fHitTree = tfs->make<TTree>("HitTree","HitTree");
153  fHitTree->Branch("EventID", &fEventID, "EventID/I");
154  fHitTree->Branch("OpChannel", &fOpChannel, "OpChannel/I");
155  fHitTree->Branch("PeakTime", &fPeakTime, "PeakTime/F");
156  fHitTree->Branch("NPe", &fNPe, "NPe/F");
157  }
158 
159 
160  }
EDAnalyzer(Table< Config > const &config)
Definition: EDAnalyzer.h:100
T * make(ARGS...args) const
std::string fInputModule
opdet::OpHitAna::~OpHitAna ( )
virtual

Definition at line 164 of file OpHitAna_module.cc.

165  {}

Member Function Documentation

void opdet::OpHitAna::analyze ( const art::Event evt)

Definition at line 174 of file OpHitAna_module.cc.

References art::EventID::event(), fEventID, fHitTree, fInputModule, fMakeHistAllChannels, fMakeHistPerChannel, fMakeHitTree, fNPe, fOpChannel, fPeakTime, fSampleFreq, fTimeBegin, fTimeEnd, art::DataViewImpl::getByLabel(), art::Event::id(), art::TFileDirectory::make(), geo::GeometryCore::NOpChannels(), recob::OpHit::OpChannel(), recob::OpHit::PE(), and recob::OpHit::PeakTime().

175  {
176 
177  // Create a handle for our vector of pulses
179 
180  // Create string for histogram name
181  char HistName[50];
182 
183 
184  // Read in HitHandle
185  evt.getByLabel(fInputModule, HitHandle);
186 
187  // Access ART's TFileService, which will handle creating and writing
188  // histograms for us.
190 
192  int NOpChannels = geom->NOpChannels();
193 
194  std::vector<TH1D*> HitHist;
195 
196  sprintf(HistName, "Event %d AllOpDets", evt.id().event());
197 
198  TH1D * AllHits = nullptr;
200  {
201  AllHits = tfs->make<TH1D>(HistName, ";t (ns);",
202  int((fTimeEnd - fTimeBegin) * fSampleFreq),
203  fTimeBegin * 1000.,
204  fTimeEnd * 1000.);
205  }
206 
207  for(int i=0; i!=NOpChannels; ++i)
208  {
209 
210  sprintf(HistName, "Event %d OpDet %i", evt.id().event(), i);
211  if(fMakeHistPerChannel) HitHist.push_back ( tfs->make<TH1D>(HistName, ";t (ns);",
212  int((fTimeEnd - fTimeBegin) * fSampleFreq),
213  fTimeBegin * 1000.,
214  fTimeEnd * 1000.));
215 
216  }
217 
218 
219  fEventID = evt.id().event();
220 
221 
222  // For every OpHit in the vector
223  for(unsigned int i = 0; i < HitHandle->size(); ++i)
224  {
225  // Get OpHit
226  art::Ptr< recob::OpHit > TheHitPtr(HitHandle, i);
227  recob::OpHit TheHit = *TheHitPtr;
228 
229  fOpChannel = TheHit.OpChannel();
230  fNPe = TheHit.PE();
231  fPeakTime = TheHit.PeakTime();
232 
233  if(fMakeHitTree)
234  fHitTree->Fill();
235 
237  {
238  if(fOpChannel>int(HitHist.size()))
239  {
240  mf::LogError("OpHitAna")<<"Error : Trying to fill channel out of range, " << fOpChannel;
241  }
242  HitHist[fOpChannel]->Fill(fPeakTime,fNPe);
243  }
244 
245  if(fMakeHistAllChannels) AllHits->Fill(fPeakTime, fNPe);
246 
247  }
248 
249  }
double PeakTime() const
Definition: OpHit.h:64
MaybeLogger_< ELseverityLevel::ELsev_error, false > LogError
unsigned int NOpChannels() const
Number of electronics channels for all the optical detectors.
double PE() const
Definition: OpHit.h:69
T * make(ARGS...args) const
bool getByLabel(std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
Definition: DataViewImpl.h:344
std::string fInputModule
EventNumber_t event() const
Definition: EventID.h:117
int OpChannel() const
Definition: OpHit.h:62
EventID id() const
Definition: Event.h:56
void opdet::OpHitAna::beginJob ( )
virtual

Reimplemented from art::EDAnalyzer.

Definition at line 168 of file OpHitAna_module.cc.

169  {
170  }
detail::CachedProducts& art::EventObserverBase::cachedProducts ( )
inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

80  {
81  return selectors_;
82  }
detail::CachedProducts selectors_
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)
inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

148 {
149  if (!moduleContext_)
150  return ProductToken<T>::invalid();
151 
152  consumables_[BT].emplace_back(ConsumableType::Product,
153  TypeID{typeid(T)},
154  it.label(),
155  it.instance(),
156  it.process());
157  return ProductToken<T>{it};
158 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 162 of file Consumer.h.

163 {
164  if (!moduleContext_)
165  return;
166 
167  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
168 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)
inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

173 {
174  if (!moduleContext_)
175  return ViewToken<T>::invalid();
176 
177  consumables_[BT].emplace_back(ConsumableType::ViewElement,
178  TypeID{typeid(T)},
179  it.label(),
180  it.instance(),
181  it.process());
182  return ViewToken<T>{it};
183 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make 
)
inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

34 {
35  return rng()->createEngine(
36  placeholder_schedule_id(), seed, kind_of_engine_to_make);
37 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make,
label_t const &  engine_label 
)
inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

43 {
44  return rng()->createEngine(
45  placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
46 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
CurrentProcessingContext const * art::EDAnalyzer::currentContext ( ) const
protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

115  {
116  return current_context_.get();
117  }
CPC_exempt_ptr current_context_
Definition: EDAnalyzer.h:179
EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset,
char const  key[] = "seed",
seed_t const  implicit_seed = -1 
)
inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

52 {
53  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
54  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
55 }
art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const &  e) const
inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

62  {
64  }
detail::CachedProducts selectors_
art::Handle< art::TriggerResults > getOneTriggerResults(Event const &) const
Float_t e
Definition: plot.C:34
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)
inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

191 {
192  if (!moduleContext_)
193  return ProductToken<T>::invalid();
194 
195  consumables_[BT].emplace_back(ConsumableType::Product,
196  TypeID{typeid(T)},
197  it.label(),
198  it.instance(),
199  it.process());
200  return ProductToken<T>{it};
201 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 205 of file Consumer.h.

206 {
207  if (!moduleContext_)
208  return;
209 
210  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
211 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)
inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

216 {
217  if (!moduleContext_)
218  return ViewToken<T>::invalid();
219 
220  consumables_[BT].emplace_back(ConsumableType::ViewElement,
221  TypeID{typeid(T)},
222  it.label(),
223  it.instance(),
224  it.process());
225  return ViewToken<T>{it};
226 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
bool art::EventObserverBase::modifiesEvent ( ) const
inlineinherited

Definition at line 25 of file EventObserverBase.h.

26  {
27  return false;
28  }
void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

90 {
91  if (!moduleContext_)
92  return;
93 
94  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
95  for (auto& consumablesPerBranch : consumables_) {
96  cet::sort_all(consumablesPerBranch);
97  }
98 }
bool requireConsumes_
Definition: Consumer.h:137
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
std::string const& art::EventObserverBase::processName ( ) const
inlineinherited
void art::EventObserverBase::registerProducts ( MasterProductRegistry ,
ProductDescriptions ,
ModuleDescription const &   
)
inlineinherited

Definition at line 33 of file EventObserverBase.h.

36  {}
fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const
inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

57  {
58  return selector_config_id_;
59  }
fhicl::ParameterSetID selector_config_id_
void art::Consumer::showMissingConsumes ( ) const
protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

126 {
127  if (!moduleContext_)
128  return;
129 
130  // If none of the branches have missing consumes statements, exit early.
131  if (std::all_of(cbegin(missingConsumes_),
132  cend(missingConsumes_),
133  [](auto const& perBranch) { return perBranch.empty(); }))
134  return;
135 
136  constexpr cet::HorizontalRule rule{60};
137  mf::LogPrint log{"MTdiagnostics"};
138  log << '\n'
139  << rule('=') << '\n'
140  << "The following consumes (or mayConsume) statements are missing from\n"
141  << module_context(moduleDescription_) << '\n'
142  << rule('-') << '\n';
143 
144  cet::for_all_with_index(
145  missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
146  for (auto const& pi : perBranch) {
147  log << " "
148  << assemble_consumes_statement(static_cast<BranchType>(i), pi)
149  << '\n';
150  }
151  });
152  log << rule('=');
153 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

103 {
104  // Early exits if consumes tracking has been disabled or if the
105  // consumed product is an allowed consumable.
106  if (!moduleContext_)
107  return;
108 
109  if (cet::binary_search_all(consumables_[bt], pi))
110  return;
111 
112  if (requireConsumes_) {
114  "Consumer: an error occurred during validation of a "
115  "retrieved product\n\n")
116  << "The following consumes (or mayConsume) statement is missing from\n"
117  << module_context(moduleDescription_) << ":\n\n"
118  << " " << assemble_consumes_statement(bt, pi) << "\n\n";
119  }
120 
121  missingConsumes_[bt].insert(pi);
122 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
bool requireConsumes_
Definition: Consumer.h:137
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
bool art::EventObserverBase::wantAllEvents ( ) const
inlineinherited
bool art::EventObserverBase::wantEvent ( Event const &  e)
inlineinherited
std::string art::EDAnalyzer::workerType ( ) const
inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

110  {
111  return "WorkerT<EDAnalyzer>";
112  }

Member Data Documentation

Int_t opdet::OpHitAna::fEventID
private

Definition at line 61 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

TTree* opdet::OpHitAna::fHitTree
private

Definition at line 60 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

std::string opdet::OpHitAna::fInputModule
private

Definition at line 48 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

bool opdet::OpHitAna::fMakeHistAllChannels
private

Definition at line 56 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

bool opdet::OpHitAna::fMakeHistPerChannel
private

Definition at line 55 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

bool opdet::OpHitAna::fMakeHitTree
private

Definition at line 57 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

Float_t opdet::OpHitAna::fNPe
private

Definition at line 64 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

Int_t opdet::OpHitAna::fOpChannel
private

Definition at line 62 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

Float_t opdet::OpHitAna::fPeakTime
private

Definition at line 63 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

float opdet::OpHitAna::fSampleFreq
private

Definition at line 49 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

float opdet::OpHitAna::fTimeBegin
private

Definition at line 50 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().

float opdet::OpHitAna::fTimeEnd
private

Definition at line 51 of file OpHitAna_module.cc.

Referenced by analyze(), and OpHitAna().


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