LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
filter::EventTimeFilter Class Reference
Inheritance diagram for filter::EventTimeFilter:
art::EDFilter art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper

Public Types

using ModuleType = EDFilter
 
using WorkerType = WorkerT< EDFilter >
 
template<typename UserConfig >
using Table = ProducerBase::Table< UserConfig >
 

Public Member Functions

 EventTimeFilter (fhicl::ParameterSet const &)
 
virtual ~EventTimeFilter ()
 
bool filter (art::Event &evt)
 
void beginJob ()
 
void endJob ()
 
void reconfigure (fhicl::ParameterSet const &p)
 
template<typename PROD , BranchType B = InEvent>
ProductID getProductID (std::string const &instanceName={}) const
 
template<typename PROD , BranchType B>
ProductID getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
 
bool modifiesEvent () 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 ()
 

Static Public Attributes

static constexpr bool Pass {true}
 
static constexpr bool Fail {false}
 

Protected Member Functions

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

Private Attributes

UInt_t fDateRangeLow
 
UInt_t fTimeRangeLow
 
UInt_t fDateRangeHigh
 
UInt_t fTimeRangeHigh
 

Detailed Description

Definition at line 45 of file EventTimeFilter_module.cc.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter
inherited

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >
using art::EDFilter::Table = ProducerBase::Table<UserConfig>
inherited

Definition at line 46 of file EDFilter.h.

using art::EDFilter::WorkerType = WorkerT<EDFilter>
inherited

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

filter::EventTimeFilter::EventTimeFilter ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 81 of file EventTimeFilter_module.cc.

References reconfigure().

81  {
82  this->reconfigure(pset);
83 }
void reconfigure(fhicl::ParameterSet const &p)
filter::EventTimeFilter::~EventTimeFilter ( )
virtual

Definition at line 85 of file EventTimeFilter_module.cc.

85 { }

Member Function Documentation

void filter::EventTimeFilter::beginJob ( )
virtual

Reimplemented from art::EDFilter.

Definition at line 68 of file EventTimeFilter_module.cc.

68 { }
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::EDFilter::currentContext ( ) const
protectedinherited

Definition at line 120 of file EDFilter.cc.

References art::EDFilter::current_context_.

121  {
122  return current_context_.get();
123  }
CPC_exempt_ptr current_context_
Definition: EDFilter.h:125
void filter::EventTimeFilter::endJob ( )
virtual

Reimplemented from art::EDFilter.

Definition at line 70 of file EventTimeFilter_module.cc.

70 { }
bool filter::EventTimeFilter::filter ( art::Event evt)
virtual

Implements art::EDFilter.

Definition at line 87 of file EventTimeFilter_module.cc.

References DEFINE_ART_MODULE, fDateRangeHigh, fDateRangeLow, fTimeRangeHigh, fTimeRangeLow, art::Event::time(), art::Timestamp::timeHigh(), and art::Timestamp::timeLow().

