phot Namespace Reference

General LArSoft Utilities. More...

Namespaces
	details

Classes
class	ICARUSPhotonMappingTransformations
	Photon library mapping for ICARUS geometry. More...
class	CreateHybridLibrary
class	IPhotonLibrary
	Interface shared by all PhotonLibrary-like classes. More...
class	IPhotonMappingTransformations
	Collection of functions to transform photon mapping data. More...
struct	LibraryDataValidatorStruct
	Trait for determining the validity of library data in a container. More...
class	OpDetVisibilityData
	A container for photon visibility mapping data. More...
class	PhotonMappingIdentityTransformations
	Trivial photon mapping transformation. More...
class	PhotonMappingXMirrorTransformations
	Photon mapping transformation with reflection at x = 0. More...
class	PDFastSimPAR
class	PDFastSimPVS
class	PhotonLibrary
class	PhotonLibraryAnalyzer
class	PhotonLibraryHybrid
	TODO doc. More...
class	PhotonLibraryPropagation
	Fast simulation of propagating the photons created from SimEnergyDeposits. More...
class	PhotonVisibilityService
class	ScintTime
class	ScintTimeLAr

Typedefs
using	OpDetID_t = phot::IPhotonMappingTransformations::OpDetID_t
	Type of (global) optical detector ID. More...
using	MappedCounts_t = phot::IPhotonMappingTransformations::MappedOpDetData_t< phot::IPhotonLibrary::Counts_t >
	Type of mapped visibility counts. More...
using	MappedT0s_t = phot::IPhotonMappingTransformations::MappedOpDetData_t< phot::IPhotonLibrary::T0s_t >
	Type of mapped arrival times. More...
using	MappedParams_t = phot::IPhotonMappingTransformations::MappedOpDetData_t< phot::IPhotonLibrary::Params_t >
	Type of set of parameters for functions. More...
using	MappedFunctions_t = phot::IPhotonMappingTransformations::MappedOpDetData_t< phot::IPhotonLibrary::Functions_t >
	Type of mapped parametrization functions. More...

Functions
template<typename Cont >
bool	isValidLibraryData (Cont &&cont)
	Returns the validity of content of library data in the container. More...
createEngine	fRandPoissPhot (std::make_unique< CLHEP::RandPoissonQ >(fPhotonEngine))
createEngine	fScintTimeEngine (art::ServiceHandle< rndm::NuRandomService >() ->createEngine(*this,"HepJamesRandom","scinttime", p,"SeedScintTime"))

Variables
createEngine	this

Detailed Description

General LArSoft Utilities.

Typedef Documentation

using phot::MappedCounts_t = typedef phot::IPhotonMappingTransformations::MappedOpDetData_t <phot::IPhotonLibrary::Counts_t>

Type of mapped visibility counts.

No data storage is provided.

This is the type returned by phot::PhotonVisibilityService when asked about visibility of a point from all the optical detectors.

It used to be float const*.

Definition at line 42 of file PhotonVisibilityTypes.h.

using phot::MappedFunctions_t = typedef phot::IPhotonMappingTransformations::MappedOpDetData_t <phot::IPhotonLibrary::Functions_t>

Type of mapped parametrization functions.

No data storage is provided.

This is the type returned by phot::PhotonVisibilityService when asked about any parameter directlyt described by functions (glorious ROOT TF1), from a point to all the optical detectors.

Definition at line 83 of file PhotonVisibilityTypes.h.

using phot::MappedParams_t = typedef phot::IPhotonMappingTransformations::MappedOpDetData_t <phot::IPhotonLibrary::Params_t>

Type of set of parameters for functions.

No data storage is provided.

This is the type returned by phot::PhotonVisibilityService when asked about any parametrized... parameter, from a point to all the optical detectors.

Definition at line 69 of file PhotonVisibilityTypes.h.

using phot::MappedT0s_t = typedef phot::IPhotonMappingTransformations::MappedOpDetData_t <phot::IPhotonLibrary::T0s_t>

Type of mapped arrival times.

No data storage is provided.

This is the type returned by phot::PhotonVisibilityService when asked about time of arrival from a point to all the optical detectors.

Definition at line 55 of file PhotonVisibilityTypes.h.

using phot::OpDetID_t = typedef phot::IPhotonMappingTransformations::OpDetID_t

Type of (global) optical detector ID.

Definition at line 27 of file PhotonVisibilityTypes.h.

Function Documentation

createEngine phot::fRandPoissPhot

(

std::make_unique< CLHEP::RandPoissonQ >

fPhotonEngine

)

Definition at line 105 of file PDFastSimPVS_module.cc.

  {
    mf::LogInfo("PDFastSimPVS") << "PDFastSimPVS Module Construct";

    if (fUseLitePhotons) {
      mf::LogInfo("PDFastSimPVS") << "Use Lite Photon." << std::endl;
      produces< std::vector<sim::SimPhotonsLite> >();
      produces< std::vector<sim::OpDetBacktrackerRecord> >();

      if(fStoreReflected) {
        mf::LogInfo("PDFastSimPVS") << "Store Reflected Photons";
        produces< std::vector<sim::SimPhotonsLite> >("Reflected");
        produces< std::vector<sim::OpDetBacktrackerRecord> >("Reflected");
      }
    }
    else {
      mf::LogInfo("PDFastSimPVS") << "Use Sim Photon.";
      produces< std::vector<sim::SimPhotons> >();
      if(fStoreReflected)
      {
        mf::LogInfo("PDFastSimPVS") << "Store Reflected Photons";
        produces< std::vector<sim::SimPhotons> >("Reflected");
      }
    }

    // Propagation times
    // validate configuration
    if(fIncludePropTime &&
       !pset.get_if_present<fhicl::ParameterSet>("VUVTiming", fVUVTimingParams)) {
      throw art::Exception(art::errors::Configuration)
        << "Propagation time simulation requested, but VUVTiming not specified." << "\n";
    }

    if (fIncludePropTime && fStoreReflected &&
        !pset.get_if_present<fhicl::ParameterSet>("VISTiming", fVISTimingParams)) {
      throw art::Exception(art::errors::Configuration)
        << "Reflected light propagation time simulation requested, but VISTiming not specified." << "\n";
    }

    // construct propagation time class
    if (fIncludePropTime) fPropTimeModel = std::make_unique<PropagationTimeModel>(fVUVTimingParams, fVISTimingParams, fScintTimeEngine, fStoreReflected);
  }

createEngine phot::fScintTimeEngine

(

art::ServiceHandle< rndm::NuRandomService >() ->createEngine *,"","",,""

SeedScintTime

)

Definition at line 173 of file PhotonLibraryPropagation_module.cc.

  {
    if (art::ServiceHandle<sim::LArG4Parameters const> {}->UseLitePhotons()) {
      produces<vector<sim::SimPhotonsLite>>();
    }
    else {
      produces<vector<sim::SimPhotons>>();
    }
  }

template<typename Cont >

bool phot::isValidLibraryData

(

Cont &&

cont

)

Returns the validity of content of library data in the container.

Template Parameters

Cont	type of the container being tested

Parameters

cont	a reference to the container being tested

Returns

whether the content of library data in cont is valid.

Customization of this behaviour should be through specialization of phot::LibraryDataValidatorStruct.

Definition at line 389 of file OpDetVisibilityData.h.

                                       {
    return
      LibraryDataValidatorStruct<std::remove_reference_t<Cont>>::isValid(cont);
  } // isValidLibraryData()

Variable Documentation

createEngine phot::this

Definition at line 104 of file PDFastSimPVS_module.cc.