General LArSoft Utilities. More...

Namespaces
	details

Classes
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	PDFastSimANN

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	PhotonMappingIdentityTransformations
	Trivial photon mapping transformation. More...

class	PhotonMappingXMirrorTransformations
	Photon mapping transformation with reflection at x = 0. More...

class	PhotonVisibilityService

class	PropagationTimeModel

class	ScintTime

class	ScintTimeLAr

class	SemiAnalyticalModel

class	TFLoader

class	TFLoaderMLP

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...

double	fast_acos (double xin)

double	interpolate (const std::vector< double > &xData, const std::vector< double > &yData, const double x, const bool extrapolate, size_t i)

double	interpolate2 (const std::vector< double > &xDistances, const std::vector< double > &rDistances, const std::vector< std::vector< std::vector< double >>> &parameters, const double x, const double r, const size_t k)

void	interpolate3 (std::array< double, 3 > &inter, const std::vector< double > &xData, const std::vector< double > &yData1, const std::vector< double > &yData2, const std::vector< double > &yData3, const double x, const bool extrapolate)

template<typename TReal >
static constexpr bool	isApproximatelyEqual (TReal a, TReal b, TReal tolerance=std::numeric_limits< TReal >::epsilon())

template<typename TReal >
static constexpr bool	isApproximatelyZero (TReal a, TReal tolerance=std::numeric_limits< TReal >::epsilon())

template<typename TReal >
static constexpr bool	isDefinitelyLessThan (TReal a, TReal b, TReal tolerance=std::numeric_limits< TReal >::epsilon())

template<typename TReal >
static constexpr bool	isDefinitelyGreaterThan (TReal a, TReal b, TReal tolerance=std::numeric_limits< TReal >::epsilon())

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 38 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 73 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 61 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 49 of file PhotonVisibilityTypes.h.

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

Type of (global) optical detector ID.

Definition at line 25 of file PhotonVisibilityTypes.h.

Function Documentation

double phot::fast_acos ( double xin )

Definition at line 25 of file PhotonPropagationUtils.cxx.

References a0, a1, a2, a3, util::abs(), and x.

Referenced by phot::PropagationTimeModel::getVISTimes(), phot::PropagationTimeModel::propagationTime(), phot::SemiAnalyticalModel::Rectangle_SolidAngle(), phot::SemiAnalyticalModel::VISVisibility(), and phot::SemiAnalyticalModel::VUVVisibility().

   {
     double const a3 = -2.08730442907856008e-02;
     double const a2 = 7.68769404161671888e-02;
     double const a1 = -2.12871094165645952e-01;
     double const a0 = 1.57075835365209659e+00;
     double const x = std::abs(xin);
     double ret = a3;
     ret *= x;
     ret += a2;
     ret *= x;
     ret += a1;
     ret *= x;
     ret += a0;
     ret *= std::sqrt(1.0 - x);
     if (xin >= 0) return ret;
     return M_PI - ret;
   }

double phot::interpolate	(	const std::vector< double > &	xData,
		const std::vector< double > &	yData,
		const double	x,
		const bool	extrapolate,
		size_t	i
	)

Definition at line 49 of file PhotonPropagationUtils.cxx.

References util::size().

Referenced by phot::SemiAnalyticalModel::detectedReflectedVisibilities(), phot::PropagationTimeModel::generateVUVParams(), phot::PropagationTimeModel::getVISTimes(), interpolate2(), phot::SemiAnalyticalModel::VUVAbsorptionLength(), and phot::SemiAnalyticalModel::VUVVisibility().

   {
     if (i == 0) {
       size_t size = xData.size();
       if (x >= xData[size - 2]) { // special case: beyond right end
         i = size - 2;
       }
       else {
         while (x > xData[i + 1])
           i++;
       }
     }
     double xL = xData[i];
     double xR = xData[i + 1];
     double yL = yData[i];
     double yR = yData[i + 1]; // points on either side (unless beyond ends)
     if (!extrapolate) {       // if beyond ends of array and not extrapolating
       if (x < xL) return yL;
       if (x > xR) return yL;
     }
     const double dydx = (yR - yL) / (xR - xL); // gradient
     return yL + dydx * (x - xL);               // linear interpolation
   }

double phot::interpolate2	(	const std::vector< double > &	xDistances,
		const std::vector< double > &	rDistances,
		const std::vector< std::vector< std::vector< double >>> &	parameters,
		const double	x,
		const double	r,
		const size_t	k
	)

Definition at line 77 of file PhotonPropagationUtils.cxx.

References interpolate(), and util::size().

