larg4::LArG4 Class Reference

Runs Geant4 simulation and propagation of electrons and photons to readout. More...

Inheritance diagram for larg4::LArG4:

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

Public Member Functions
	LArG4 (fhicl::ParameterSet const &pset)
	Standard constructor and destructor for an FMWK module. More...
virtual	~LArG4 ()
void	produce (art::Event &evt)
void	beginJob ()
void	beginRun (art::Run &run)
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
std::unique_ptr< util::PositionInVolumeFilter >	CreateParticleVolumeFilter (std::set< std::string > const &vol_names) const
	Configures and returns a particle filter. More...

Private Attributes
g4b::G4Helper *	fG4Help
	G4 interface object. More...
larg4::LArVoxelListAction *	flarVoxelListAction
	Geant4 user action to accumulate LAr voxel information. More...
larg4::ParticleListAction *	fparticleListAction
	Geant4 user action to particle information. More...
std::string	fG4PhysListName
	predefined physics list to use if not making a custom one More...
std::string	fG4MacroPath
bool	fCheckOverlaps
	Whether to use the G4 overlap checker. More...
bool	fdumpParticleList
	Whether each event's sim::ParticleList will be displayed. More...
bool	fdumpSimChannels
	Whether each event's sim::Channel will be displayed. More...
bool	fUseLitePhotons
bool	fStoreReflected
int	fSmartStacking
	Whether to instantiate and use class to. More...
double	fOffPlaneMargin = 0.
	dictate how tracks are put on stack. More...
std::vector< std::string >	fInputLabels
std::vector< std::string >	fKeepParticlesInVolumes
	Only write particles that have trajectories through these volumes. More...
bool	fSparsifyTrajectories
	Sparsify MCParticle Trajectories. More...

Detailed Description

Runs Geant4 simulation and propagation of electrons and photons to readout.

This module collects generated particles from one or more generators and processes them through Geant4.

Input

The module reads the particles to process from simb::MCTruth records. Each particle generator is required to produce a vector of such records: std::vector<simb::MCTruth>.

The module allows two operation modes:

1. process specific generators: the label of the generator modules to be processed is specified explicitly in LArG4 configuration
2. process all truth information generated so far: no generator is specified in the LArG4 module configuration, and the module will process all data products of type std::vector<simb::MCTruth>, in a non-specified order

For each simb::MCTruth, a Geant4 run is started. The interface with Geant4 is via a helper class provided by nutools. Only the particles in the truth record which have status code (simb::MCParticle::StatusCode()) equal to 1 are processed. These particles are called, in LArG4 jargon, primaries.

Output

The LArG4 module produces:

• a collection of sim::SimChannel: each sim::SimChannel represents the set of energy depositions in liquid argon which drifted and were observed on a certain channel; it includes physics effects like attenuation, diffusion, electric field distortion, etc. Information of the generating Geant4 "track" is retained;
• a collection of sim::SimPhotons or sim::SimPhotonsLite: each sim::SimPhotons represents the set of individual photons reaching a channel of the optical detector; it includes physics effects as well as quantum efficiency of the detector (to reduce data size early in the process); sim::SimPhotonsLite drops the information of the single photons and stores only collective information (e.g. their number).
• a collection of sim::OpDetBacktrackerRecord (to be documented)
• a collection of sim::AuxDetSimChannel (to be documented)
• a collection of simb::MCParticle: the particles generated in the interaction of the primary particles with the material in the world are stored, but minor filtering by geometry and by physics is possible. An association of them with the originating simb::MCTruth object is also produced.

Notes on the conventions

• all and the particles in the truth record (simb::MCTruth) which have status code (simb::MCParticle::StatusCode()) equal to 1 are passed to Geant4. These particles are called, in LArG4 jargon, primaries. The interface with Geant4 is via a helper class provided by nutools.
• normally, information about each particle that Geant4 propagates (which Geant4 calls tracks), primary or not, is saved as an individual simb::MCParticle object into the output particle list. Each simb::MCParticle includes a Geant4-like track ID which is also recorded into each sim::IDE deposited by that particle. This information can be used to track all the deposition from a particle, or to backtrack the particle responsible of a deposition (but see below...). Note that the stored track ID may be different than the one Geant4 used (and, in particular, it's guaranteed to be unique within a sim::LArG4 instance output).
• there are options (some set in sim::LArG4Parameters service) which allow for Geant4 tracks not to be saved as simb::MCParticle (e.g. ParticleKineticEnergyCut, KeepEMShowerDaughters). When these particles have deposited energy, their sim::IDE will report the ID of the first parent Geant4 track which is saved in the simb::MCParticle list, but with its sign flipped. Therefore, when tracking or backtracking (see above), comparisons should be performed using the absolute value of the sim::IDE (e.g. std::abs(ide.trackID)).

Timing

The LArG4 module produces sim::SimChannel objects from generated simb::MCParticle. Each particle ("primary") is assigned the time taken from its vertex (a 4-vector), which is expected to be represented in nanoseconds. The sim::SimChannel object is a collection of sim::IDE in time. The position in the sim::IDE is the location where some ionization occurred. The time associated to a sim::IDE is stored in tick units. The time it represents is the time when the ionization happened, which is the time of the primary particle plus the propagation time to the ionization location, plus the drift time, which the ionized electrons take to reach the anode wire. This time is then shifted to the frame of the electronics time via detinfo::DetectorClocks::G4ToElecTime(), which adds a configurable time offset. The time is converted into ticks via detinfo::DetectorClocks::TPCClock(), and this is the final value associated to the sim::IDE. For a more complete overview, see https://cdcvs.fnal.gov/redmine/projects/larsoft/wiki/Simulation#Simulation-Timing

Randomness

The random number generators used by this process are:

• 'GEANT' instance: used by Geant4
• 'propagation' instance: used in electron propagation

Configuration parameters

• G4PhysListName (string, default: "larg4::PhysicsList"): whether to use the G4 overlap checker, which catches different issues than ROOT
• CheckOverlaps (bool, default: false): whether to use the G4 overlap checker
• DumpParticleList (bool, default: false): whether to print all MCParticles tracked
• DumpSimChannels (bool, default: false): whether to print all depositions on each SimChannel
• SmartStacking (int, default: 0): whether to use class to dictate how tracks are put on stack (nonzero is on)
• KeepParticlesInVolumes (list of strings, default: empty): list of volumes in which to keep simb::MCParticle objects (empty keeps all)
• GeantCommandFile (string, required): G4 macro file to pass to G4Helper for setting G4 command
• Seed (integer, not defined by default): if defined, override the seed for random number generator used in Geant4 simulation (which is obtained from NuRandomService by default)
• PropagationSeed (integer, not defined by default): if defined, override the seed for the random generator used for electrons propagation to the wire planes (obtained from the NuRandomService by default)
• InputLabels (list of strings, default: process all truth): optional list of generator labels whose produced simb::MCTruth will be simulated; if not specified, all simb::MCTruth vector data products are simulated
• ChargeRecoveryMargin (double, default: 0): sets the maximum distance from a plane for the wire charge recovery to occur, in centimeters; for details on how it works, see larg4::LArVoxelReadout::SetOffPlaneChargeRecoveryMargin(). A value of 0 effectively disables this feature. All TPCs will have the same margin applied.

Simulation details

Reflectivity to optical photons

Two models are supported for the simulation of (scintillation) light crossing detector surfaces:

1. the standard one from GEANT4, implemented in G4OpBoundaryProcess
2. a simplified one, implemented in larg4::OpBoundaryProcessSimple

The model is chosen according to the value of detinfo::DetectorProperties::SimpleBoundary(), and the choice is currently exerted by larg4::OpticalPhysics.

The simplified model is faster and simpler: it only deals with absorption and reflection (both specular and diffues). This is the "default" model used in most contexts.

GEANT4 model is more complete and slower. It may take some art to fully configure all the properties of the materials at the sides of the surfaces. The price is a detailed simulation that includes among others refraction and wavelength shifting.

Definition at line 297 of file LArG4_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

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

explicit

Standard constructor and destructor for an FMWK module.

Definition at line 344 of file LArG4_module.cc.

References art::errors::Configuration, art::EngineCreator::createEngine(), e, fG4MacroPath, sim::LArG4Parameters::FillSimEnergyDeposits(), fInputLabels, fSparsifyTrajectories, fStoreReflected, fUseLitePhotons, LOG_DEBUG, sim::LArG4Parameters::NoElectronPropagation(), sim::LArG4Parameters::NoPhotonPropagation(), art::ProductRegistryHelper::produces(), art::EngineCreator::rng(), art::errors::ServiceNotFound, phot::PhotonVisibilityService::StoreReflected(), and sim::LArG4Parameters::UseLitePhotons().

    : fG4Help                (0)
    , flarVoxelListAction    (0)
    , fparticleListAction    (0)
    , fG4PhysListName        (pset.get< std::string >("G4PhysListName","larg4::PhysicsList"))
    , fCheckOverlaps         (pset.get< bool        >("CheckOverlaps",false)                )
    , fdumpParticleList      (pset.get< bool        >("DumpParticleList",false)             )
    , fdumpSimChannels       (pset.get< bool        >("DumpSimChannels", false)             )
    , fStoreReflected        (false)
    , fSmartStacking         (pset.get< int         >("SmartStacking",0)                    )
    , fOffPlaneMargin        (pset.get< double      >("ChargeRecoveryMargin",0.0)           )
    , fKeepParticlesInVolumes        (pset.get< std::vector< std::string > >("KeepParticlesInVolumes",{}))
    , fSparsifyTrajectories  (pset.get< bool        >("SparsifyTrajectories",false)         )
  {
    LOG_DEBUG("LArG4") << "Debug: LArG4()";
    art::ServiceHandle<art::RandomNumberGenerator> rng;

    if (pset.has_key("Seed")) {
      throw art::Exception(art::errors::Configuration)
        << "The configuration of LArG4 module has the discontinued 'Seed' parameter.\n"
        "Seeds are now controlled by two parameters: 'GEANTSeed' and 'PropagationSeed'.";
    }
    // setup the random number service for Geant4, the "G4Engine" label is a
    // special tag setting up a global engine for use by Geant4/CLHEP;
    // obtain the random seed from NuRandomService,
    // unless overridden in configuration with key "Seed" or "GEANTSeed"
    art::ServiceHandle<rndm::NuRandomService>()
      ->createEngine(*this, "G4Engine", "GEANT", pset, "GEANTSeed");
    // same thing for the propagation engine:
    art::ServiceHandle<rndm::NuRandomService>()
      ->createEngine(*this, "HepJamesRandom", "propagation", pset, "PropagationSeed");

    //get a list of generators to use, otherwise, we'll end up looking for anything that's
    //made an MCTruth object
    bool useInputLabels = pset.get_if_present< std::vector<std::string> >("InputLabels",fInputLabels);
    if(!useInputLabels) fInputLabels.resize(0);
    
    art::ServiceHandle<sim::LArG4Parameters> lgp;
    fUseLitePhotons = lgp->UseLitePhotons();
    
    if(!lgp->NoPhotonPropagation()){
      try {
        art::ServiceHandle<phot::PhotonVisibilityService> pvs;
        fStoreReflected = pvs->StoreReflected();
      }
      catch (art::Exception const& e) {
        // If the service is not configured, then just keep the default
        // false for reflected light. If reflected photons are simulated
        // without PVS they will show up in the regular SimPhotons collection
        if (e.categoryCode() != art::errors::ServiceNotFound) throw;
      }
      
      if(!fUseLitePhotons) {
        produces< std::vector<sim::SimPhotons> >();
        if(fStoreReflected) {
          produces< std::vector<sim::SimPhotons> >("Reflected");
        }
      }
      else{
        produces< std::vector<sim::SimPhotonsLite> >();
        produces< std::vector<sim::OpDetBacktrackerRecord> >();
        if(fStoreReflected) {
          produces< std::vector<sim::SimPhotonsLite> >("Reflected");
          produces< std::vector<sim::OpDetBacktrackerRecord> >("Reflected");
        }
      }
    }

    if(lgp->FillSimEnergyDeposits()){
      produces < std::vector<sim::SimEnergyDeposit> >("TPCActive");
      produces < std::vector<sim::SimEnergyDeposit> >("Other");
    }

    produces< std::vector<simb::MCParticle> >();
    if(!lgp->NoElectronPropagation()) produces< std::vector<sim::SimChannel>  >();
    produces< std::vector<sim::AuxDetSimChannel> >();
    produces< art::Assns<simb::MCTruth, simb::MCParticle, sim::GeneratedParticleInfo> >();

    // constructor decides if initialized value is a path or an environment variable
    cet::search_path sp("FW_SEARCH_PATH");

    sp.find_file(pset.get< std::string >("GeantCommandFile"), fG4MacroPath);
    struct stat sb;
    if (fG4MacroPath.empty() || stat(fG4MacroPath.c_str(), &sb)!=0)
      // failed to resolve the file name
      throw cet::exception("NoG4Macro") << "G4 macro file "
                                        << fG4MacroPath
                                        << " not found!\n";

  }

larg4::LArG4::~LArG4 ( )

virtual

Definition at line 437 of file LArG4_module.cc.

References fG4Help.

  {
    if(fG4Help) delete fG4Help;
  }

Member Function Documentation

void larg4::LArG4::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 443 of file LArG4_module.cc.

References g4b::UserActionManager::AddAndAdoptAction(), g4b::G4Helper::ConstructDetector(), larg4::IonizationAndScintillation::CreateInstance(), fCheckOverlaps, fG4Help, fG4MacroPath, fG4PhysListName, fOffPlaneMargin, fparticleListAction, fSmartStacking, geo::GeometryCore::GDMLFile(), larg4::MaterialPropertyLoader::GetPropertiesFromServices(), g4b::G4Helper::GetRunManager(), g4b::G4Helper::InitPhysics(), g4b::UserActionManager::Instance(), sim::LArG4Parameters::KeepEMShowerDaughters(), larg4::LArVoxelReadout::Setup_t::offPlaneMargin, geo::GeometryCore::OpDetGeoName(), sim::LArG4Parameters::ParticleKineticEnergyCut(), larg4::LArVoxelReadoutGeometry::Setup_t::readoutSetup, art::EngineCreator::rng(), g4b::G4Helper::SetOverlapCheck(), g4b::G4Helper::SetParallelWorlds(), g4b::G4Helper::SetUserAction(), sim::LArG4Parameters::StoreTrajectories(), and larg4::MaterialPropertyLoader::UpdateGeometry().

  {
    art::ServiceHandle<geo::Geometry> geom;
    auto* rng = &*(art::ServiceHandle<art::RandomNumberGenerator>());

    fG4Help = new g4b::G4Helper(fG4MacroPath, fG4PhysListName);
    if(fCheckOverlaps) fG4Help->SetOverlapCheck(true);
    fG4Help->ConstructDetector(geom->GDMLFile());

    // Get the logical volume store and assign material properties
    larg4::MaterialPropertyLoader* MPL = new larg4::MaterialPropertyLoader();
    MPL->GetPropertiesFromServices();
    MPL->UpdateGeometry(G4LogicalVolumeStore::GetInstance());

    // Tell the detector about the parallel LAr voxel geometry.
    std::vector<G4VUserParallelWorld*> pworlds;
    // Intialize G4 physics and primary generator action
    fG4Help->InitPhysics();

    // create the ionization and scintillation calculator;
    // this is a singleton (!) so it does not make sense
    // to create it in LArVoxelReadoutGeometry
    IonizationAndScintillation::CreateInstance(rng->getEngine("propagation"));

    // make a parallel world for each TPC in the detector
    LArVoxelReadoutGeometry::Setup_t readoutGeomSetupData;
    readoutGeomSetupData.readoutSetup.offPlaneMargin = fOffPlaneMargin;
    readoutGeomSetupData.readoutSetup.propGen
      = &(rng->getEngine("propagation"));
    pworlds.push_back(new LArVoxelReadoutGeometry
      ("LArVoxelReadoutGeometry", readoutGeomSetupData)
      );
    pworlds.push_back( new OpDetReadoutGeometry( geom->OpDetGeoName() ));
    pworlds.push_back( new AuxDetReadoutGeometry("AuxDetReadoutGeometry") );

    fG4Help->SetParallelWorlds(pworlds);

    // moved up
    // Intialize G4 physics and primary generator action
       fG4Help->InitPhysics();

    // Use the UserActionManager to handle all the Geant4 user hooks.
    g4b::UserActionManager* uaManager = g4b::UserActionManager::Instance();

    // User-action class for accumulating LAr voxels.
    art::ServiceHandle<sim::LArG4Parameters> lgp;

    // UserAction for getting past a bug in v4.9.4.p02 of Geant4.
    // This action will not be used once the bug has been fixed
    // The techniques used in this UserAction are not to be repeated
    // as in general they are a very bad idea, ie they take a const
    // pointer and jump through hoops to change it
    // 08-Apr-2014 WGS: It appears that with the shift to Geant 4.9.6 or
    // above, there's no longer any need for the "Bad Idea Action" fix.
    //    larg4::G4BadIdeaAction *bia = new larg4::G4BadIdeaAction(fSmartStacking);
    //    uaManager->AddAndAdoptAction(bia);

    // remove IonizationAndScintillationAction for now as we are ensuring
    // the Reset for each G4Step within the G4SensitiveVolumes
    //larg4::IonizationAndScintillationAction *iasa = new larg4::IonizationAndScintillationAction();
    //uaManager->AddAndAdoptAction(iasa);

    // User-action class for accumulating particles and trajectories
    // produced in the detector.
    fparticleListAction = new larg4::ParticleListAction(lgp->ParticleKineticEnergyCut(),
                                                        lgp->StoreTrajectories(),
                                                        lgp->KeepEMShowerDaughters());
    uaManager->AddAndAdoptAction(fparticleListAction);

    // UserActionManager is now configured so continue G4 initialization
    fG4Help->SetUserAction();

    // With an enormous detector with lots of rock ala LAr34 (nee LAr20)
    // we need to be smarter about stacking.
    if (fSmartStacking>0){
      G4UserStackingAction* stacking_action = new LArStackingAction(fSmartStacking);
      fG4Help->GetRunManager()->SetUserAction(stacking_action);
    }
    

  
  }

void larg4::LArG4::beginRun ( art::Run &  run )

virtual

Reimplemented from art::EDProducer.

Definition at line 526 of file LArG4_module.cc.

References CreateParticleVolumeFilter(), fKeepParticlesInVolumes, fparticleListAction, and larg4::ParticleListAction::ParticleFilter().

                                 {
    // prepare the filter object (null if no filtering)
    
    std::set<std::string> volnameset(fKeepParticlesInVolumes.begin(), fKeepParticlesInVolumes.end());
    fparticleListAction->ParticleFilter(CreateParticleVolumeFilter(volnameset));
    
  }

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(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::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);
}

std::unique_ptr< util::PositionInVolumeFilter > larg4::LArG4::CreateParticleVolumeFilter ( std::set< std::string > const &  vol_names ) const

private

Configures and returns a particle filter.

Definition at line 535 of file LArG4_module.cc.

Referenced by beginRun().

  {
    
    // if we don't have favourite volumes, don't even bother creating a filter
    if (vol_names.empty()) return {};
    
    auto const& geom = *art::ServiceHandle<geo::Geometry>();
    
    std::vector<std::vector<TGeoNode const*>> node_paths
      = geom.FindAllVolumePaths(vol_names);
    
    // collection of interesting volumes
    util::PositionInVolumeFilter::AllVolumeInfo_t GeoVolumePairs;
    GeoVolumePairs.reserve(node_paths.size()); // because we are obsessed
  
    //for each interesting volume, follow the node path and collect
    //total rotations and translations
    for (size_t iVolume = 0; iVolume < node_paths.size(); ++iVolume) {
      std::vector<TGeoNode const*> path = node_paths[iVolume];
      
      TGeoTranslation* pTransl = new TGeoTranslation(0.,0.,0.);
      TGeoRotation* pRot = new TGeoRotation();
      for (TGeoNode const* node: path) {
        TGeoTranslation thistranslate(*node->GetMatrix());
        TGeoRotation thisrotate(*node->GetMatrix());
        pTransl->Add(&thistranslate);
        *pRot=*pRot * thisrotate;
      }
      
      //for some reason, pRot and pTransl don't have tr and rot bits set correctly
      //make new translations and rotations so bits are set correctly
      TGeoTranslation* pTransl2 = new TGeoTranslation(pTransl->GetTranslation()[0],
                                                        pTransl->GetTranslation()[1],
                                                      pTransl->GetTranslation()[2]);
      double phi=0.,theta=0.,psi=0.;
      pRot->GetAngles(phi,theta,psi);
      TGeoRotation* pRot2 = new TGeoRotation();
      pRot2->SetAngles(phi,theta,psi);
      
      TGeoCombiTrans* pTransf = new TGeoCombiTrans(*pTransl2,*pRot2);

      GeoVolumePairs.emplace_back(node_paths[iVolume].back()->GetVolume(), pTransf);

    }
    
    return std::make_unique<util::PositionInVolumeFilter>(std::move(GeoVolumePairs));
    
  } // CreateParticleVolumeFilter()

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

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 larg4::LArG4::produce ( art::Event &  evt )

