sim::MergeSimSources Class Reference

Inheritance diagram for sim::MergeSimSources:

Classes
struct	Config

Public Types
using	Parameters = art::EDProducer::Table< Config >
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 >

Public Member Functions
	MergeSimSources (Parameters const &config)
void	produce (art::Event &e) 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
void	dumpConfiguration () const

Private Attributes
std::vector< art::InputTag > const	fInputSourcesLabels
std::vector< int > const	fTrackIDOffsets
bool const	fUseLitePhotons
bool const	fStoreReflected
bool const	fFillMCParticles
bool const	fFillSimPhotons
bool const	fFillSimChannels
bool const	fFillAuxDetSimChannels
bool const	fFillSimEnergyDeposits
std::vector< std::string > const	fEnergyDepositionInstances
bool const	fFillAuxDetHits
std::vector< std::string > const	fAuxDetHitsInstanceLabels

Static Private Attributes
static std::string const	ReflectedLabel { "Reflected" }

Additional Inherited Members
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 50 of file MergeSimSources_module.cc.

Member Typedef Documentation

using sim::MergeSimSources::Parameters = art::EDProducer::Table<Config>

Definition at line 122 of file MergeSimSources_module.cc.

Constructor & Destructor Documentation

sim::MergeSimSources::MergeSimSources ( Parameters const &  config )

explicit

Definition at line 173 of file MergeSimSources_module.cc.

  : EDProducer{params}
  , fInputSourcesLabels(params().InputSourcesLabels())
  , fTrackIDOffsets(params().TrackIDOffsets())
  , fUseLitePhotons(art::ServiceHandle<sim::LArG4Parameters const>()->UseLitePhotons())
  , fStoreReflected(params().StoreReflected())
  , fFillMCParticles(params().FillMCParticles())
  , fFillSimPhotons(params().FillSimPhotons())
  , fFillSimChannels(params().FillSimChannels())
  , fFillAuxDetSimChannels(params().FillAuxDetSimChannels())
  , fFillSimEnergyDeposits(
      getOptionalValue(params().FillSimEnergyDeposits).value_or
        (art::ServiceHandle<sim::LArG4Parameters const>()->FillSimEnergyDeposits())
      )
  , fEnergyDepositionInstances(params().EnergyDepositInstanceLabels())
  , fFillAuxDetHits(params().FillAuxDetHits())
  , fAuxDetHitsInstanceLabels(params().AuxDetHitsInstanceLabels())
{

  if(fInputSourcesLabels.size() != fTrackIDOffsets.size()) {
    throw art::Exception(art::errors::Configuration)
      << "Unequal input vector sizes: InputSourcesLabels and TrackIDOffsets.\n";
  }


  for (art::InputTag const& tag: fInputSourcesLabels) {

    if (fFillMCParticles) {
      consumes<std::vector<simb::MCParticle>>(tag);
      consumes<art::Assns<simb::MCParticle, simb::MCTruth, sim::GeneratedParticleInfo>>(tag);
    }

    if (fFillSimChannels) {
      consumes<std::vector<sim::SimChannel>>(tag);
    }

    if (fFillAuxDetSimChannels) {
      consumes<std::vector<sim::AuxDetSimChannel>>(tag);
    }

    if (fFillSimPhotons) {
      if (!fUseLitePhotons) consumes<std::vector<sim::SimPhotons>>(tag);
      else                  consumes<std::vector<sim::SimPhotonsLite>>(tag);

      if (fStoreReflected) {
        art::InputTag const reflected_tag { tag.label(), ReflectedLabel };
        if (!fUseLitePhotons) consumes<std::vector<sim::SimPhotons>>(reflected_tag);
        else                  consumes<std::vector<sim::SimPhotonsLite>>(reflected_tag);
      }
    }

    if (fFillSimEnergyDeposits) {
      for (std::string const& edep_inst: fEnergyDepositionInstances) {
        art::InputTag const edep_tag { tag.label(), edep_inst };
        consumes<std::vector<sim::SimEnergyDeposit>>(edep_tag);
      }
    } // if fill energy deposits

    if (fFillAuxDetHits) {
      for (std::string const& auxdethit_inst: fAuxDetHitsInstanceLabels) {
        art::InputTag const auxdethit_tag { tag.label(), auxdethit_inst };
        consumes<std::vector<sim::AuxDetHit>>(auxdethit_tag);
      }
    }

  } // for input labels


  if (fFillMCParticles) {
    produces< std::vector<simb::MCParticle> >();
    produces< art::Assns<simb::MCTruth, simb::MCParticle, sim::GeneratedParticleInfo> >();
  }
  if (fFillSimChannels) {
    produces< std::vector<sim::SimChannel>  >();
  }
  if (fFillAuxDetSimChannels) {
    produces< std::vector<sim::AuxDetSimChannel> >();
  }

  if (fFillSimPhotons) {
    if(!fUseLitePhotons) produces< std::vector<sim::SimPhotons>     >();
    else                 produces< std::vector<sim::SimPhotonsLite> >();

    if (fStoreReflected) {
      if(!fUseLitePhotons) produces< std::vector<sim::SimPhotons>     >(ReflectedLabel);
      else                 produces< std::vector<sim::SimPhotonsLite> >(ReflectedLabel);
    }
  }

  if (fFillSimEnergyDeposits) {
    for (std::string const& edep_inst: fEnergyDepositionInstances)
      produces< std::vector<sim::SimEnergyDeposit> >(edep_inst);
  } // if

  if (fFillAuxDetHits) {
    for (std::string const& auxdethit_inst: fAuxDetHitsInstanceLabels)
      produces< std::vector<sim::AuxDetHit> >(auxdethit_inst);
  }


  dumpConfiguration();

}

