simfilter::FilterSimPhotonTime Class Reference

Inheritance diagram for simfilter::FilterSimPhotonTime:

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

Public Member Functions
	FilterSimPhotonTime (fhicl::ParameterSet const &p)
	FilterSimPhotonTime (FilterSimPhotonTime const &)=delete
	FilterSimPhotonTime (FilterSimPhotonTime &&)=delete
FilterSimPhotonTime &	operator= (FilterSimPhotonTime const &)=delete
FilterSimPhotonTime &	operator= (FilterSimPhotonTime &&)=delete
bool	filter (art::Event &e) override
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_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (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< Consumer >	non_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 Member Functions
void	CheckTimeWindows ()

Private Attributes
std::string const	fSimPhotonsCollectionLabel
std::vector< std::vector< float > > const	fTimeWindows
float const	fMinTotalEnergy
float const	fMinPhotonEnergy
bool const	fDebug
std::vector< float >	fSumEnergyArray

Detailed Description

Definition at line 34 of file FilterSimPhotonTime_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

simfilter::FilterSimPhotonTime::FilterSimPhotonTime ( fhicl::ParameterSet const &  p )

explicit

Definition at line 66 of file FilterSimPhotonTime_module.cc.

References CheckTimeWindows().

  :
  fSimPhotonsCollectionLabel(p.get<std::string>("SimPhotonsCollectionLabel")),
  fTimeWindows(p.get< std::vector< std::vector<float> > >("TimeWindows")),
  fMinTotalEnergy(p.get<float>("MinTotalEnergy",0.0)),
  fMinPhotonEnergy(p.get<float>("MinPhotonEnergy",-1)),
  fDebug(p.get<bool>("Debug",false)),
  fSumEnergyArray(fTimeWindows.size())
{
  CheckTimeWindows();
}

simfilter::FilterSimPhotonTime::FilterSimPhotonTime ( FilterSimPhotonTime const &  )

delete

simfilter::FilterSimPhotonTime::FilterSimPhotonTime ( FilterSimPhotonTime &&  )

delete

Member Function Documentation

void simfilter::FilterSimPhotonTime::CheckTimeWindows ( )

private

Definition at line 78 of file FilterSimPhotonTime_module.cc.

References fDebug, and fTimeWindows.

Referenced by FilterSimPhotonTime().

                                                   {

  if(fDebug)
    std::cout << "\tFilterSimPhotonTime: TimeWindows size is "
              << fTimeWindows.size() << std::endl;
  
  for(auto const& tw : fTimeWindows){


    if(tw.size()!=2)
      throw cet::exception("FilterSimPhotonTime::CheckTimeWindows")
        << "Bad time window initialization: time window has wrong size (not 2)."
        << std::endl;
    
    if(fDebug)
      std::cout << "\t\tTimeWindow "
                << "[" << tw[0] << "," << tw[1] << "]"
                << std::endl;
    
    if(tw[0]>tw[1])
      throw cet::exception("FilterSimPhotonTime::CheckTimeWindows")
        << "Bad time window initialization: tw[0]>tw[1]. Reverse the order!"
        << std::endl;
    
    
  }

}

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().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

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().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return rng()->createEngine(placeholder_schedule_id(), seed);
}

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().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make);
}

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().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
}

CurrentProcessingContext const * art::EDFilter::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDFilter.cc.

References art::EDFilter::current_context_.

  {
    return current_context_.get();
  }

bool simfilter::FilterSimPhotonTime::filter ( art::Event &  e )

overridevirtual

Implements art::EDFilter.

Definition at line 107 of file FilterSimPhotonTime_module.cc.

References DEFINE_ART_MODULE, fDebug, trkf::fill(), fMinPhotonEnergy, fMinTotalEnergy, fSimPhotonsCollectionLabel, fSumEnergyArray, fTimeWindows, and art::DataViewImpl::getByLabel().

{

  art::Handle< std::vector<sim::SimPhotons> > simPhotonsHandle;
  e.getByLabel(fSimPhotonsCollectionLabel,simPhotonsHandle);
  std::vector<sim::SimPhotons> const& simPhotonsCollection(*simPhotonsHandle);

  std::fill(fSumEnergyArray.begin(),fSumEnergyArray.end(),0.0);
  for(auto const& simphotons : simPhotonsCollection){
    if(fDebug)
      std::cout << "\tFilterSimPhotonTime: Processing simphotons channel "
                << simphotons.OpChannel()
                << std::endl;

    for(auto const& photon : simphotons)
      for(size_t i_tw=0; i_tw<fTimeWindows.size(); ++i_tw){
        auto const& tw(fTimeWindows[i_tw]);
        if(photon.Time>=tw[0] && photon.Time<=tw[1] && photon.Energy>fMinPhotonEnergy){
          
          if(fDebug)
            std::cout << "\t\tPhoton with time " << photon.Time << " detected. "
                      << "Energy is  " << photon.Energy << "."
                      << std::endl;
          
          fSumEnergyArray[i_tw] += photon.Energy;

          if(fDebug)
            std::cout << "\t\tTotal energy in this window (" << i_tw << ") is now " << fSumEnergyArray[i_tw] << std::endl;

          if(fSumEnergyArray[i_tw] > fMinTotalEnergy) return true;
        }
      }
  }

  if(fDebug){
    std::cout << "\tFilterSimPhotonTime: Final total energies are below min of " << fMinTotalEnergy << ":" << std::endl;
    for(size_t i_tw=0; i_tw<fTimeWindows.size(); ++i_tw){
      std::cout << "\t\tTimeWindow "
                << "[" << fTimeWindows[i_tw][0] << "," << fTimeWindows[i_tw][1] << "]: "
                << fSumEnergyArray[i_tw]
                << std::endl;
    }
  }
  
  //if(sum_energy > fMinTotalEnergy) return true;

  return false;
}

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_().

{
  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
}

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_.

  {
    return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                               instanceName);
  }

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().

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

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().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

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().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

    {
      return true;
    }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

FilterSimPhotonTime& simfilter::FilterSimPhotonTime::operator= ( FilterSimPhotonTime const &  )

delete

FilterSimPhotonTime& simfilter::FilterSimPhotonTime::operator= ( FilterSimPhotonTime &&  )

delete

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().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

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().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Member Data Documentation

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

staticinherited

Definition at line 33 of file EDFilter.h.

bool const simfilter::FilterSimPhotonTime::fDebug

private

Definition at line 58 of file FilterSimPhotonTime_module.cc.

Referenced by CheckTimeWindows(), and filter().

float const simfilter::FilterSimPhotonTime::fMinPhotonEnergy

private

Definition at line 57 of file FilterSimPhotonTime_module.cc.

Referenced by filter().

float const simfilter::FilterSimPhotonTime::fMinTotalEnergy

private

Definition at line 56 of file FilterSimPhotonTime_module.cc.

Referenced by filter().

std::string const simfilter::FilterSimPhotonTime::fSimPhotonsCollectionLabel

private

Definition at line 54 of file FilterSimPhotonTime_module.cc.

Referenced by filter().

std::vector<float> simfilter::FilterSimPhotonTime::fSumEnergyArray

private

Definition at line 60 of file FilterSimPhotonTime_module.cc.

Referenced by filter().

std::vector< std::vector<float> > const simfilter::FilterSimPhotonTime::fTimeWindows

private

Definition at line 55 of file FilterSimPhotonTime_module.cc.

Referenced by CheckTimeWindows(), and filter().

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:

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/SimFilters/FilterSimPhotonTime_module.cc