Inheritance diagram for larg4::IonAndScint:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	IonAndScint (fhicl::ParameterSet const &pset)

void	produce (art::Event &event) override

void	beginJob () override

void	endJob () override

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
std::vector< art::Handle< SimEnergyDepositCollection > >	inputCollections (art::Event const &) const

Private Attributes
art::InputTag	calcTag

std::vector< std::string >	fInputModuleLabels

std::unique_ptr< ISCalc >	fISAlg

CLHEP::HepRandomEngine &	fEngine

string	Instances

std::vector< string >	instanceNames

bool	fSavePriorSCE

Detailed Description

Definition at line 58 of file IonAndScint_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

larg4::IonAndScint::IonAndScint ( fhicl::ParameterSet const & pset )

explicit

Definition at line 86 of file IonAndScint_module.cc.

References calcTag, art::detail::EngineCreator::createEngine(), fEngine, fInputModuleLabels, fSavePriorSCE, instanceNames, and Instances.

     : art::EDProducer{pset}
     , calcTag{pset.get<art::InputTag>("ISCalcAlg")}
     , fInputModuleLabels{pset.get<std::vector<std::string>>("InputModuleLabels", {})}
     , fEngine(art::ServiceHandle<rndm::NuRandomService> {}
               -> registerAndSeedEngine(createEngine(0, "HepJamesRandom", "ISCalcAlg"),
                                        "HepJamesRandom",
                                        "ISCalcAlg",
                                        pset,
                                        "SeedISCalcAlg"))
     , Instances{pset.get<string>("Instances", "LArG4DetectorServicevolTPCActive")}
     , fSavePriorSCE{pset.get<bool>("SavePriorSCE", false)}
   {
     std::cout << "IonAndScint Module Construct" << std::endl;
 
     if (Instances.empty()) {
       std::cout << "Produce SimEnergyDeposit in default volume - LArG4DetectorServicevolTPCActive"
                 << std::endl;
       instanceNames.push_back("LArG4DetectorServicevolTPCActive");
     }
     else {
       std::stringstream input(Instances);
       string temp;
       while (std::getline(input, temp, ';')) {
         instanceNames.push_back(temp);
       }
 
       std::cout << "Produce SimEnergyDeposit in volumes: " << std::endl;
       for (auto instanceName : instanceNames) {
         std::cout << " - " << instanceName << std::endl;
       }
     }
 
     produces<std::vector<sim::SimEnergyDeposit>>();
     if (fSavePriorSCE) produces<std::vector<sim::SimEnergyDeposit>>("priorSCE");
   }

Member Function Documentation

void larg4::IonAndScint::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 124 of file IonAndScint_module.cc.

References calcTag, fEngine, fISAlg, and art::InputTag::label().

   {
     std::cout << "IonAndScint beginJob." << std::endl;
     std::cout << "Using " << calcTag.label() << " algorithm to calculate IS." << std::endl;
 
     if (calcTag.label() == "Separate")
       fISAlg = std::make_unique<ISCalcSeparate>();
     else if (calcTag.label() == "Correlated") {
       auto const detProp = art::ServiceHandle<detinfo::DetectorPropertiesService>()->DataForJob();
       fISAlg = std::make_unique<ISCalcCorrelated>(detProp, fEngine);
     }
     else if (calcTag.label() == "NEST")
       fISAlg = std::make_unique<ISCalcNESTLAr>(fEngine);
     else
       mf::LogWarning("IonAndScint") << "No ISCalculation set, this can't be good.";
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void larg4::IonAndScint::endJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 142 of file IonAndScint_module.cc.

   {
     std::cout << "IonAndScint endJob." << std::endl;
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::vector< art::Handle< SimEnergyDepositCollection > > larg4::IonAndScint::inputCollections ( art::Event const & e ) const

private

Definition at line 148 of file IonAndScint_module.cc.

References util::empty(), fInputModuleLabels, art::ProductRetriever::getMany(), and art::errors::ProductNotFound.

Referenced by produce().

   {
     if (empty(fInputModuleLabels)) {
       mf::LogDebug("IonAndScint") << "Retrieving all products" << std::endl;
       return e.getMany<SimEnergyDepositCollection>();
     }
 
     std::vector<art::Handle<SimEnergyDepositCollection>> result;
 
     for (auto const& module : fInputModuleLabels) {
 
       mf::LogDebug("IonAndScint") << "Retrieving products with module label " << module
                                   << std::endl;
 
       auto handels = e.getMany<SimEnergyDepositCollection>(art::ModuleLabelSelector(module));
 
       if (empty(handels)) {
         throw art::Exception(art::errors::ProductNotFound)
           << "IonAndScint module cannot find any SimEnergyDeposits with module label " << module
           << " as requested in InputModuleLabels. \n";
       }
 
       result.insert(result.end(), handels.begin(), handels.end());
     }
 
     return result;
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void larg4::IonAndScint::produce ( art::Event & event )

overridevirtual

Implements art::EDProducer.

Definition at line 178 of file IonAndScint_module.cc.

References DEFINE_ART_MODULE, util::empty(), fISAlg, fSavePriorSCE, inputCollections(), and instanceNames.

   {
     std::cout << "IonAndScint Module Producer" << std::endl;
 
     std::vector<art::Handle<SimEnergyDepositCollection>> edepHandle = inputCollections(event);
 
     if (empty(edepHandle)) {
       std::cout << "IonAndScint Module Cannot Retrive SimEnergyDeposit" << std::endl;
       return;
     }
 
     auto sce = lar::providerFrom<spacecharge::SpaceChargeService>();
     auto const detProp =
       art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(event);
 
     auto simedep = std::make_unique<std::vector<sim::SimEnergyDeposit>>();
     auto simedep1 = std::make_unique<std::vector<sim::SimEnergyDeposit>>(); // for prior-SCE depos
     for (auto edeps : edepHandle) {
       // Do some checking before we proceed
       if (!edeps.isValid()) {
         std::cout << "!edeps.isValid()" << std::endl;
         continue;
       }
 
       auto index = std::find(
         instanceNames.begin(), instanceNames.end(), edeps.provenance()->productInstanceName());
       if (index == instanceNames.end()) {
         std::cout << "Skip SimEnergyDeposit in: " << edeps.provenance()->productInstanceName()
                   << std::endl;
         continue;
       }
 
       std::cout << "SimEnergyDeposit input module: " << edeps.provenance()->moduleLabel()
                 << ", instance name: " << edeps.provenance()->productInstanceName() << std::endl;
 
       for (sim::SimEnergyDeposit const& edepi : *edeps) {
         auto const isCalcData = fISAlg->CalcIonAndScint(detProp, edepi);
 
         int ph_num = round(isCalcData.numPhotons);
         int ion_num = round(isCalcData.numElectrons);
         float scintyield = isCalcData.scintillationYieldRatio;
         float edep_tmp = edepi.Energy();
         geo::Point_t startPos_tmp = edepi.Start();
         geo::Point_t endPos_tmp = edepi.End();
         double startTime_tmp = edepi.StartT();
         double endTime_tmp = edepi.EndT();
         int trackID_tmp = edepi.TrackID();
         int pdgCode_tmp = edepi.PdgCode();
         int origTrackID_tmp = edepi.OrigTrackID();
 
         if (sce->EnableSimSpatialSCE()) {
           auto posOffsetsStart =
             sce->GetPosOffsets({edepi.StartX(), edepi.StartY(), edepi.StartZ()});
           auto posOffsetsEnd = sce->GetPosOffsets({edepi.EndX(), edepi.EndY(), edepi.EndZ()});
           startPos_tmp =
             geo::Point_t{(float)(edepi.StartX() - posOffsetsStart.X()), //x should be subtracted
                          (float)(edepi.StartY() + posOffsetsStart.Y()),
                          (float)(edepi.StartZ() + posOffsetsStart.Z())};
           endPos_tmp =
             geo::Point_t{(float)(edepi.EndX() - posOffsetsEnd.X()), //x should be subtracted
                          (float)(edepi.EndY() + posOffsetsEnd.Y()),
                          (float)(edepi.EndZ() + posOffsetsEnd.Z())};
         }
 
         simedep->emplace_back(ph_num,
                               ion_num,
                               scintyield,
                               edep_tmp,
                               startPos_tmp,
                               endPos_tmp,
                               startTime_tmp,
                               endTime_tmp,
                               trackID_tmp,
                               pdgCode_tmp,
                               origTrackID_tmp);
 
         if (fSavePriorSCE) {
           simedep1->emplace_back(ph_num,
                                  ion_num,
                                  scintyield,
                                  edepi.Energy(),
                                  edepi.Start(),
                                  edepi.End(),
                                  edepi.StartT(),
                                  edepi.EndT(),
                                  edepi.TrackID(),
                                  edepi.PdgCode(),
                                  edepi.OrigTrackID());
         }
       }
     }
     event.put(std::move(simedep));
     if (fSavePriorSCE) event.put(std::move(simedep1), "priorSCE");
   }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

art::InputTag larg4::IonAndScint::calcTag

private

Definition at line 69 of file IonAndScint_module.cc.

Referenced by beginJob(), and IonAndScint().

CLHEP::HepRandomEngine& larg4::IonAndScint::fEngine

private

Definition at line 79 of file IonAndScint_module.cc.

Referenced by beginJob(), and IonAndScint().

std::vector<std::string> larg4::IonAndScint::fInputModuleLabels

private

Definition at line 76 of file IonAndScint_module.cc.

Referenced by inputCollections(), and IonAndScint().

std::unique_ptr<ISCalc> larg4::IonAndScint::fISAlg

private

Definition at line 78 of file IonAndScint_module.cc.

Referenced by beginJob(), and produce().

bool larg4::IonAndScint::fSavePriorSCE

private

Definition at line 82 of file IonAndScint_module.cc.

Referenced by IonAndScint(), and produce().

std::vector<string> larg4::IonAndScint::instanceNames

private

Definition at line 81 of file IonAndScint_module.cc.

Referenced by IonAndScint(), and produce().

string larg4::IonAndScint::Instances

private

Definition at line 80 of file IonAndScint_module.cc.

Referenced by IonAndScint().

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

larsim/v09_43_00/source/larsim/IonizationScintillation/IonAndScint_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation