phot::PhotonLibraryPropagation Class Reference

Inheritance diagram for phot::PhotonLibraryPropagation:

Public Types
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	~PhotonLibraryPropagation ()
	PhotonLibraryPropagation (fhicl::ParameterSet const &)
	PhotonLibraryPropagation (PhotonLibraryPropagation const &)=delete
	PhotonLibraryPropagation (PhotonLibraryPropagation &&)=delete
PhotonLibraryPropagation &	operator= (PhotonLibraryPropagation const &)=delete
PhotonLibraryPropagation &	operator= (PhotonLibraryPropagation &&)=delete
void	produce (art::Event &) 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 ()

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
double	fRiseTimeFast
double	fRiseTimeSlow
bool	fDoSlowComponent
vector< art::InputTag >	fEDepTags
larg4::ISCalcSeparate	fISAlg

Detailed Description

Definition at line 145 of file PhotonLibraryPropagation_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

phot::PhotonLibraryPropagation::~PhotonLibraryPropagation

(

)

Definition at line 170 of file PhotonLibraryPropagation_module.cc.

{
}

phot::PhotonLibraryPropagation::PhotonLibraryPropagation ( fhicl::ParameterSet const &  p )

explicit

Definition at line 174 of file PhotonLibraryPropagation_module.cc.

References art::EngineCreator::createEngine(), fDoSlowComponent, fEDepTags, fRiseTimeSlow, fhicl::ParameterSet::get(), and sim::LArG4Parameters::UseLitePhotons().

  : fRiseTimeFast{p.get<double>("RiseTimeFast", 0.0)}
  , fRiseTimeSlow{p.get<double>("RiseTimeSlow", 0.0)}
  , fDoSlowComponent{p.get<bool>("DoSlowComponent")}
  , fEDepTags{p.get<vector<art::InputTag>>("EDepModuleLabels")}
{
  art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, "HepJamesRandom", "photon",    p, "SeedPhoton");
  art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, "HepJamesRandom", "scinttime", p, "SeedScintTime");
  art::ServiceHandle<sim::LArG4Parameters> lgp;
  if (lgp->UseLitePhotons()) {
    produces<vector<sim::SimPhotonsLite>>();
  }
  else {
    produces<vector<sim::SimPhotons>>();
  }
}

phot::PhotonLibraryPropagation::PhotonLibraryPropagation ( PhotonLibraryPropagation const &  )

delete

phot::PhotonLibraryPropagation::PhotonLibraryPropagation ( PhotonLibraryPropagation &&  )

delete

Member Function Documentation

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(), 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::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

  {
    return current_context_.get();
  }

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::EDProducer::getProductID ( std::string const &  instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::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;
}

PhotonLibraryPropagation& phot::PhotonLibraryPropagation::operator= ( PhotonLibraryPropagation const &  )

delete

PhotonLibraryPropagation& phot::PhotonLibraryPropagation::operator= ( PhotonLibraryPropagation &&  )

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 phot::PhotonLibraryPropagation::produce ( art::Event &  e )

overridevirtual

Implements art::EDProducer.

Definition at line 191 of file PhotonLibraryPropagation_module.cc.

References larg4::ISCalcSeparate::CalculateIonizationAndScintillation(), DEFINE_ART_MODULE, evd::details::end(), sim::OnePhoton::Energy, fDoSlowComponent, fEDepTags, fISAlg, fRiseTimeFast, fRiseTimeSlow, art::DataViewImpl::getValidHandle(), larg4::ISCalcSeparate::Initialize(), sim::OnePhoton::InitialPosition, n, larg4::ISCalcSeparate::NumberScintillationPhotons(), art::Event::put(), larg4::ISCalcSeparate::Reset(), art::EngineCreator::rng(), detinfo::LArProperties::ScintFastTimeConst(), detinfo::LArProperties::ScintSlowTimeConst(), sim::OnePhoton::SetInSD, sim::SimEnergyDeposit::T0(), sim::OnePhoton::Time, sim::LArG4Parameters::UseLitePhotons(), sim::SimEnergyDeposit::X(), sim::SimEnergyDeposit::Y(), and sim::SimEnergyDeposit::Z().