87  {
88 
89  // Check that input date is in correct format
90  if (fDateRangeHigh > 99999999 || fDateRangeLow > 99999999) {
91  std::cout << "Warning: please provide date in format YYYYMMDD, event time "
92  << "filter returning false." << std::endl;
93  return false;
94  }
95  if (fDateRangeHigh > 0 && fDateRangeHigh < 10000000) {
96  std::cout << "Warning: please provide date in format YYYYMMDD, event time "
97  << "filter returning false." << std::endl;
98  return false;
99  }
100  if (fDateRangeLow > 0 && fDateRangeLow < 10000000) {
101  std::cout << "Warning: please provide date in format YYYYMMDD, event time "
102  << "filter returning false." << std::endl;
103  return false;
104  }
105 
106  // Check that input times are in correct format
107  if (fTimeRangeHigh > 999999 || fTimeRangeLow > 999999) {
108  std::cout << "Warning: please provide time in format HHMMSS, event time "
109  << "filter returning false." << std::endl;
110  return false;
111  }
112  if (fTimeRangeHigh > 0 && fTimeRangeHigh < 100000) {
113  std::cout << "Warning: please provide time in format HHMMSS, event time "
114  << "filter returning false." << std::endl;
115  return false;
116  }
117  if (fTimeRangeLow > 0 && fTimeRangeLow < 100000) {
118  std::cout << "Warning: please provide time in format HHMMSS, event time "
119  << "filter returning false." << std::endl;
120  return false;
121  }
122 
123  // Event time
124  art::Timestamp evtTime = evt.time();
125  TTimeStamp * evtTTS;
126  if (evtTime.timeHigh() == 0) { evtTTS = new TTimeStamp(evtTime.timeLow()); }
127  else { evtTTS = new TTimeStamp(evtTime.timeHigh(), evtTime.timeLow()); }
128 
129  std::cout << "Event time: " << evtTTS -> AsString() << std::endl;
130 
131  // Requested time range lower end
132  TTimeStamp * ttsLow(nullptr);
133  if (fDateRangeLow != 0) {
134  if (fTimeRangeLow != 0) {
135  ttsLow = new TTimeStamp(fDateRangeLow, fTimeRangeLow, 0u);
136  }
137  else {
138  ttsLow = new TTimeStamp(fDateRangeLow, 0u, 0u);
139  std::cout << "Warning: No start time given for event time filter, "
140  << "assuming 00:00:00" << std::endl;
141  }
142  }
143 
144  // Requested time range higher end
145  TTimeStamp * ttsHigh(nullptr);
146  if (fDateRangeHigh != 0) {
147  if (fTimeRangeHigh != 0) {
148  ttsHigh = new TTimeStamp(fDateRangeHigh, fTimeRangeHigh, 0u);
149  }
150  else {
151  std::cout << "Warning: No end time given for event time filter, assuming "
152  << "23:59:59" << std::endl;
153  ttsHigh = new TTimeStamp(fDateRangeHigh, 235959u, 0u);
154  }
155  }
156 
157  // Filter decision
158  if (ttsLow == nullptr && ttsHigh == nullptr) {
159  std::cout << "Warning: No date range requested for event time filter, "
160  << "returning false." << std::endl;
161  return false;
162  }
163  else if (ttsLow == nullptr) {
164  std::cout << "Warning: No lower limit requested for event time filter, "
165  << "taking all events before " << ttsHigh -> AsString()
166  << std::endl;
167  if (evtTTS -> GetSec() < ttsHigh -> GetSec()) { return true; }
168  else { return false;}
169  }
170  else if (ttsHigh == nullptr) {
171  std::cout << "Warning: No lower limit requested for event time filter, "
172  << "taking all events after " << ttsLow -> AsString()
173  << std::endl;
174  if (evtTTS -> GetSec() > ttsLow -> GetSec()) { return true; }
175  else { return false;}
176  }
177  else {
178  if (evtTTS -> GetSec() > ttsLow -> GetSec() &&
179  evtTTS -> GetSec() < ttsHigh -> GetSec()) { return true; }
180  else { return false; }
181  }
182 
183 }
constexpr std::uint32_t timeLow() const
Definition: Timestamp.h:30
constexpr std::uint32_t timeHigh() const
Definition: Timestamp.h:35
Timestamp time() const
Definition: Event.h:61
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 }
template<typename PROD , BranchType B>
ProductID art::EDFilter::getProductID ( std::string const &  instanceName = {}) const
inlineinherited

Definition at line 131 of file EDFilter.h.

References art::EDFilter::moduleDescription_.

132  {
133  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
134  instanceName);
135  }
ModuleDescription moduleDescription_
Definition: EDFilter.h:124
template<typename PROD , BranchType B>
ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription,
std::string const &  instanceName 
) const
inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
Int_t B
Definition: plot.C:25
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::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

41  {
42  return true;
43  }
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
void filter::EventTimeFilter::reconfigure ( fhicl::ParameterSet const &  p)

Definition at line 72 of file EventTimeFilter_module.cc.

References fDateRangeHigh, fDateRangeLow, fTimeRangeHigh, fTimeRangeLow, and fhicl::ParameterSet::get().

Referenced by EventTimeFilter().

72  {
73 
74  fDateRangeLow = p.get<UInt_t>("DateRangeLow", 0); // YYYYMMDD
75  fTimeRangeLow = p.get<UInt_t>("TimeRangeLow", 0); // HHMMSS
76  fDateRangeHigh = p.get<UInt_t>("DateRangeHigh", 0); // YYYYMMDD
77  fTimeRangeHigh = p.get<UInt_t>("TimeRangeHigh", 0); // HHMMSS
78 
79 }
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

Member Data Documentation

constexpr bool art::EDFilter::Fail {false}
staticinherited

Definition at line 33 of file EDFilter.h.

UInt_t filter::EventTimeFilter::fDateRangeHigh
private

Definition at line 61 of file EventTimeFilter_module.cc.

Referenced by filter(), and reconfigure().

UInt_t filter::EventTimeFilter::fDateRangeLow
private

Definition at line 59 of file EventTimeFilter_module.cc.

Referenced by filter(), and reconfigure().

UInt_t filter::EventTimeFilter::fTimeRangeHigh
private

Definition at line 62 of file EventTimeFilter_module.cc.

Referenced by filter(), and reconfigure().

UInt_t filter::EventTimeFilter::fTimeRangeLow
private

Definition at line 60 of file EventTimeFilter_module.cc.

Referenced by filter(), and reconfigure().

constexpr bool art::EDFilter::Pass {true}
staticinherited

Definition at line 32 of file EDFilter.h.


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