Referenced by phot::SemiAnalyticalModel::VISVisibility().

   {
     // interpolate in x for each r bin, for angle bin k
     const size_t nbins_r = parameters[k].size();
     std::vector<double> interp_vals(nbins_r, 0.);
 
     size_t idx = 0;
     size_t size = xDistances.size();
     if (x >= xDistances[size - 2])
       idx = size - 2;
     else {
       while (x > xDistances[idx + 1])
         idx++;
     }
     for (size_t i = 0; i < nbins_r; ++i) {
       interp_vals[i] = interpolate(xDistances, parameters[k][i], x, false, idx);
     }
 
     // interpolate in r
     double border_correction = interpolate(rDistances, interp_vals, r, false);
     return border_correction;
   }

void phot::interpolate3	(	std::array< double, 3 > &	inter,
		const std::vector< double > &	xData,
		const std::vector< double > &	yData1,
		const std::vector< double > &	yData2,
		const std::vector< double > &	yData3,
		const double	x,
		const bool	extrapolate
	)

Definition at line 106 of file PhotonPropagationUtils.cxx.

References util::size().

Referenced by phot::PropagationTimeModel::generateVUVParams().

   {
     size_t size = xData.size();
     size_t i = 0;               // find left end of interval for interpolation
     if (x >= xData[size - 2]) { // special case: beyond right end
       i = size - 2;
     }
     else {
       while (x > xData[i + 1])
         i++;
     }
     double xL = xData[i];
     double xR = xData[i + 1]; // points on either side (unless beyond ends)
     double yL1 = yData1[i];
     double yR1 = yData1[i + 1];
     double yL2 = yData2[i];
     double yR2 = yData2[i + 1];
     double yL3 = yData3[i];
     double yR3 = yData3[i + 1];
 
     if (!extrapolate) { // if beyond ends of array and not extrapolating
       if (x < xL) {
         inter[0] = yL1;
         inter[1] = yL2;
         inter[2] = yL3;
         return;
       }
       if (x > xR) {
         inter[0] = yL1;
         inter[1] = yL2;
         inter[2] = yL3;
         return;
       }
     }
     const double m = (x - xL) / (xR - xL);
     inter[0] = m * (yR1 - yL1) + yL1;
     inter[1] = m * (yR2 - yL2) + yL2;
     inter[2] = m * (yR3 - yL3) + yL3;
   }

template<typename TReal >

static constexpr bool phot::isApproximatelyEqual	(	TReal	a,
		TReal	b,
		TReal	tolerance = `std::numeric_limits<TReal>::epsilon()`
	)

inlinestatic

Definition at line 38 of file PhotonPropagationUtils.h.

Referenced by phot::SemiAnalyticalModel::Disk_SolidAngle().

   {
     TReal diff = std::fabs(a - b);
     if (diff <= tolerance) return true;
     if (diff < std::fmax(std::fabs(a), std::fabs(b)) * tolerance) return true;
     return false;
   }

template<typename TReal >

static constexpr bool phot::isApproximatelyZero	(	TReal	a,
		TReal	tolerance = `std::numeric_limits<TReal>::epsilon()`
	)

inlinestatic

Definition at line 50 of file PhotonPropagationUtils.h.

Referenced by phot::SemiAnalyticalModel::Disk_SolidAngle(), and phot::SemiAnalyticalModel::Rectangle_SolidAngle().

   {
     if (std::fabs(a) <= tolerance) return true;
     return false;
   }

template<typename TReal >

static constexpr bool phot::isDefinitelyGreaterThan	(	TReal	a,
		TReal	b,
		TReal	tolerance = `std::numeric_limits<TReal>::epsilon()`
	)

inlinestatic

Definition at line 72 of file PhotonPropagationUtils.h.

Referenced by phot::SemiAnalyticalModel::Disk_SolidAngle(), and phot::SemiAnalyticalModel::Rectangle_SolidAngle().

   {
     TReal diff = a - b;
     if (diff > tolerance) return true;
     if (diff > std::fmax(std::fabs(a), std::fabs(b)) * tolerance) return true;
     return false;
   }

template<typename TReal >

static constexpr bool phot::isDefinitelyLessThan	(	TReal	a,
		TReal	b,
		TReal	tolerance = `std::numeric_limits<TReal>::epsilon()`
	)

inlinestatic

Definition at line 62 of file PhotonPropagationUtils.h.

Referenced by phot::SemiAnalyticalModel::Disk_SolidAngle().

   {
     TReal diff = a - b;
     if (diff < tolerance) return true;
     if (diff < std::fmax(std::fabs(a), std::fabs(b)) * tolerance) return true;
     return false;
   }

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 344 of file OpDetVisibilityData.h.

References phot::OpDetVisibilityData< Cont, Mapping >::isValid().

Referenced by phot::OpDetVisibilityData< Cont, Mapping >::effectiveSize().

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

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation