A module for optical MC testing and library building. More...

Inheritance diagram for evgen::LightSource:

Classes
class	MaterialPointFilter
	Filters a point according to the material at that point. More...

Public Types
using	ModuleType = EDProducer

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

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

void	produce (art::Event &evt)

void	beginRun (art::Run &run)

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
simb::MCTruth	Sample ()

void	checkMaterials () const
	Throws an exception if any of the configured materials is not present. More...

bool	readParametersFromInputFile ()

Private Attributes
std::string	fVersion

std::ifstream	fInputFile

std::string	fFileName

char	fDummyString [256]

TTree *	fPhotonsGenerated

TLorentzVector	fShotPos

TLorentzVector	fShotMom

Int_t	fEvID

int	fSourceMode

bool	fFillTree

int	fPosDist

int	fTDist

int	fPDist

std::set< std::string > const	fSelectedMaterials
	Names of materials to consider scintillation from. More...

int	fXSteps

int	fYSteps

int	fZSteps

sim::PhotonVoxelDef	fThePhotonVoxelDef

int	fVoxelCount

int	fCurrentVoxel

geo::Vector_t	fTPCCenter

std::vector< double >	fRegionMin

std::vector< double >	fRegionMax

bool	fUseCustomRegion

geo::Point_t	fCenter
	Central position of source [cm]. More...

bool	fPointSource

double	fT

double	fSigmaX

double	fSigmaY

double	fSigmaZ

double	fSigmaT

double	fP

double	fSigmaP

int	fN

double const	fNMaxF
	Maximum number of attempted samplings (factor on top of `fN`). More...

int	fFirstVoxel

int	fLastVoxel

CLHEP::HepRandomEngine &	fEngine

geo::GeometryCore const &	fGeom
	Geometry service provider (cached). More...

Static Private Attributes
static const int	kUNIF = 0

static const int	kGAUS = 1

static const int	kFILE = 0

static const int	kSCAN = 1

Detailed Description

A module for optical MC testing and library building.

Light source event generator which simulate an extended isotropic photon source.

The light source can be run in two modes, file mode or scan mode. Each requires the specification of a different set of parameters.

File mode

Light source position, intensity and shape are supplied on an event by event basis in a text file. See the example provided for the format. Pararmeters required:

int32   SourceMode = 0      - sets light source to file mode
string  FileName            - file of per event light source specifications
int32   PosDist             - how to distribute production points sampled in momentum, position
int32   PDist                   and time ranges specified.  For all of these :
int32   TDist                   0 = uniform and 1 = gauss
bool    FillTree            - whether to write a tree of photon production points to fileservice

Upon reaching the end of the file, the light source will loop back to the first point. hence a one line text file will give a constant light source size, position and intensity.

Scan mode

Divide volume into cuboidal regions and produce an isotropic light source in each, using one region per event. User can specify either to use the full detector volume or some custom specified volume.

This mode is used when building a fast photon sim library, and performing volume scan sensitivity studies.

int32   SourceMode = 1      - sets light source to scan mode
int32   N                   - number of photons to shoot from each point
double  P                   - peak photon momentum (or energy) in eV
double  SigmaP              - momentum distribution width
double  XSteps              - Number of regions to divide volume into in each direction
double  YSteps
double  ZSteps
double  T0                  - Peak time of photon production
double  SigmaT              - time distribution width
int32   PosDist             - how to distribute production points sampled in momentum, position
int32   PDist                 and time ranges specified.  For all of these :
int32   TDist                   0 = uniform and 1 = gaussian
bool    FillTree            - whether to write a tree of photon production points to fileservice
bool    UseCustomRegion     - supply our own volume specification or use the full detector volume?
vdouble[3]  RegionMin       - bounding corners of the custom volume specification
vdouble[3]  RegionMax           (only used if UseCustomRegion=true)

Configuration parameters

This is a partial list of the supported configuration parameters:

SelectMaterials (list of strings, default: empty): if specified, generation points are required to be in a volume with any of the materials included in this list; a useful value is SelectMaterials: [ "LAr" ], which generates photons only in liquid argon; the rest of the constraints are also respected (that means that if the configured generation volume has none of the selected materials, generation can go on forever: see NMaxFactor configuration parameter)
NMaxFactor (real value, default: 100 times N): as a safety valve, do not attempt more than this times the requested number of photons: for example, in an event where 500 photons are required, with NMax: 20 no more than 10000 generations will be attempted; this is useful if the generation volume efficiency can't be guaranteed to be high (e.g. if only generation in liquid argon is requested in a generation volume that is entirely made of steel).