virtual

The main routine of this module: Fetch the primary particles from the event, simulate their evolution in the detctor, and produce the detector response.

Implements art::EDProducer.

Definition at line 585 of file LArG4_module.cc.

References geo::GeometryCore::AuxDet(), sim::SimChannel::Channel(), larg4::AuxDetReadout::clear(), larg4::OpDetPhotonTable::ClearEnergyDeposits(), larg4::OpDetPhotonTable::ClearTable(), geo::GeometryCore::Cryostat(), DEFINE_ART_MODULE, sim::SimPhotonsLite::DetectedPhotons, sim::dump::DumpMCParticle(), sim::dump::DumpMCTruth(), fdumpParticleList, fdumpSimChannels, fG4Help, sim::LArG4Parameters::FillSimEnergyDeposits(), fInputLabels, fparticleListAction, fSparsifyTrajectories, fStoreReflected, fUseLitePhotons, g4b::G4Helper::G4Run(), art::Ptr< T >::get(), larg4::AuxDetReadout::GetAuxDetSimChannel(), art::DataViewImpl::getByLabel(), larg4::OpDetPhotonTable::GetLitePhotons(), art::DataViewImpl::getManyByType(), larg4::OpDetPhotonTable::GetPhotons(), larg4::ParticleListAction::GetPrimaryTruthIndex(), larg4::LArVoxelReadout::GetSimChannelMap(), larg4::OpDetPhotonTable::GetSimEnergyDeposits(), art::Event::id(), larg4::OpDetPhotonTable::Instance(), larg4::ParticleListAction::isDropped(), LOG_DEBUG, art::errors::LogicError, simb::MCParticle::Mother(), geo::GeometryCore::NAuxDets(), geo::GeometryCore::Ncryostats(), sim::LArG4Parameters::NoElectronPropagation(), geo::GeometryCore::NOpDets(), sim::LArG4Parameters::NoPhotonPropagation(), geo::AuxDetGeo::NSensitiveVolume(), geo::CryostatGeo::NTPC(), sim::SimPhotonsLite::OpChannel, art::Handle< T >::provenance(), art::Event::put(), larg4::ParticleListAction::ResetTrackIDOffset(), simb::MCParticle::SparsifyTrajectory(), sim::SimChannel::TDCIDEMap(), simb::MCParticle::TrackId(), larg4::ParticleListAction::YieldList(), larg4::OpDetPhotonTable::YieldOpDetBacktrackerRecords(), and larg4::OpDetPhotonTable::YieldReflectedOpDetBacktrackerRecords().

  {
    LOG_DEBUG("LArG4") << "produce()";

    // loop over the lists and put the particles and voxels into the event as collections
    std::unique_ptr< std::vector<sim::SimChannel>  >               scCol                      (new std::vector<sim::SimChannel>);
    std::unique_ptr< std::vector< sim::AuxDetSimChannel > >        adCol                      (new  std::vector<sim::AuxDetSimChannel> );
    auto tpassn = std::make_unique<art::Assns<simb::MCTruth, simb::MCParticle, sim::GeneratedParticleInfo>>();
    std::unique_ptr< std::vector<simb::MCParticle> >               partCol                    (new std::vector<simb::MCParticle  >);
    std::unique_ptr< std::vector<sim::SimPhotons>  >               PhotonCol                  (new std::vector<sim::SimPhotons>);
    std::unique_ptr< std::vector<sim::SimPhotons>  >               PhotonColRefl              (new std::vector<sim::SimPhotons>);
    std::unique_ptr< std::vector<sim::SimPhotonsLite>  >           LitePhotonCol              (new std::vector<sim::SimPhotonsLite>);
    std::unique_ptr< std::vector<sim::SimPhotonsLite>  >           LitePhotonColRefl          (new std::vector<sim::SimPhotonsLite>);
    std::unique_ptr< std::vector< sim::OpDetBacktrackerRecord > >  cOpDetBacktrackerRecordCol     (new std::vector<sim::OpDetBacktrackerRecord>);
    std::unique_ptr< std::vector< sim::OpDetBacktrackerRecord > >  cOpDetBacktrackerRecordColRefl (new std::vector<sim::OpDetBacktrackerRecord>);

    
    art::PtrMaker<simb::MCParticle> makeMCPartPtr(evt, *this);

    //for energy deposits
    std::unique_ptr< std::vector<sim::SimEnergyDeposit> > edepCol_TPCActive (new std::vector<sim::SimEnergyDeposit>);
    std::unique_ptr< std::vector<sim::SimEnergyDeposit> > edepCol_Other     (new std::vector<sim::SimEnergyDeposit>);

    // Fetch the lists of LAr voxels and particles.
    art::ServiceHandle<sim::LArG4Parameters> lgp;
    art::ServiceHandle<geo::Geometry> geom;

    // Clear the detected photon table
    OpDetPhotonTable::Instance()->ClearTable(geom->NOpDets());
    if(lgp->FillSimEnergyDeposits())
      OpDetPhotonTable::Instance()->ClearEnergyDeposits();

    // reset the track ID offset as we have a new collection of interactions
    fparticleListAction->ResetTrackIDOffset();

    //look to see if there is any MCTruth information for this
    //event
    std::vector< art::Handle< std::vector<simb::MCTruth> > > mclists;
    if(fInputLabels.size()==0)
      evt.getManyByType(mclists);
    else{
      mclists.resize(fInputLabels.size());
      for(size_t i=0; i<fInputLabels.size(); i++)
        evt.getByLabel(fInputLabels[i],mclists[i]);
    }
    
    unsigned int nGeneratedParticles = 0;
    
    // Need to process Geant4 simulation for each interaction separately.
    for(size_t mcl = 0; mcl < mclists.size(); ++mcl){

      art::Handle< std::vector<simb::MCTruth> > mclistHandle = mclists[mcl];

      for(size_t m = 0; m < mclistHandle->size(); ++m){
        art::Ptr<simb::MCTruth> mct(mclistHandle, m);

        LOG_DEBUG("LArG4") << *(mct.get());

        // The following tells Geant4 to track the particles in this interaction.
        fG4Help->G4Run(mct);

        // receive the particle list
        sim::ParticleList particleList = fparticleListAction->YieldList();
        
        for(auto const& partPair: particleList) {
          simb::MCParticle& p = *(partPair.second);
          ++nGeneratedParticles;
          
          // if the particle has been marked as dropped, we don't save it
          // (as of LArSoft ~v5.6 this does not ever happen because
          // ParticleListAction has already taken care of deleting them)
          if (ParticleListAction::isDropped(&p)) continue;
          
          sim::GeneratedParticleInfo const truthInfo{
            fparticleListAction->GetPrimaryTruthIndex(p.TrackId())
            };
          if (!truthInfo.hasGeneratedParticleIndex() && (p.Mother() == 0)) {
            // this means it's primary but with no information; logic error!!
            art::Exception error(art::errors::LogicError);
            error << "Failed to match primary particle:\n";
            sim::dump::DumpMCParticle(error, p, "  ");
            error << "\nwith particles from the truth record '"
              << mclistHandle.provenance()->inputTag() << "':\n";
            sim::dump::DumpMCTruth(error, *mct, 2U, "  "); // 2 points per line
            error << "\n";
            throw error;
          }

          if(fSparsifyTrajectories) p.SparsifyTrajectory();
          
          partCol->push_back(std::move(p));
          
          tpassn->addSingle(mct, makeMCPartPtr(partCol->size() - 1), truthInfo);
          
        } // for(particleList)


        // Has the user request a detailed dump of the output objects?
        if (fdumpParticleList){
          mf::LogInfo("LArG4") << "Dump sim::ParticleList; size()="
                               << particleList.size() << "\n"
                               << particleList;
        }

      }

    }// end loop over interactions
   
    // get the electrons from the LArVoxelReadout sensitive detector
    // Get the sensitive-detector manager.
    G4SDManager* sdManager = G4SDManager::GetSDMpointer();
    
    // Find the sensitive detector with the name "LArVoxelSD".
    OpDetSensitiveDetector *theOpDetDet = dynamic_cast<OpDetSensitiveDetector*>(sdManager->FindSensitiveDetector("OpDetSensitiveDetector"));
 
    // Store the contents of the detected photon table
    //
    if(theOpDetDet){
      
      if(!lgp->NoPhotonPropagation()){

        for (int Reflected = 0; Reflected <= 1; Reflected++) {
          if (Reflected && ! fStoreReflected)
            continue;
          
          if(!fUseLitePhotons){      
            LOG_DEBUG("Optical") << "Storing OpDet Hit Collection in Event";
            std::vector<sim::SimPhotons>& ThePhotons = OpDetPhotonTable::Instance()->GetPhotons(Reflected);
            if (Reflected) PhotonColRefl->reserve(ThePhotons.size());
            else           PhotonCol->reserve(ThePhotons.size());
            for(auto& it : ThePhotons) {
              if (Reflected) PhotonColRefl->push_back(std::move(it));
              else           PhotonCol->push_back(std::move(it));
            }
          }
          else{
            LOG_DEBUG("Optical") << "Storing OpDet Hit Collection in Event";
          
            std::map<int, std::map<int, int> > ThePhotons = OpDetPhotonTable::Instance()->GetLitePhotons(Reflected);
          
            if(ThePhotons.size() > 0){
              LitePhotonCol->reserve(ThePhotons.size());
              for(auto const& it : ThePhotons){
                sim::SimPhotonsLite ph;
                ph.OpChannel = it.first;
                ph.DetectedPhotons = it.second;
                if (Reflected) LitePhotonColRefl->push_back(ph);
                else           LitePhotonCol->push_back(ph);
              }
            }
          }
          if (Reflected)
            *cOpDetBacktrackerRecordColRefl = OpDetPhotonTable::Instance()->YieldReflectedOpDetBacktrackerRecords();
          else
            *cOpDetBacktrackerRecordCol     = OpDetPhotonTable::Instance()->YieldOpDetBacktrackerRecords();
        }
      } //end if no photon propagation
      
      if(lgp->FillSimEnergyDeposits())
        {
          auto const& edepMap = OpDetPhotonTable::Instance()->GetSimEnergyDeposits();
          for(auto const& edepCol : edepMap){
            if(boost::contains(edepCol.first,"TPCActive"))
              edepCol_TPCActive->insert(edepCol_TPCActive->end(),
                                        edepCol.second.begin(),edepCol.second.end());
            else
              edepCol_Other->insert(edepCol_Other->end(),
                                    edepCol.second.begin(),edepCol.second.end());
          }
        }
    }//end if theOpDetDet
    

    if(!lgp->NoElectronPropagation())
      {
    
        // only put the sim::SimChannels into the event once, not once for every
        // MCTruth in the event
        
        std::set<LArVoxelReadout*> ReadoutList; // to be cleared later on
        
        for(unsigned int c = 0; c < geom->Ncryostats(); ++c){
          
          // map to keep track of which channels we already have SimChannels for in scCol
          // remake this map on each cryostat as channels ought not to be shared between 
          // cryostats, just between TPC's
          
          std::map<unsigned int, unsigned int>  channelToscCol;
          
          unsigned int ntpcs =  geom->Cryostat(c).NTPC();
          for(unsigned int t = 0; t < ntpcs; ++t){
            std::string name("LArVoxelSD");
            std::ostringstream sstr;
            sstr << name << "_Cryostat" << c << "_TPC" << t;
            
            // try first to find the sensitive detector specific for this TPC;
            // do not bother writing on screen if there is none (yet)
            G4VSensitiveDetector* sd
              = sdManager->FindSensitiveDetector(sstr.str(), false);
            // if there is none, catch the general one (called just "LArVoxelSD")
            if (!sd) sd = sdManager->FindSensitiveDetector(name, false);
            // If this didn't work, then a sensitive detector with
            // the name "LArVoxelSD" does not exist.
            if ( !sd ){
              throw cet::exception("LArG4") << "Sensitive detector for cryostat "
                                            << c << " TPC " << t << " not found (neither '"
                                            << sstr.str() << "' nor '" << name  << "' exist)\n";
            }
            
            // Convert the G4VSensitiveDetector* to a LArVoxelReadout*.
            LArVoxelReadout* larVoxelReadout = dynamic_cast<LArVoxelReadout*>(sd);
            
            // If this didn't work, there is a "LArVoxelSD" detector, but
            // it's not a LArVoxelReadout object.
            if ( !larVoxelReadout ){
              throw cet::exception("LArG4") << "Sensitive detector '"
                                            << sd->GetName()
                                            << "' is not a LArVoxelReadout object\n";
            }
            
            LArVoxelReadout::ChannelMap_t& channels = larVoxelReadout->GetSimChannelMap(c, t);
            if (!channels.empty()) {
              LOG_DEBUG("LArG4") << "now put " << channels.size() << " SimChannels"
                " from C=" << c << " T=" << t << " into the event";
            }
            
            for(auto ch_pair: channels){
              sim::SimChannel& sc = ch_pair.second;
              
              // push sc onto scCol but only if we haven't already put something in scCol for this channel.
              // if we have, then merge the ionization deposits.  Skip the check if we only have one TPC
              
              if (ntpcs > 1) {
                unsigned int ichan = sc.Channel();
                std::map<unsigned int, unsigned int>::iterator itertest = channelToscCol.find(ichan);
                if (itertest == channelToscCol.end()) {
                  channelToscCol[ichan] = scCol->size();
                  scCol->emplace_back(std::move(sc));
                }
                else {
              unsigned int idtest = itertest->second;
              auto const& tdcideMap = sc.TDCIDEMap();
              for(auto const& tdcide : tdcideMap){
                for(auto const& ide : tdcide.second){
                  double xyz[3] = {ide.x, ide.y, ide.z};
                  scCol->at(idtest).AddIonizationElectrons(ide.trackID,
                                                           tdcide.first,
                                                           ide.numElectrons,
                                                           xyz,
                                                           ide.energy);
                } // end loop to add ionization electrons to  scCol->at(idtest)
              }// end loop over tdc to vector<sim::IDE> map
                } // end if check to see if we've put SimChannels in for ichan yet or not
              }
              else {
                scCol->emplace_back(std::move(sc));
          } // end of check if we only have one TPC (skips check for multiple simchannels if we have just one TPC)
            } // end loop over simchannels for this TPC
            
            
            // mark it for clearing
            ReadoutList.insert(const_cast<LArVoxelReadout*>(larVoxelReadout));
            
          } // end loop over tpcs
        }// end loop over cryostats
        
        for (LArVoxelReadout* larVoxelReadout: ReadoutList){
          larVoxelReadout->ClearSimChannels();
        }
      }//endif electron prop
    
    // only put the sim::AuxDetSimChannels into the event once, not once for every
    // MCTruth in the event
    
    adCol->reserve(geom->NAuxDets());
    for(unsigned int a = 0; a < geom->NAuxDets(); ++a){

      // there should always be at least one senstive volume because 
      // we make one for the full aux det if none are specified in the 
      // gdml file - see AuxDetGeo.cxx
      for(size_t sv = 0; sv < geom->AuxDet(a).NSensitiveVolume(); ++sv){

          // N.B. this name convention is used when creating the
          //      AuxDetReadout SD in AuxDetReadoutGeometry
        std::stringstream name;
        name << "AuxDetSD_AuxDet" << a << "_" << sv;
        G4VSensitiveDetector* sd = sdManager->FindSensitiveDetector(name.str().c_str());
        if ( !sd ){
          throw cet::exception("LArG4") << "Sensitive detector '"
          << name.str()
          << "' does not exist\n";
        }
        
          // Convert the G4VSensitiveDetector* to a AuxDetReadout*.
        larg4::AuxDetReadout *auxDetReadout = dynamic_cast<larg4::AuxDetReadout*>(sd);
        
        LOG_DEBUG("LArG4") << "now put the AuxDetSimTracks in the event";
        
        const sim::AuxDetSimChannel adsc = auxDetReadout->GetAuxDetSimChannel();
        adCol->push_back(adsc);
        auxDetReadout->clear();
      }
      
    } // Loop over AuxDets
        
    mf::LogInfo("LArG4")
      << "Geant4 simulated " << nGeneratedParticles << " MC particles, we keep "
      << partCol->size() << " .";
    
    if (fdumpSimChannels) {
      mf::LogVerbatim("DumpSimChannels")
        << "Event " << evt.id()
        << ": " << scCol->size() << " channels with signal";
      unsigned int nChannels = 0;
      for (const sim::SimChannel& sc: *scCol) {
         mf::LogVerbatim out("DumpSimChannels");
         out << " #" << nChannels << ": ";
        // dump indenting with "    ", but not on the first line
        sc.Dump(out, "  ");
        ++nChannels;
      } // for
    } // if dump SimChannels

    if(!lgp->NoElectronPropagation()) evt.put(std::move(scCol));
    
    evt.put(std::move(adCol));
    evt.put(std::move(partCol));
    if(!lgp->NoPhotonPropagation()){
      if(!fUseLitePhotons){
        evt.put(std::move(PhotonCol));
        if (fStoreReflected)
          evt.put(std::move(PhotonColRefl),"Reflected");
      }
      else{
        evt.put(std::move(LitePhotonCol));
        evt.put(std::move(cOpDetBacktrackerRecordCol));
        if (fStoreReflected) {
          evt.put(std::move(LitePhotonColRefl),"Reflected");
          evt.put(std::move(cOpDetBacktrackerRecordColRefl),"Reflected");
        }
      }
    }
    evt.put(std::move(tpassn));

    if(lgp->FillSimEnergyDeposits()){
      evt.put(std::move(edepCol_TPCActive),"TPCActive");
      evt.put(std::move(edepCol_Other),"Other");
    }
    return;
  } // LArG4::produce()

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 larg4::LArG4::fCheckOverlaps

private

Whether to use the G4 overlap checker.

Definition at line 319 of file LArG4_module.cc.

Referenced by beginJob().

bool larg4::LArG4::fdumpParticleList

private

Whether each event's sim::ParticleList will be displayed.

Definition at line 320 of file LArG4_module.cc.

Referenced by produce().

bool larg4::LArG4::fdumpSimChannels

private

Whether each event's sim::Channel will be displayed.

Definition at line 321 of file LArG4_module.cc.

Referenced by produce().

g4b::G4Helper* larg4::LArG4::fG4Help

private

G4 interface object.

Definition at line 312 of file LArG4_module.cc.

Referenced by beginJob(), produce(), and ~LArG4().

std::string larg4::LArG4::fG4MacroPath

private

directory path for Geant4 macro file to be executed before main MC processing.

Definition at line 317 of file LArG4_module.cc.

Referenced by beginJob(), and LArG4().

std::string larg4::LArG4::fG4PhysListName

private

predefined physics list to use if not making a custom one

Definition at line 316 of file LArG4_module.cc.

Referenced by beginJob().

std::vector<std::string> larg4::LArG4::fInputLabels

private

Definition at line 327 of file LArG4_module.cc.

Referenced by LArG4(), and produce().

std::vector<std::string> larg4::LArG4::fKeepParticlesInVolumes

private

Only write particles that have trajectories through these volumes.

Definition at line 328 of file LArG4_module.cc.

Referenced by beginRun().

larg4::LArVoxelListAction* larg4::LArG4::flarVoxelListAction

private

Geant4 user action to accumulate LAr voxel information.

Definition at line 313 of file LArG4_module.cc.

double larg4::LArG4::fOffPlaneMargin = 0.

private

dictate how tracks are put on stack.

Off-plane charge recovery margin

Definition at line 325 of file LArG4_module.cc.

Referenced by beginJob().

larg4::ParticleListAction* larg4::LArG4::fparticleListAction

private

Geant4 user action to particle information.

Definition at line 314 of file LArG4_module.cc.

Referenced by beginJob(), beginRun(), and produce().

int larg4::LArG4::fSmartStacking

private

Whether to instantiate and use class to.

Definition at line 324 of file LArG4_module.cc.

Referenced by beginJob().

bool larg4::LArG4::fSparsifyTrajectories

private

Sparsify MCParticle Trajectories.

Definition at line 330 of file LArG4_module.cc.

Referenced by LArG4(), and produce().

bool larg4::LArG4::fStoreReflected

private

Definition at line 323 of file LArG4_module.cc.

Referenced by LArG4(), and produce().

bool larg4::LArG4::fUseLitePhotons

private

Definition at line 322 of file LArG4_module.cc.

Referenced by LArG4(), and produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/LArG4/LArG4_module.cc