Member Function Documentation

void sim::MergeSimSources::dumpConfiguration ( ) const

private

Definition at line 422 of file MergeSimSources_module.cc.

                                                 {

  mf::LogInfo log("MergeSimSources");
  log << "Configuration:"
    << "\n - " << fInputSourcesLabels.size() << " input sources:";
  for (auto const& [ i_source, tag, offset ]
    : util::enumerate(fInputSourcesLabels, fTrackIDOffsets)
  ) {
    log << "\n   [" << i_source << "] '" << tag.encode()
      << "' (ID offset: " << offset << ")";
  } // for
  if (fFillMCParticles) log << "\n - filling MCParticles";

  if (fFillSimChannels) log << "\n - filling SimChannels";

  if (fFillAuxDetSimChannels) log << "\n - filling AuxDetSimChannels";

  if (fFillSimPhotons) {
    log << "\n - filling Simulated Photons";
    if (fUseLitePhotons) log << "\n   - using photon summary (`SimPhotonsLite`)";
    else                 log << "\n   - using detailed photons (`SimPhotons`)";
    if (fStoreReflected) log << "\n   - also merging reflected light";
  }

  if (fFillSimEnergyDeposits) {
    log << "\n - filling simulated energy deposits ("
      << fEnergyDepositionInstances.size() << " labels:";
    for (std::string const& label: fEnergyDepositionInstances)
      log << " '" << label << "'";
    log << ")";
  }

  if (fFillAuxDetHits) {
    log << "\n - filling auxiliary detector hits ("
      << fAuxDetHitsInstanceLabels.size() << " labels:";
    for (std::string const& label: fAuxDetHitsInstanceLabels)
      log << " '" << label << "'";
    log << ")";
  }

} // sim::MergeSimSources::dumpConfiguration()

void sim::MergeSimSources::produce ( art::Event &  e )

overridevirtual

Implements art::EDProducer.

Definition at line 277 of file MergeSimSources_module.cc.