Definition at line 131 of file LightSource_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

evgen::LightSource::LightSource ( fhicl::ParameterSet const & pset )

explicit

Definition at line 264 of file LightSource_module.cc.

References checkMaterials(), art::detail::EngineCreator::createEngine(), fCurrentVoxel, fDummyString, fEngine, fEvID, fFileName, fFillTree, fFirstVoxel, fGeom, fInputFile, fLastVoxel, fN, fNMaxF, fP, fPDist, fPhotonsGenerated, fPointSource, fPosDist, fRegionMax, fRegionMin, fSelectedMaterials, fShotMom, fShotPos, fSigmaP, fSigmaT, fSigmaX, fSigmaY, fSigmaZ, fSourceMode, fT, fTDist, fThePhotonVoxelDef, fUseCustomRegion, fVoxelCount, fXSteps, fYSteps, fZSteps, sim::PhotonVoxelDef::GetNVoxels(), phot::PhotonVisibilityService::GetVoxelDef(), sim::PhotonVoxelDef::GetVoxelSize(), kFILE, and kSCAN.

     : art::EDProducer{pset}
     , fSourceMode{pset.get<int>("SourceMode")}
     , fFillTree{pset.get<bool>("FillTree")}
     , fPosDist{pset.get<int>("PosDist")}
     , fTDist{pset.get<int>("TDist")}
     , fPDist{pset.get<int>("PDist")}
     , fSelectedMaterials{makeSet(pset.get<std::vector<std::string>>("SelectMaterials", {}))}
     , fNMaxF{pset.get<double>("NMaxFactor", 100.0)}
     // create a default random engine; obtain the random seed from NuRandomService,
     // unless overridden in configuration with key "Seed"
     , fEngine(art::ServiceHandle<rndm::NuRandomService>()->registerAndSeedEngine(createEngine(0),
                                                                                  pset,
                                                                                  "Seed"))
     , fGeom(*lar::providerFrom<geo::Geometry const>())
   {
 
     checkMaterials();
 
     // load optional parameters in function
     produces<sumdata::RunData, art::InRun>();
     produces<std::vector<simb::MCTruth>>();
 
     if (fSourceMode == kFILE) {
       fFileName = pset.get<std::string>("SteeringFile");
       fInputFile.open(fFileName.c_str());
       fInputFile.getline(fDummyString, 256);
     }
     else if (fSourceMode == kSCAN) {
       fT = pset.get<double>("T0");
       fSigmaT = pset.get<double>("SigmaT");
       fN = pset.get<int>("N");
 
       fFirstVoxel = pset.get<int>("FirstVoxel");
       fLastVoxel = pset.get<int>("LastVoxel");
 
       fP = pset.get<double>("P");
       fSigmaP = pset.get<double>("SigmaP");
 
       fUseCustomRegion = pset.get<bool>("UseCustomRegion");
       fPointSource = pset.get<bool>("PointSource", false);
 
       if (fUseCustomRegion) {
         fRegionMin = pset.get<std::vector<double>>("RegionMin");
         fRegionMax = pset.get<std::vector<double>>("RegionMax");
         fXSteps = pset.get<int>("XSteps");
         fYSteps = pset.get<int>("YSteps");
         fZSteps = pset.get<int>("ZSteps");
       }
 
       // get TPC dimensions removed. -TA
 
       fCurrentVoxel = 0;
 
       // define voxelization based on parameters read from config.
       // There are two modes - either read the dimensions of the TPC from
       // the geometry, or use values specified by the user.
       if (!fUseCustomRegion) {
         art::ServiceHandle<phot::PhotonVisibilityService const> vis;
         fThePhotonVoxelDef = vis->GetVoxelDef();
       }
       else {
         fThePhotonVoxelDef = sim::PhotonVoxelDef(fRegionMin[0],
                                                  fRegionMax[0],
                                                  fXSteps,
                                                  fRegionMin[1],
                                                  fRegionMax[1],
                                                  fYSteps,
                                                  fRegionMin[2],
                                                  fRegionMax[2],
                                                  fZSteps);
       }
 
       // Set distribution widths to voxel size
 
       fSigmaX = fThePhotonVoxelDef.GetVoxelSize().X() / 2.0;
       fSigmaY = fThePhotonVoxelDef.GetVoxelSize().Y() / 2.0;
       fSigmaZ = fThePhotonVoxelDef.GetVoxelSize().Z() / 2.0;
 
       // Get number of voxels we will step through
 
       fVoxelCount = fThePhotonVoxelDef.GetNVoxels();
 
       if (fLastVoxel < 0) fLastVoxel = fVoxelCount;
 
       mf::LogVerbatim("LightSource") << "Light Source : Determining voxel params : " << fVoxelCount
                                      << " " << fSigmaX << " " << fSigmaY << " " << fSigmaZ;
     }
     else {
       throw cet::exception("LightSource")
         << "EVGEN Light Source : Unrecognised light source mode\n";
     }
 
     if (fFillTree) {
       art::ServiceHandle<art::TFileService const> tfs;
       fPhotonsGenerated = tfs->make<TTree>("PhotonsGenerated", "PhotonsGenerated");
       fPhotonsGenerated->Branch("X", &(fShotPos[0]), "X/D");
       fPhotonsGenerated->Branch("Y", &(fShotPos[1]), "Y/D");
       fPhotonsGenerated->Branch("Z", &(fShotPos[2]), "Z/D");
       fPhotonsGenerated->Branch("T", &(fShotPos[3]), "T/D");
       fPhotonsGenerated->Branch("PX", &(fShotMom[0]), "PX/D");
       fPhotonsGenerated->Branch("PY", &(fShotMom[1]), "PY/D");
       fPhotonsGenerated->Branch("PZ", &(fShotMom[2]), "PZ/D");
       fPhotonsGenerated->Branch("PT", &(fShotMom[3]), "PT/D");
       fPhotonsGenerated->Branch("EventID", &fEvID, "EventID/I");
     }
   }