{
  art::ServiceHandle<PhotonVisibilityService> pvs;
  art::ServiceHandle<sim::LArG4Parameters> lgp;
  auto const* larp = lar::providerFrom<detinfo::LArPropertiesService>();
  art::ServiceHandle<art::RandomNumberGenerator> rng;
  auto& engine_photon = rng->getEngine("photon");
  CLHEP::RandPoissonQ randpoisphot{engine_photon};
  auto& engine_scinttime = rng->getEngine("scinttime");
  CLHEP::RandFlat randflatscinttime{engine_scinttime};
  auto const nOpChannels = static_cast<int>(pvs->NOpChannels());
  fISAlg.Initialize(larp, lar::providerFrom<detinfo::DetectorPropertiesService>(), &*lgp, lar::providerFrom<spacecharge::SpaceChargeService>());
  unique_ptr<vector<sim::SimPhotons>> photCol{new vector<sim::SimPhotons>{}};
  auto& photonCollection{*photCol};
  photonCollection.resize(nOpChannels);
  unique_ptr<vector<sim::SimPhotonsLite>> photLiteCol{new vector<sim::SimPhotonsLite>{}};
  auto& photonLiteCollection{*photLiteCol};
  photonLiteCollection.resize(nOpChannels);
  for (int i = 0; i < nOpChannels; ++i) {
    photonLiteCollection[i].OpChannel = i;
    photonCollection[i].fOpChannel = i;
  }
  vector<vector<sim::SimEnergyDeposit> const*> edep_vecs;
  for (auto label : fEDepTags) {
    auto const& edep_handle = e.getValidHandle<vector<sim::SimEnergyDeposit>>(label);
    edep_vecs.push_back(edep_handle);
  }
  for (auto const& edeps : edep_vecs) { //loop over modules
    for (auto const& edep : *edeps) { //loop over energy deposits: one per step
      //int count_onePhot =0; // unused
      double const xyz[3] = {edep.X(), edep.Y(), edep.Z()};
      float const* Visibilities = pvs->GetAllVisibilities(xyz);
      if (Visibilities == nullptr) {
        throw cet::exception("PhotonLibraryPropagation")
          << "There is no entry in the PhotonLibrary for this position in space. "
             "Position x: "<< xyz[0] << "y: " << xyz[1] << "z: " << xyz[2];
      }
      fISAlg.Reset();
      fISAlg.CalculateIonizationAndScintillation(edep);
      //total amount of scintillation photons
      double nphot = static_cast<int>(fISAlg.NumberScintillationPhotons());
      //amount of scintillated photons created via the fast scintillation process
      double nphot_fast = static_cast<int>(GetScintYield(edep, *larp) * nphot);
      //amount of scintillated photons created via the slow scintillation process
      double nphot_slow = nphot - nphot_fast;
      for (int channel = 0; channel < nOpChannels; ++channel) {
        auto visibleFraction = Visibilities[channel];
        if (visibleFraction == 0.0) {
          // Voxel is not visible at this optical channel, skip doing anything for this channel.
          continue;
        }
        if (lgp->UseLitePhotons()) {
          if (nphot_fast > 0) {
            //throwing a random number from a poisson distribution with a mean of the amount of photons visible at this channel
            auto n = static_cast<int>(randpoisphot.fire(nphot_fast * visibleFraction));
            for (long i = 0; i < n; ++i) {
              //calculates the time at which the photon was produced
              auto time = static_cast<int>(edep.T0() + GetScintTime(fRiseTimeFast, larp->ScintFastTimeConst(), randflatscinttime));
              ++photonLiteCollection[channel].DetectedPhotons[time];
            }
          }
          if ((nphot_slow > 0) && fDoSlowComponent) {
            //throwing a random number from a poisson distribution with a mean of the amount of photons visible at this channel
            auto n = randpoisphot.fire(nphot_slow * visibleFraction);
            for (long i = 0; i < n; ++i) {
              //calculates the time at which the photon was produced
              auto time = static_cast<int>(edep.T0() + GetScintTime(fRiseTimeSlow, larp->ScintSlowTimeConst(), randflatscinttime));
              ++photonLiteCollection[channel].DetectedPhotons[time];
            }
          }
        }
        else {
          sim::OnePhoton photon;
          photon.SetInSD = false;
          photon.InitialPosition = TVector3{edep.X(), edep.Y(), edep.Z()};
          photon.Energy = 9.7e-6;
          if (nphot_fast > 0) {
            //throwing a random number from a poisson distribution with a mean of the amount of photons visible at this channel
            auto n = randpoisphot.fire(nphot_fast * visibleFraction);
            if (n > 0) {
              //calculates the time at which the photon was produced
              photon.Time = edep.T0() + GetScintTime(fRiseTimeFast, larp->ScintFastTimeConst(), randflatscinttime);
              // add n copies of sim::OnePhoton photon to the photon collection for a given OpChannel
              photonCollection[channel].insert(photonCollection[channel].end(), n, photon);
            }
          }
          if ((nphot_slow > 0) && fDoSlowComponent) {
            //throwing a random number from a poisson distribution with a mean of the amount of photons visible at this channel
            auto n = randpoisphot.fire(nphot_slow * visibleFraction);
            if (n > 0) {
              //calculates the time at which the photon was produced
              photon.Time = edep.T0() + GetScintTime(fRiseTimeSlow, larp->ScintSlowTimeConst(), randflatscinttime);
              // add n copies of sim::OnePhoton photon to the photon collection for a given OpChannel
              photonCollection[channel].insert(photonCollection[channel].end(), n, photon);
            }
          }
        }
      }
    }
  }
  if (lgp->UseLitePhotons()) {
    // put the photon collection of LitePhotons into the art event
    e.put(move(photLiteCol));
  }
  else {
    //put the photon collection of SimPhotons into the art event
    e.put(move(photCol));
  }
}

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

bool phot::PhotonLibraryPropagation::fDoSlowComponent

private

Definition at line 151 of file PhotonLibraryPropagation_module.cc.

Referenced by PhotonLibraryPropagation(), and produce().

vector<art::InputTag> phot::PhotonLibraryPropagation::fEDepTags

private

Definition at line 152 of file PhotonLibraryPropagation_module.cc.

Referenced by PhotonLibraryPropagation(), and produce().

larg4::ISCalcSeparate phot::PhotonLibraryPropagation::fISAlg

private

Definition at line 153 of file PhotonLibraryPropagation_module.cc.

Referenced by produce().

double phot::PhotonLibraryPropagation::fRiseTimeFast

private

Definition at line 149 of file PhotonLibraryPropagation_module.cc.

Referenced by produce().

double phot::PhotonLibraryPropagation::fRiseTimeSlow

private

Definition at line 150 of file PhotonLibraryPropagation_module.cc.

Referenced by PhotonLibraryPropagation(), and produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/PhotonPropagation/PhotonLibraryPropagation_module.cc