larg4::IonAndScint Class Reference

Inheritance diagram for larg4::IonAndScint:

Public Member Functions
	IonAndScint (fhicl::ParameterSet const &pset)
void	produce (art::Event &event) override
void	beginJob () override
void	endJob () override
Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
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)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
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)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

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

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)
Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Definition at line 51 of file IonAndScint_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 80 of file IonAndScint_module.cc.

    : art::EDProducer{pset}
    , calcTag{pset.get<art::InputTag>("ISCalcAlg")}
    , fInputModuleLabels{pset.get<std::vector<std::string>>("InputModuleLabels", {})}
    , fEngine(art::ServiceHandle<rndm::NuRandomService>()
                ->createEngine(*this, "HepJamesRandom", "NEST", pset, "SeedNEST"))
    , 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 117 of file IonAndScint_module.cc.

  {
    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);
    }
    else if (calcTag.label() == "NEST")
      fISAlg = std::make_unique<ISCalcNESTLAr>(fEngine);
    else
      mf::LogWarning("IonAndScint") << "No ISCalculation set, this can't be good.";
  }

void larg4::IonAndScint::endJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 136 of file IonAndScint_module.cc.

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

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

private

Definition at line 143 of file IonAndScint_module.cc.

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

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

overridevirtual

Implements art::EDProducer.

Definition at line 173 of file IonAndScint_module.cc.

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

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

        if (fSavePriorSCE) {
            simedep1->emplace_back(ph_num,
                                  ion_num,
                                  scintyield,
                                  edepi.Energy(),
                                  edepi.Start(),
                                  edepi.End(),
                                  edepi.StartT(),
                                  edepi.EndT(),
                                  edepi.TrackID(),
                                  edepi.PdgCode());
        }

      }
    }
    event.put(std::move(simedep));
    if (fSavePriorSCE) event.put(std::move(simedep1), "priorSCE");
  }

Member Data Documentation

art::InputTag larg4::IonAndScint::calcTag

private

Definition at line 63 of file IonAndScint_module.cc.

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

private

Definition at line 73 of file IonAndScint_module.cc.

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

private

Definition at line 70 of file IonAndScint_module.cc.

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

private

Definition at line 72 of file IonAndScint_module.cc.

bool larg4::IonAndScint::fSavePriorSCE

private

Definition at line 76 of file IonAndScint_module.cc.

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

private

Definition at line 75 of file IonAndScint_module.cc.

string larg4::IonAndScint::Instances

private

Definition at line 74 of file IonAndScint_module.cc.

---

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

• larsim/larsim/IonizationScintillation/IonAndScint_module.cc