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 (fhicl::ParameterSet const &p)

	PhotonLibraryPropagation (PhotonLibraryPropagation const &)=delete

	PhotonLibraryPropagation (PhotonLibraryPropagation &&)=delete

PhotonLibraryPropagation &	operator= (PhotonLibraryPropagation const &)=delete

PhotonLibraryPropagation &	operator= (PhotonLibraryPropagation &&)=delete

void	produce (art::Event &e) override

void	reconfigure (fhicl::ParameterSet const &p)

void	beginJob () 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 Member Functions
double	GetScintYield (sim::SimEnergyDeposit const &, detinfo::LArProperties const &)

double	GetScintTime (double scint_time, double rise_time, double, double)

Private Attributes
double	fRiseTimeFast

double	fRiseTimeSlow

bool	fDoSlowComponent

std::vector< art::InputTag >	fEDepTags

larg4::ISCalculationSeparate	fISAlg

Detailed Description

Definition at line 47 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 ( fhicl::ParameterSet const & p )

explicit

Definition at line 82 of file PhotonLibraryPropagation_module.cc.

References art::EngineCreator::createEngine(), and reconfigure().

 {
   produces< std::vector<sim::SimPhotons> >();
   art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, "HepJamesRandom", "photon",    p, "SeedPhoton");
   art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, "HepJamesRandom", "scinttime", p, "SeedScintTime");  
   this->reconfigure(p);
 }

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

delete

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

delete

Member Function Documentation

void phot::PhotonLibraryPropagation::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 261 of file PhotonLibraryPropagation_module.cc.

References DEFINE_ART_MODULE.

 {
 
 }

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();
   }

double phot::PhotonLibraryPropagation::GetScintTime	(	double	scint_time,
		double	rise_time,
		double	r1,
		double	r2
	)

private

Definition at line 234 of file PhotonLibraryPropagation_module.cc.

Referenced by produce().

 {
   //no rise time
   if(rise_time<0.0)
     return -1 * scint_time * std::log(r1);
 
   while(1){
     double t = -1.0*scint_time*std::log(1-r1);
     //double g = (scint_time+rise_time)/scint_time * std::exp(-1.0*t/scint_time)/scint_time;
     if ( r2 <= (std::exp(-1.0*t/rise_time)*(1-std::exp(-1.0*t/rise_time))/scint_time/scint_time*(scint_time+rise_time)) )
       return -1 * t;
   }
   
   return 1;
   
 }

double phot::PhotonLibraryPropagation::GetScintYield	(	sim::SimEnergyDeposit const &	edep,
		detinfo::LArProperties const &	larp
	)

private

Definition at line 90 of file PhotonLibraryPropagation_module.cc.

References detinfo::LArProperties::AlphaScintYieldRatio(), detinfo::LArProperties::ElectronScintYieldRatio(), detinfo::LArProperties::KaonScintYieldRatio(), detinfo::LArProperties::MuonScintYieldRatio(), sim::SimEnergyDeposit::PdgCode(), detinfo::LArProperties::PionScintYieldRatio(), detinfo::LArProperties::ProtonScintYieldRatio(), detinfo::LArProperties::ScintByParticleType(), and detinfo::LArProperties::ScintYieldRatio().

Referenced by produce().

 {
   double yieldRatio = larp.ScintYieldRatio();
   if(larp.ScintByParticleType()){
     switch(edep.PdgCode()) {
     case 2212:
       yieldRatio = larp.ProtonScintYieldRatio();
       break;
     case 13:
     case -13:
       yieldRatio = larp.MuonScintYieldRatio();
       break;
     case 211:
     case -211:
       yieldRatio = larp.PionScintYieldRatio();
       break;
     case 321:
     case -321:
       yieldRatio = larp.KaonScintYieldRatio();
       break;
     case 1000020040:
       yieldRatio = larp.AlphaScintYieldRatio();
       break;
     case 11:
     case -11:
     case 22:
       yieldRatio = larp.ElectronScintYieldRatio();
       break;
     default:
       yieldRatio = larp.ElectronScintYieldRatio();
     }
   }
   return yieldRatio;
 }

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.

 {
   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 126 of file PhotonLibraryPropagation_module.cc.

References larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), edep, evd::details::end(), sim::OnePhoton::Energy, fDoSlowComponent, fEDepTags, fISAlg, fRiseTimeFast, fRiseTimeSlow, GetScintTime(), GetScintYield(), art::DataViewImpl::getValidHandle(), larg4::ISCalculationSeparate::Initialize(), sim::OnePhoton::InitialPosition, label, larg4::ISCalculationSeparate::NumberScintillationPhotons(), art::Event::put(), larg4::ISCalculationSeparate::Reset(), art::EngineCreator::rng(), detinfo::LArProperties::ScintFastTimeConst(), detinfo::LArProperties::ScintSlowTimeConst(), sim::OnePhoton::SetInSD, and sim::OnePhoton::Time.

 {
   art::ServiceHandle<PhotonVisibilityService> pvs;
   art::ServiceHandle<sim::LArG4Parameters> lgpHandle;
   const detinfo::LArProperties* larp = lar::providerFrom<detinfo::LArPropertiesService>();
   
   art::ServiceHandle<art::RandomNumberGenerator> rng;  
   CLHEP::HepRandomEngine &engine_photon = rng->getEngine("photon");
   CLHEP::RandPoissonQ randpoisphot(engine_photon);
   CLHEP::HepRandomEngine &engine_scinttime = rng->getEngine("scinttime");
   CLHEP::RandFlat randflatscinttime(engine_scinttime);
   
   const size_t NOpChannels = pvs->NOpChannels();
   double yieldRatio;
   double nphot,nphot_fast,nphot_slow;
 
   //auto fSCE = lar::providerFrom<spacecharge::SpaceChargeService>();
 
   sim::OnePhoton photon;
   photon.Energy = 9.7e-6;
   photon.SetInSD = false;
   
   fISAlg.Initialize(larp,
                     lar::providerFrom<detinfo::DetectorPropertiesService>(),
                     &(*lgpHandle),
                     lar::providerFrom<spacecharge::SpaceChargeService>());
 
   std::unique_ptr< std::vector<sim::SimPhotons> > photCol ( new std::vector<sim::SimPhotons>);
   auto & photonCollection(*photCol);
 
   //size_t edep_reserve_size=0;
   std::vector< std::vector<sim::SimEnergyDeposit> const*> edep_vecs;
   for(auto label : fEDepTags){
     auto const& edep_handle = e.getValidHandle< std::vector<sim::SimEnergyDeposit> >(label);
     edep_vecs.push_back(edep_handle);
     //edep_reserve_size += edep_handle->size();
   }
 
   for(size_t i_op=0; i_op<NOpChannels; ++i_op){
     photonCollection.emplace_back(i_op);
   }
 
   for(auto const& edeps : edep_vecs){
 
     for(auto const& edep : *edeps){
       /*
       std::cout << "Processing edep with trackID=" 
                 << edep.TrackID()
                 << " pdgCode="
                 << edep.PdgCode() 
                 << " energy="
                 << edep.Energy()
                 << "(x,y,z)=("
                 << edep.X() << "," << edep.Y() << "," << edep.Z() << ")"
                 << std::endl;
       */
       double const xyz[3] = { edep.X(), edep.Y(), edep.Z() };
       
       photon.InitialPosition = TVector3(xyz[0],xyz[1],xyz[2]);
       
       float const* Visibilities = pvs->GetAllVisibilities(xyz);
       if(!Visibilities)
         continue;
       
       yieldRatio = GetScintYield(edep,*larp);
       fISAlg.Reset();
       fISAlg.CalculateIonizationAndScintillation(edep);
       nphot =fISAlg.NumberScintillationPhotons();
       nphot_fast = yieldRatio*nphot;
 
       photon.Time = edep.T() + GetScintTime(larp->ScintFastTimeConst(),fRiseTimeFast,
                                             randflatscinttime(),randflatscinttime());
       //std::cout << "\t\tPhoton fast time is " << photon.Time << " (" << edep.T() << " orig)" << std::endl;
       for(size_t i_op=0; i_op<NOpChannels; ++i_op){
         auto nph = randpoisphot.fire(nphot_fast*Visibilities[i_op]);
         /*
           std::cout << "\t\tHave " << nph << " fast photons ("
           << Visibilities[i_op] << "*" << nphot_fast << " from " << nphot << ")"
           << " for opdet " << i_op << std::endl;
           //photonCollection[i_op].insert(photonCollection[i_op].end(),randpoisphot.fire(nphot_fast*Visibilities[i_op]),photon);
           */
         photonCollection[i_op].insert(photonCollection[i_op].end(),nph,photon);
       }
       if(fDoSlowComponent){
         nphot_slow = nphot - nphot_fast;
         
         if(nphot_slow>0){
           photon.Time = edep.T() + GetScintTime(larp->ScintSlowTimeConst(),fRiseTimeSlow,
                                                 randflatscinttime(),randflatscinttime());
           //std::cout << "\t\tPhoton slow time is " << photon.Time << " (" << edep.T() << " orig)" << std::endl;
           for(size_t i_op=0; i_op<NOpChannels; ++i_op){
             auto nph = randpoisphot.fire(nphot_slow*Visibilities[i_op]);
             //std::cout << "\t\tHave " << nph << " slow photons ("
             //        << Visibilities[i_op] << "*" << nphot_slow << " from " << nphot << ")"
             //        << " for opdet " << i_op << std::endl;
             photonCollection[i_op].insert(photonCollection[i_op].end(),nph,photon);
           }
         }
         
       }//end doing slow component
       
     }//end loop over edeps
   }//end loop over edep vectors
   
   e.put(std::move(photCol));
   
 }

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

Definition at line 252 of file PhotonLibraryPropagation_module.cc.

References fDoSlowComponent, fEDepTags, fRiseTimeFast, fRiseTimeSlow, and fhicl::ParameterSet::get().

Referenced by PhotonLibraryPropagation().

 {
   fRiseTimeFast = p.get<double>("RiseTimeFast",-1.0);
   fRiseTimeSlow = p.get<double>("RiseTimeSlow",-1.0);
   fDoSlowComponent = p.get<bool>("DoSlowComponent");
 
   fEDepTags = p.get< std::vector<art::InputTag> >("EDepModuleLabels");
 }

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);
 }