Member Function Documentation

void evgen::LightSource::beginRun ( art::Run & run )

virtual

Reimplemented from art::EDProducer.

Definition at line 373 of file LightSource_module.cc.

References geo::GeometryCore::DetectorName(), fCurrentVoxel, fFirstVoxel, fGeom, art::fullRun(), and art::Run::put().

   {
     run.put(std::make_unique<sumdata::RunData>(fGeom.DetectorName()), art::fullRun());
 
     fCurrentVoxel = fFirstVoxel;
   }

void evgen::LightSource::checkMaterials ( ) const

private

Throws an exception if any of the configured materials is not present.

Definition at line 541 of file LightSource_module.cc.

References art::errors::Configuration, e, fGeom, fSelectedMaterials, mat, and geo::GeometryCore::ROOTGeoManager().

Referenced by LightSource().

   {
 
     TGeoManager const& manager = *(fGeom.ROOTGeoManager());
 
     { // start scope
       mf::LogDebug log("LightSource");
       auto const& matList = *(manager.GetListOfMaterials());
       log << matList.GetSize() << " elements/materials in the geometry:";
       for (auto const* obj : matList) {
         auto const mat = dynamic_cast<TGeoMaterial const*>(obj);
         log << "\n  '" << mat->GetName() << "' (Z=" << mat->GetZ() << " A=" << mat->GetA() << ")";
       } // for
     }   // end scope
 
     std::set<std::string> missingMaterials;
     for (auto const& matName : fSelectedMaterials) {
       if (!manager.GetMaterial(matName.c_str())) missingMaterials.insert(matName);
     }
     if (missingMaterials.empty()) return;
 
     art::Exception e(art::errors::Configuration);
     e << "Requested filtering on " << missingMaterials.size()
       << " materials which are not present in the geometry:";
     for (auto const& matName : missingMaterials)
       e << "\n  '" << matName << "'";
     throw e << "\n";
 
   } // LightSource::checkMaterials()

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

virtual

Implements art::EDProducer.

Definition at line 381 of file LightSource_module.cc.

References e, fCenter, fCurrentVoxel, fDummyString, fFileName, fFirstVoxel, fInputFile, fLastVoxel, fSigmaX, fSigmaY, fSigmaZ, fSourceMode, fThePhotonVoxelDef, sim::PhotonVoxel::GetCenter(), sim::PhotonVoxelDef::GetPhotonVoxel(), phot::PhotonVisibilityService::IsBuildJob(), kFILE, kSCAN, art::Event::put(), readParametersFromInputFile(), Sample(), art::errors::ServiceNotFound, and phot::PhotonVisibilityService::StoreLightProd().

   {
     if (fSourceMode == kFILE) {
       //  Each event, read coordinates of gun and number of photons to shoot from file
 
       // read in one line
       if (!readParametersFromInputFile()) {
         // Loop file if required
         mf::LogWarning("LightSource") << "EVGEN Light Source : Warning, reached end of file,"
                                       << " looping back to beginning";
         fInputFile.clear();
         fInputFile.seekg(0, std::ios::beg);
         fInputFile.getline(fDummyString, 256);
 
         if (!readParametersFromInputFile()) {
           throw cet::exception("LightSource")
             << "EVGEN Light Source : File error in " << fFileName << "\n";
         }
       }
 
       fThePhotonVoxelDef = sim::PhotonVoxelDef(fCenter.X() - fSigmaX,
                                                fCenter.X() + fSigmaX,
                                                1,
                                                fCenter.Y() - fSigmaY,
                                                fCenter.Y() + fSigmaY,
                                                1,
                                                fCenter.Z() - fSigmaZ,
                                                fCenter.Z() + fSigmaZ,
                                                1);
 
       fCurrentVoxel = 0;
     }
     else if (fSourceMode == kSCAN) {
       //  Step through detector using a number of steps provided in the config file
       //  firing a constant number of photons from each point
       fCenter = fThePhotonVoxelDef.GetPhotonVoxel(fCurrentVoxel).GetCenter();
     }
     else {
       //  Neither file or scan mode, probably a config file error
       throw cet::exception("LightSource") << "EVGEN : Light Source, unrecognised source mode\n";
     }
 
     auto truthcol = std::make_unique<std::vector<simb::MCTruth>>();
 
     truthcol->push_back(Sample());
     int const nPhotons = truthcol->back().NParticles();
 
     evt.put(std::move(truthcol));
 
     phot::PhotonVisibilityService* vis = nullptr;
     try {
       vis = art::ServiceHandle<phot::PhotonVisibilityService>().get();
     }
     catch (art::Exception const& e) {
       // if the service is not configured, then this is not a build job
       // (it is a simple generation job instead)
       if (e.categoryCode() != art::errors::ServiceNotFound) throw;
     }
 
     if (vis && vis->IsBuildJob()) {
       mf::LogVerbatim("LightSource") << "Light source : Stowing voxel params ";
       vis->StoreLightProd(fCurrentVoxel, nPhotons);
     }
 
     if (fCurrentVoxel != fLastVoxel) { ++fCurrentVoxel; }
     else {
       mf::LogVerbatim("LightSource")
         << "EVGEN Light Source fully scanned detector.  Starting over.";
       fCurrentVoxel = fFirstVoxel;
     }
   }

bool evgen::LightSource::readParametersFromInputFile ( )

private

Reads from fInputFile all other parameters in one line.

Returns: whether all reading were successful (ifstream::good()).

Definition at line 609 of file LightSource_module.cc.

References DEFINE_ART_MODULE, fCenter, fInputFile, fN, fP, fSigmaP, fSigmaT, fSigmaX, fSigmaY, fSigmaZ, fT, x, y, and z.

Referenced by produce().

   {
     double x, y, z;
     fInputFile >> x >> y >> z >> fT >> fSigmaX >> fSigmaY >> fSigmaZ >> fSigmaT >> fP >> fSigmaP >>
       fN;
     fCenter = {x, y, z};
     if (!fInputFile.good()) return false;
 
     std::string dummy;
     std::getline(fInputFile, dummy); // this can fail for what I care
     return true;
   } // LightSource::readParametersFromInputFile()

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

simb::MCTruth evgen::LightSource::Sample ( )

private

Definition at line 453 of file LightSource_module.cc.

References evgen::LightSource::MaterialPointFilter::accept(), simb::MCTruth::Add(), simb::MCParticle::AddTrajectoryPoint(), e, fCenter, fEngine, fFillTree, fGeom, fN, fNMaxF, fP, fPDist, fPhotonsGenerated, fPointSource, fPosDist, fSelectedMaterials, fShotMom, fShotPos, fSigmaP, fSigmaT, fSigmaX, fSigmaY, fSigmaZ, fT, fTDist, kGAUS, simb::kSingleParticle, simb::MCTruth::NParticles(), part, simb::MCTruth::SetOrigin(), and x.