{

  auto partCol = std::make_unique<std::vector<simb::MCParticle>>();
  auto scCol = std::make_unique<std::vector<sim::SimChannel>>();
  auto PhotonCol = std::make_unique<std::vector<sim::SimPhotons>>();
  auto LitePhotonCol = std::make_unique<std::vector<sim::SimPhotonsLite>>();
  auto ReflPhotonCol = std::make_unique<std::vector<sim::SimPhotons>>();
  auto ReflLitePhotonCol = std::make_unique<std::vector<sim::SimPhotonsLite>>();
  auto tpassn = std::make_unique<art::Assns<simb::MCTruth, simb::MCParticle, sim::GeneratedParticleInfo>>();
  auto adCol = std::make_unique<std::vector<sim::AuxDetSimChannel>>();

  using edeps_t = std::vector<sim::SimEnergyDeposit>;
  std::vector<edeps_t> edepCols;
  if (fFillSimEnergyDeposits)
    edepCols.resize(fEnergyDepositionInstances.size());

  using aux_det_hits_t = std::vector<sim::AuxDetHit>;
  std::vector<aux_det_hits_t> auxdethitCols;
  if (fFillAuxDetHits)
    auxdethitCols.resize(fAuxDetHitsInstanceLabels.size());


  MergeSimSourcesUtility MergeUtility { fTrackIDOffsets };

  for(auto const& [ i_source, input_label ]: util::enumerate(fInputSourcesLabels)) {

    if (fFillMCParticles) {
      art::PtrMaker<simb::MCParticle> const makePartPtr { e };
      auto const input_partCol
        = e.getValidHandle<std::vector<simb::MCParticle>>(input_label);
      MergeUtility.MergeMCParticles(*partCol,*input_partCol,i_source);

      //truth-->particle assoc stuff here
      const std::vector<size_t>& assocVectorPrimitive
        = MergeUtility.GetMCParticleListMap().at(i_source);
      art::FindOneP<simb::MCTruth, sim::GeneratedParticleInfo> mctAssn(input_partCol,e,input_label);
      for(auto const i_p: util::counter(mctAssn.size()))
        tpassn->addSingle(mctAssn.at(i_p), makePartPtr(assocVectorPrimitive[i_p]), mctAssn.data(i_p).ref());
    }

    if (fFillSimChannels) {
      auto const& input_scCol
         = e.getProduct<std::vector<sim::SimChannel>>(input_label);
      MergeUtility.MergeSimChannels(*scCol,input_scCol,i_source);
    }

    if (fFillAuxDetSimChannels) {
      auto const& input_adCol
        = e.getProduct<std::vector<sim::AuxDetSimChannel>>(input_label);
      MergeUtility.MergeAuxDetSimChannels(*adCol,input_adCol,i_source);
    }

    if (fFillSimPhotons) {
      if(!fUseLitePhotons){
        auto const& input_PhotonCol
          = e.getProduct<std::vector<sim::SimPhotons>>(input_label);
        MergeUtility.MergeSimPhotons(*PhotonCol,input_PhotonCol);
      }
      else{
        auto const& input_LitePhotonCol
         = e.getProduct<std::vector<sim::SimPhotonsLite>>(input_label);
        MergeUtility.MergeSimPhotonsLite(*LitePhotonCol,input_LitePhotonCol);
      }

      if (fStoreReflected) {
        art::InputTag const input_reflected_label
          { input_label.label(), ReflectedLabel };
        if(!fUseLitePhotons){
          auto const& input_PhotonCol
            = e.getProduct<std::vector<sim::SimPhotons>>(input_reflected_label);
          MergeUtility.MergeSimPhotons(*ReflPhotonCol,input_PhotonCol);
        }
        else{
          auto const& input_LitePhotonCol
            = e.getProduct<std::vector<sim::SimPhotonsLite>>(input_reflected_label);
          MergeUtility.MergeSimPhotonsLite(*ReflLitePhotonCol,input_LitePhotonCol);
        }
      }
    }


    if (fFillSimEnergyDeposits) {
      for (auto const& [ edep_inst, edepCol ]
        : util::zip(fEnergyDepositionInstances, edepCols))
      {
        art::InputTag const edep_tag { input_label.label(), edep_inst };
        MergeUtility.MergeSimEnergyDeposits(edepCol,
                                            e.getProduct<edeps_t>(edep_tag),
                                            i_source);
      } // for edep
    } // if fill energy depositions


    if (fFillAuxDetHits) {
      for (auto const& [ auxdethit_inst, auxdethitCol ]
        : util::zip(fAuxDetHitsInstanceLabels, auxdethitCols))
      {
        art::InputTag const auxdethit_tag { input_label.label(), auxdethit_inst };
        MergeUtility.MergeAuxDetHits(auxdethitCol,
                                     e.getProduct<aux_det_hits_t>(auxdethit_tag),
                                     i_source);
      }
    }

  }

  if (fFillMCParticles) {
    e.put(std::move(partCol));
    e.put(std::move(tpassn));
  }
  if (fFillSimChannels) {
    e.put(std::move(scCol));
  }
  if (fFillAuxDetSimChannels) {
    e.put(std::move(adCol));
  }
  if (fFillSimPhotons) {
    if(!fUseLitePhotons) e.put(std::move(PhotonCol));
    else                 e.put(std::move(LitePhotonCol));
    if(fStoreReflected) {
      if(!fUseLitePhotons) e.put(std::move(ReflPhotonCol), ReflectedLabel);
      else                 e.put(std::move(ReflLitePhotonCol), ReflectedLabel);
    }
  }

  if(fFillSimEnergyDeposits) {
    for (auto&& [ edep_inst, edepCol ]
      : util::zip(fEnergyDepositionInstances, edepCols))
    {
      e.put(std::make_unique<edeps_t>(move(edepCol)), edep_inst);
    } // for
  } // if fill energy deposits

  if(fFillAuxDetHits) {
    for (auto&& [ auxdethit_inst, auxdethitCol ]
      : util::zip(fAuxDetHitsInstanceLabels, auxdethitCols))
    {
      e.put(std::make_unique<aux_det_hits_t>(move(auxdethitCol)), auxdethit_inst);
    }
  }

}

Member Data Documentation

std::vector<std::string> const sim::MergeSimSources::fAuxDetHitsInstanceLabels

private

Definition at line 142 of file MergeSimSources_module.cc.

std::vector<std::string> const sim::MergeSimSources::fEnergyDepositionInstances

private

Definition at line 140 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillAuxDetHits

private

Definition at line 141 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillAuxDetSimChannels

private

Definition at line 138 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillMCParticles

private

Definition at line 135 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillSimChannels

private

Definition at line 137 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillSimEnergyDeposits

private

Definition at line 139 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fFillSimPhotons

private

Definition at line 136 of file MergeSimSources_module.cc.

std::vector<art::InputTag> const sim::MergeSimSources::fInputSourcesLabels

private

Definition at line 131 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fStoreReflected

private

Definition at line 134 of file MergeSimSources_module.cc.

std::vector<int> const sim::MergeSimSources::fTrackIDOffsets

private

Definition at line 132 of file MergeSimSources_module.cc.

bool const sim::MergeSimSources::fUseLitePhotons

private

Definition at line 133 of file MergeSimSources_module.cc.

std::string const sim::MergeSimSources::ReflectedLabel { "Reflected" }

staticprivate

Definition at line 144 of file MergeSimSources_module.cc.

---

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

• larsim/larsim/MergeSimSources/MergeSimSources_module.cc