Referenced by produce().

   {
     mf::LogVerbatim("LightSource") << "Light source debug : Shooting at " << fCenter;
 
     CLHEP::RandFlat flat(fEngine, -1.0, 1.0);
     CLHEP::RandGaussQ gauss(fEngine);
 
     MaterialPointFilter filter(fGeom, fSelectedMaterials);
 
     simb::MCTruth mct;
     mct.SetOrigin(simb::kSingleParticle);
 
     unsigned long long int const nMax = static_cast<unsigned long long int>(double(fN) * fNMaxF);
     unsigned long long int fired = 0ULL;
     while (mct.NParticles() < fN) {
       if (fired >= nMax) break;
 
       // Choose momentum (supplied in eV, convert to GeV)
       double const p =
         1e-9 * ((fPDist == kGAUS) ? gauss.fire(fP, fSigmaP) : fP + fSigmaP * flat.fire());
 
       // Choose position
       ++fired;
       geo::Point_t x;
       if (fPointSource) { x = fCenter; }
       else {
         if (fPosDist == kGAUS) {
           x = {gauss.fire(fCenter.X(), fSigmaX),
                gauss.fire(fCenter.Y(), fSigmaY),
                gauss.fire(fCenter.Z(), fSigmaZ)};
         }
         else {
           x = {fCenter.X() + fSigmaX * flat.fire(),
                fCenter.Y() + fSigmaY * flat.fire(),
                fCenter.Z() + fSigmaZ * flat.fire()};
         }
 
         if (!filter.accept(x)) continue;
       }
 
       // Choose time
       double t;
       if (fTDist == kGAUS) { t = gauss.fire(fT, fSigmaT); }
       else {
         t = fT + fSigmaT * flat.fire();
       }
 
       //assume the position is relative to the center of the TPC
       //x += fTPCCenter;
 
       fShotPos = TLorentzVector(x.X(), x.Y(), x.Z(), t);
 
       // Choose angles
       double costh = flat.fire();
       double sinth = std::sqrt(1.0 - cet::square(costh));
       double phi = 2 * M_PI * flat.fire();
 
       // Generate momentum 4-vector
 
       fShotMom = TLorentzVector(p * sinth * cos(phi), p * sinth * sin(phi), p * costh, p);
 
       int trackid = -(mct.NParticles() +
                       1); // set track id to -i as these are all primary particles and have id <= 0
       std::string primary("primary");
       int PDG = 0; //optical photons have PDG 0
 
       simb::MCParticle part(trackid, PDG, primary);
       part.AddTrajectoryPoint(fShotPos, fShotMom);
 
       if (fFillTree) fPhotonsGenerated->Fill();
 
       mct.Add(part);
     }
 
     mf::LogInfo("LightSource") << "Generated " << mct.NParticles() << " photons after " << fired
                                << " tries.";
     if (mct.NParticles() < fN) {
       // this may mean `NMaxFactor` is too small, or the volume is wrong;
       // or it may be just expected
       mf::LogWarning("LightSource")
         << "Warning: " << mct.NParticles() << " photons generated after " << fired << " tries, but "
         << fN << " were requested.";
     }
 
     return mct;
   } // LightSource::Sample()

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

geo::Point_t evgen::LightSource::fCenter

private

Central position of source [cm].

Definition at line 226 of file LightSource_module.cc.

Referenced by produce(), readParametersFromInputFile(), and Sample().

int evgen::LightSource::fCurrentVoxel

private

Definition at line 217 of file LightSource_module.cc.

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

char evgen::LightSource::fDummyString[256]

private

Definition at line 191 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

CLHEP::HepRandomEngine& evgen::LightSource::fEngine

private

Definition at line 245 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

Int_t evgen::LightSource::fEvID

private

Definition at line 197 of file LightSource_module.cc.

Referenced by LightSource().

std::string evgen::LightSource::fFileName

private

Definition at line 190 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

bool evgen::LightSource::fFillTree

private

Definition at line 201 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

int evgen::LightSource::fFirstVoxel

private

Definition at line 242 of file LightSource_module.cc.

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

geo::GeometryCore const& evgen::LightSource::fGeom

private

Geometry service provider (cached).

Definition at line 246 of file LightSource_module.cc.

Referenced by beginRun(), checkMaterials(), LightSource(), and Sample().

std::ifstream evgen::LightSource::fInputFile

private

Definition at line 189 of file LightSource_module.cc.

Referenced by LightSource(), produce(), and readParametersFromInputFile().

int evgen::LightSource::fLastVoxel

private

Definition at line 243 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

int evgen::LightSource::fN

private

Definition at line 237 of file LightSource_module.cc.

Referenced by LightSource(), readParametersFromInputFile(), and Sample().

double const evgen::LightSource::fNMaxF

private

Maximum number of attempted samplings (factor on top of fN).

Definition at line 240 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

double evgen::LightSource::fP

private

Definition at line 233 of file LightSource_module.cc.

Referenced by LightSource(), readParametersFromInputFile(), and Sample().

int evgen::LightSource::fPDist

private

Definition at line 204 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

TTree* evgen::LightSource::fPhotonsGenerated

private

Definition at line 194 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

bool evgen::LightSource::fPointSource

private

Definition at line 227 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

int evgen::LightSource::fPosDist

private

Definition at line 202 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

std::vector<double> evgen::LightSource::fRegionMax

private

Definition at line 222 of file LightSource_module.cc.

Referenced by LightSource().

std::vector<double> evgen::LightSource::fRegionMin

private

Definition at line 221 of file LightSource_module.cc.

Referenced by LightSource().

std::set<std::string> const evgen::LightSource::fSelectedMaterials

private

Names of materials to consider scintillation from.

Definition at line 207 of file LightSource_module.cc.

Referenced by checkMaterials(), LightSource(), and Sample().

TLorentzVector evgen::LightSource::fShotMom

private

Definition at line 196 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

TLorentzVector evgen::LightSource::fShotPos

private

Definition at line 195 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

double evgen::LightSource::fSigmaP

private

Definition at line 234 of file LightSource_module.cc.

Referenced by LightSource(), readParametersFromInputFile(), and Sample().

double evgen::LightSource::fSigmaT

private

Definition at line 232 of file LightSource_module.cc.

Referenced by LightSource(), readParametersFromInputFile(), and Sample().

double evgen::LightSource::fSigmaX

private

Definition at line 229 of file LightSource_module.cc.

Referenced by LightSource(), produce(), readParametersFromInputFile(), and Sample().

double evgen::LightSource::fSigmaY

private

Definition at line 230 of file LightSource_module.cc.

Referenced by LightSource(), produce(), readParametersFromInputFile(), and Sample().

double evgen::LightSource::fSigmaZ

private

Definition at line 231 of file LightSource_module.cc.

Referenced by LightSource(), produce(), readParametersFromInputFile(), and Sample().

int evgen::LightSource::fSourceMode

private

Definition at line 200 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

double evgen::LightSource::fT

private

Definition at line 228 of file LightSource_module.cc.

Referenced by LightSource(), readParametersFromInputFile(), and Sample().

int evgen::LightSource::fTDist

private

Definition at line 203 of file LightSource_module.cc.

Referenced by LightSource(), and Sample().

sim::PhotonVoxelDef evgen::LightSource::fThePhotonVoxelDef

private

Definition at line 214 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

geo::Vector_t evgen::LightSource::fTPCCenter

private

Definition at line 220 of file LightSource_module.cc.

bool evgen::LightSource::fUseCustomRegion

private

Definition at line 223 of file LightSource_module.cc.

Referenced by LightSource().

std::string evgen::LightSource::fVersion

private

Definition at line 180 of file LightSource_module.cc.

int evgen::LightSource::fVoxelCount

private

Definition at line 216 of file LightSource_module.cc.

Referenced by LightSource().

int evgen::LightSource::fXSteps

private

Definition at line 210 of file LightSource_module.cc.

Referenced by LightSource().

int evgen::LightSource::fYSteps

private

Definition at line 211 of file LightSource_module.cc.

Referenced by LightSource().

int evgen::LightSource::fZSteps

private

Definition at line 212 of file LightSource_module.cc.

Referenced by LightSource().

const int evgen::LightSource::kFILE = 0

staticprivate

Definition at line 185 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

const int evgen::LightSource::kGAUS = 1

staticprivate

Definition at line 184 of file LightSource_module.cc.

Referenced by Sample().

const int evgen::LightSource::kSCAN = 1

staticprivate

Definition at line 186 of file LightSource_module.cc.

Referenced by LightSource(), and produce().

const int evgen::LightSource::kUNIF = 0

staticprivate

Definition at line 183 of file LightSource_module.cc.

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

larsim/v09_43_00/source/larsim/EventGenerator/LightSource_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

File mode

Scan mode

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation