#include "DetectorPropertiesStandard.h"

Inheritance diagram for detinfo::DetectorPropertiesStandard:

Classes
struct	Configuration_t
	Structure for configuration parameters. More...

struct	SternheimerParameters_t
	Parameters for Sternheimer density effect corrections. More...

Public Types
using	providers_type = lar::ProviderPack< geo::GeometryCore, detinfo::LArProperties >
	List of service providers we depend on. More...

Public Member Functions
	DetectorPropertiesStandard (fhicl::ParameterSet const &pset, const geo::GeometryCore geo, const detinfo::LArProperties lp, std::set< std::string > const &ignore_params={})

	DetectorPropertiesStandard (DetectorPropertiesStandard const &)=delete

virtual	~DetectorPropertiesStandard ()=default

void	SetNumberTimeSamples (unsigned int nsamp)

double	Efield (unsigned int planegap=0) const override
	kV/cm More...

double	DriftVelocity (double efield=0., double temperature=0.) const override
	cm/us More...

double	BirksCorrection (double dQdX) const override
	dQ/dX in electrons/cm, returns dE/dX in MeV/cm. More...

double	BirksCorrection (double dQdX, double EField) const override

double	ModBoxCorrection (double dQdX) const override

double	ModBoxCorrection (double dQdX, double EField) const override

double	ElectronLifetime () const override
	Returns the attenuation constant for ionization electrons. More...

double	Density (double temperature=0.) const override
	Returns argon density at a given temperature. More...

double	Temperature () const override
	In kelvin. More...

double	Eloss (double mom, double mass, double tcut) const override
	Restricted mean energy loss (dE/dx) More...

double	ElossVar (double mom, double mass) const override
	Energy loss fluctuation ( $\sigma_{E}^2 / x$ ) More...

double	ElectronsToADC () const override

unsigned int	NumberTimeSamples () const override

unsigned int	ReadOutWindowSize () const override

double	TimeOffsetU () const override

double	TimeOffsetV () const override

double	TimeOffsetZ () const override

double	TimeOffsetY () const override

bool	SimpleBoundary () const override

DetectorPropertiesData	DataFor (detinfo::DetectorClocksData const &clock_data) const override

virtual double	Density () const
	Returns argon density at the temperature from Temperature() More...

Private Member Functions
void	ValidateAndConfigure (fhicl::ParameterSet const &p, std::set< std::string > const &ignore_params)
	Configures the provider, first validating the configuration. More...

std::string	CheckTimeOffsets (std::set< geo::View_t > const &requested_views) const

Private Attributes
const detinfo::LArProperties *	fLP

const geo::GeometryCore *	fGeo

std::vector< double >	fEfield
	kV/cm (per inter-plane volume) ! More...

double	fElectronlifetime
	microseconds More...

double	fTemperature
	kelvin More...

double	fElectronsToADC

unsigned int	fNumberTimeSamples
	number of clock ticks per event More...

unsigned int	fReadOutWindowSize
	number of clock ticks per readout window More...

double	fTimeOffsetU

double	fTimeOffsetV

double	fTimeOffsetZ

double	fTimeOffsetY

double	fTimeOffsetX

double	fDriftVelFudgeFactor

bool	fUseIcarusMicrobooneDriftModel

bool	fIncludeInterPlanePitchInXTickOffsets

SternheimerParameters_t	fSternheimerParameters
	Sternheimer parameters. More...

std::vector< std::vector< double > >	fDriftDirection

bool	fSimpleBoundary

double	fModBoxA

double	fModBoxB

Detailed Description

Definition at line 36 of file DetectorPropertiesStandard.h.

Member Typedef Documentation

using detinfo::DetectorPropertiesStandard::providers_type = lar::ProviderPack<geo::GeometryCore, detinfo::LArProperties>

List of service providers we depend on.

Definition at line 39 of file DetectorPropertiesStandard.h.

Constructor & Destructor Documentation

detinfo::DetectorPropertiesStandard::DetectorPropertiesStandard	(	fhicl::ParameterSet const &	pset,
		const geo::GeometryCore *	geo,
		const detinfo::LArProperties *	lp,
		std::set< std::string > const &	ignore_params = `{}`
	)

Definition at line 29 of file DetectorPropertiesStandard.cxx.

References ValidateAndConfigure().

     : fLP(lp), fGeo(geo)
   {
     ValidateAndConfigure(pset, ignore_params);
   }

detinfo::DetectorPropertiesStandard::DetectorPropertiesStandard ( DetectorPropertiesStandard const & )

delete

virtual detinfo::DetectorPropertiesStandard::~DetectorPropertiesStandard ( )

virtualdefault

Member Function Documentation

double detinfo::DetectorPropertiesStandard::BirksCorrection ( double dQdX ) const

overridevirtual

dQ/dX in electrons/cm, returns dE/dX in MeV/cm.

Implements detinfo::DetectorProperties.

Definition at line 298 of file DetectorPropertiesStandard.cxx.

References Efield().

Referenced by SetNumberTimeSamples().

   {
     return BirksCorrection(dQdx, Efield());
   }

double detinfo::DetectorPropertiesStandard::BirksCorrection	(	double	dQdX,
		double	EField
	)		const

overridevirtual

Implements detinfo::DetectorProperties.

Definition at line 302 of file DetectorPropertiesStandard.cxx.

References tca::dEdx(), detinfo::DetectorProperties::Density(), util::kGeVToElectrons, util::kRecombA, and util::kRecombk.

   {
     // Correction for charge quenching using parameterization from
     // S.Amoruso et al., NIM A 523 (2004) 275
 
     constexpr double A3t = util::kRecombA;
     double K3t = util::kRecombk;                                    // in KV/cm*(g/cm^2)/MeV
     double const rho = Density();                                   // LAr density in g/cm^3
     constexpr double Wion = 1000. / util::kGeVToElectrons;          // 23.6 eV = 1e, Wion in MeV/e
     K3t /= rho;                                                     // KV/MeV
     double const dEdx = dQdx / (A3t / Wion - K3t / E_field * dQdx); // MeV/cm
 
     return dEdx;
   }

std::string detinfo::DetectorPropertiesStandard::CheckTimeOffsets ( std::set< geo::View_t > const & requested_views ) const

private

Definition at line 458 of file DetectorPropertiesStandard.cxx.

References fGeo, geo::kU, geo::kV, geo::kX, geo::kY, geo::kZ, and geo::GeometryCore::Views().

Referenced by SimpleBoundary(), and ValidateAndConfigure().

   {
     auto const& present_views = fGeo->Views();
 
     auto view_diff = [&present_views, &requested_views](geo::View_t const view) {
       return static_cast<int>(present_views.count(view)) -
              static_cast<int>(requested_views.count(view));
     };
 
     // It is not an error to specify an offset if the view does not
     // exist.  However, if a view does exist, and an offset does not,
     // then that will end the job.
     std::ostringstream errors;
     if (auto diff = view_diff(geo::kU); diff > 0) { errors << "TimeOffsetU missing for view U.\n"; }
     if (auto diff = view_diff(geo::kV); diff > 0) { errors << "TimeOffsetV missing for view V.\n"; }
     if (auto diff = view_diff(geo::kZ); diff > 0) { errors << "TimeOffsetZ missing for view Z.\n"; }
     if (auto diff = view_diff(geo::kY); diff > 0) { errors << "TimeOffsetY missing for view Y.\n"; }
     if (auto diff = view_diff(geo::kX); diff > 0) { errors << "TimeOffsetX missing for view X.\n"; }
     return errors.str();
   }

DetectorPropertiesData detinfo::DetectorPropertiesStandard::DataFor ( detinfo::DetectorClocksData const & clock_data ) const

overridevirtual

< special case for ArgoNeuT

Implements detinfo::DetectorProperties.

Definition at line 346 of file DetectorPropertiesStandard.cxx.

References geo::GeometryCore::Cryostat(), dir, geo::TPCGeo::DriftDirection(), DriftVelocity(), Efield(), fGeo, fIncludeInterPlanePitchInXTickOffsets, fTimeOffsetU, fTimeOffsetV, fTimeOffsetX, fTimeOffsetY, fTimeOffsetZ, geo::PlaneGeo::GetCenter(), geo::kNegX, geo::kU, geo::kV, geo::kX, geo::kY, geo::kZ, geo::GeometryCore::Ncryostats(), geo::TPCGeo::Nplanes(), geo::TPCGeo::Plane(), geo::TPCGeo::PlanePitch(), detinfo::sampling_rate(), Temperature(), detinfo::trigger_offset(), and geo::PlaneGeo::View().

Referenced by detinfo::DetectorPropertiesServiceStandard::getDataFor(), detinfo::DetectorPropertiesServiceStandard::getDataForJob(), and SimpleBoundary().

   {
     double const samplingRate = sampling_rate(clock_data);
     double const efield = Efield();
     double const temperature = Temperature();
     double const driftVelocity = DriftVelocity(efield, temperature);
     double const x_ticks_coefficient = 0.001 * driftVelocity * samplingRate;
 
     double const triggerOffset = trigger_offset(clock_data);
 
     std::vector<std::vector<std::vector<double>>> x_ticks_offsets(fGeo->Ncryostats());
     std::vector<std::vector<double>> drift_direction(fGeo->Ncryostats());
 
     for (size_t cstat = 0; cstat < fGeo->Ncryostats(); ++cstat) {
       auto const& cryostat = fGeo->Cryostat(geo::CryostatID(cstat));
       x_ticks_offsets[cstat].resize(cryostat.NTPC());
       drift_direction[cstat].resize(cryostat.NTPC());
 
       for (size_t tpc = 0; tpc < cryostat.NTPC(); ++tpc) {
         const geo::TPCGeo& tpcgeom = cryostat.TPC(tpc);
 
         const double dir((tpcgeom.DriftDirection() == geo::kNegX) ? +1.0 : -1.0);
         drift_direction[cstat][tpc] = dir;
 
         int nplane = tpcgeom.Nplanes();
         x_ticks_offsets[cstat][tpc].resize(nplane, 0.);
         for (int plane = 0; plane < nplane; ++plane) {
           const geo::PlaneGeo& pgeom = tpcgeom.Plane(plane);
 
           //Choose which plane to propagate to
           //If accounting for the drift time between planes, start with the first plane,
           //and iteratively add distances between planes
           //Otherwise propagate straight to the last plane and
           //assume a standard drift velocity (for wirecell recob::Wires)
           unsigned int planeToPropagateTo =
             (fIncludeInterPlanePitchInXTickOffsets ? 0 : tpcgeom.Nplanes() - 1);
           // Calculate geometric time offset.
           // only works if xyz[0]<=0
           auto const xyz = tpcgeom.Plane(planeToPropagateTo).GetCenter();
 
           x_ticks_offsets[cstat][tpc][plane] =
             -xyz.X() / (dir * x_ticks_coefficient) + triggerOffset;
 
           if (fIncludeInterPlanePitchInXTickOffsets) {
             // Get field in gap between planes
             double efieldgap[3];
             double driftVelocitygap[3];
             double x_ticks_coefficient_gap[3];
             for (int igap = 0; igap < 3; ++igap) {
               efieldgap[igap] = Efield(igap);
               driftVelocitygap[igap] = DriftVelocity(efieldgap[igap], temperature);
               x_ticks_coefficient_gap[igap] = 0.001 * driftVelocitygap[igap] * samplingRate;
             }
 
             if (nplane == 3) {
               /*
                 |    ---------- plane = 2 (collection)
                 |                      Coeff[2]
                 |    ---------- plane = 1 (2nd induction)
                 |                      Coeff[1]
                 |    ---------- plane = 0 (1st induction) x = xyz[0]
                 |                      Coeff[0]
                 |    ---------- x = 0
                 V     For plane = 0, t offset is -xyz[0]/Coeff[0]
                 x   */
               for (int ip = 0; ip < plane; ++ip) {
                 x_ticks_offsets[cstat][tpc][plane] +=
                   tpcgeom.PlanePitch(ip, ip + 1) / x_ticks_coefficient_gap[ip + 1];
               }
             }
             else if (nplane == 2) { 
               /*
                 |    ---------- plane = 1 (collection)
                 |                      Coeff[2]
                 |    ---------- plane = 0 (2nd induction) x = xyz[0]
                 |    ---------- x = 0, Coeff[1]
                 V    ---------- first induction plane
                 x                      Coeff[0]
                 For plane = 0, t offset is pitch/Coeff[1] -
                 (pitch+xyz[0])/Coeff[0] = -xyz[0]/Coeff[0] -
                 pitch*(1/Coeff[0]-1/Coeff[1])
               */
               for (int ip = 0; ip < plane; ++ip) {
                 x_ticks_offsets[cstat][tpc][plane] +=
                   tpcgeom.PlanePitch(ip, ip + 1) / x_ticks_coefficient_gap[ip + 2];
               }
               x_ticks_offsets[cstat][tpc][plane] -=
                 tpcgeom.PlanePitch() * (1 / x_ticks_coefficient - 1 / x_ticks_coefficient_gap[1]);
             }
 
           } // end if fIncludeInterPlanePitchInXTickOffsets
 
           // Add view dependent offset
           // FIXME the offset should be plane-dependent
           geo::View_t view = pgeom.View();
           switch (view) {
           case geo::kU: x_ticks_offsets[cstat][tpc][plane] += fTimeOffsetU; break;
           case geo::kV: x_ticks_offsets[cstat][tpc][plane] += fTimeOffsetV; break;
           case geo::kZ: x_ticks_offsets[cstat][tpc][plane] += fTimeOffsetZ; break;
           case geo::kY: x_ticks_offsets[cstat][tpc][plane] += fTimeOffsetY; break;
           case geo::kX: x_ticks_offsets[cstat][tpc][plane] += fTimeOffsetX; break;
           default: throw cet::exception(__FUNCTION__) << "Bad view = " << view << "\n";
           } // switch
         }
       }
     }
 
     return DetectorPropertiesData{
       *this, x_ticks_coefficient, move(x_ticks_offsets), move(drift_direction)};
   }

virtual double detinfo::DetectorProperties::Density ( ) const

inlinevirtualinherited

Returns argon density at the temperature from Temperature()

Definition at line 98 of file DetectorProperties.h.

References detinfo::DetectorProperties::Density(), detinfo::DetectorProperties::ElectronsToADC(), detinfo::DetectorProperties::NumberTimeSamples(), detinfo::DetectorProperties::ReadOutWindowSize(), detinfo::DetectorProperties::Temperature(), detinfo::DetectorProperties::TimeOffsetU(), detinfo::DetectorProperties::TimeOffsetV(), and detinfo::DetectorProperties::TimeOffsetZ().

Referenced by BirksCorrection(), detinfo::DetectorProperties::Density(), ElectronLifetime(), Eloss(), ElossVar(), and ModBoxCorrection().

98 { return Density(Temperature()); }

detinfo::DetectorProperties::Density

virtual double Density() const

Returns argon density at the temperature from Temperature()

Definition: DetectorProperties.h:98

detinfo::DetectorProperties::Temperature

virtual double Temperature() const =0

double detinfo::DetectorPropertiesStandard::Density ( double temperature = 0. ) const

overridevirtual

Returns argon density at a given temperature.

Parameters

temperature the temperature in kelvin

Returns: argon density in g/cm^3

Density is nearly a linear function of temperature. See the NIST tables for details Slope is between -6.2 and -6.1, intercept is 1928 kg/m^3. This parameterization will be good to better than 0.5%.g/cm^3

Implements detinfo::DetectorProperties.

Definition at line 105 of file DetectorPropertiesStandard.cxx.

References Temperature().

   {
     // Default temperature use internal value.
     if (temperature == 0.) temperature = Temperature();
 
     return -0.00615 * temperature + 1.928;
   }

double detinfo::DetectorPropertiesStandard::DriftVelocity	(	double	efield = `0.`,
		double	temperature = `0.`
	)		const

overridevirtual

cm/us

Implements detinfo::DetectorProperties.

Definition at line 185 of file DetectorPropertiesStandard.cxx.

References Efield(), fDriftVelFudgeFactor, fUseIcarusMicrobooneDriftModel, and Temperature().

Referenced by DataFor(), and SetNumberTimeSamples().

   {
     // Drift Velocity as a function of Electric Field and LAr Temperature
     // from : W. Walkowiak, NIM A 449 (2000) 288-294
     //
     // Option to use MicroBooNE+ICARUS model (as in arXiv:2008.09765) provided as
     // well, with temperature depenence as prescribed by Mike Mooney based on
     // looking at the Walkowiak data.
     //
     // Efield should have units of kV/cm
     // Temperature should have units of Kelvin
 
     // Default Efield, use internal value.
     if (efield == 0.) efield = Efield();
 
     if (efield > 4.0)
       mf::LogWarning("DetectorPropertiesStandard")
         << "DriftVelocity Warning! : E-field value of " << efield
         << " kV/cm is outside of range covered by drift"
         << " velocity parameterization. Returned value"
         << " may not be correct";
 
     // Default temperature use internal value.
     if (temperature == 0.) temperature = Temperature();
 
     if (temperature < 87.0 || temperature > 94.0)
       mf::LogWarning("DetectorPropertiesStandard")
         << "DriftVelocity Warning! : Temperature value of " << temperature
         << " K is outside of range covered by drift velocity"
         << " parameterization. Returned value may not be"
         << " correct";
 
     double vd;
 
     if (!fUseIcarusMicrobooneDriftModel) {
       double const tshift = -87.203 + temperature;
       double const xFit = 0.0938163 - 0.0052563 * tshift - 0.0001470 * tshift * tshift;
       double const uFit = 5.18406 + 0.01448 * tshift - 0.003497 * tshift * tshift -
                           0.000516 * tshift * tshift * tshift;
 
       // Icarus Parameter Set, use as default
       constexpr double P1 = -0.04640; // K^-1
       constexpr double P2 = 0.01712;  // K^-1
       constexpr double P3 = 1.88125;  // (kV/cm)^-1
       constexpr double P4 = 0.99408;  // kV/cm
       constexpr double P5 = 0.01172;  // (kV/cm)^-P6
       constexpr double P6 = 4.20214;
       constexpr double T0 = 105.749; // K
 
       // Walkowiak Parameter Set
       constexpr double P1W = -0.01481; // K^-1
       constexpr double P2W = -0.0075;  // K^-1
       constexpr double P3W = 0.141;    // (kV/cm)^-1
       constexpr double P4W = 12.4;     // kV/cm
       constexpr double P5W = 1.627;    // (kV/cm)^-P6
       constexpr double P6W = 0.317;
       constexpr double T0W = 90.371; // K
 
       // From Craig Thorne . . . currently not documented
       // smooth transition from linear at small fields to
       //     icarus fit at most fields to Walkowiak at very high fields
       if (efield < xFit)
         vd = efield * uFit;
       else if (efield < 0.619) {
         vd = ((P1 * (temperature - T0) + 1) *
                 (P3 * efield * std::log(1 + P4 / efield) + P5 * std::pow(efield, P6)) +
               P2 * (temperature - T0));
       }
       else if (efield < 0.699) {
         vd = 12.5 * (efield - 0.619) *
                ((P1W * (temperature - T0W) + 1) *
                   (P3W * efield * std::log(1 + P4W / efield) + P5W * std::pow(efield, P6W)) +
                 P2W * (temperature - T0W)) +
              12.5 * (0.699 - efield) *
                ((P1 * (temperature - T0) + 1) *
                   (P3 * efield * std::log(1 + P4 / efield) + P5 * std::pow(efield, P6)) +
                 P2 * (temperature - T0));
       }
       else {
         vd = ((P1W * (temperature - T0W) + 1) *
                 (P3W * efield * std::log(1 + P4W / efield) + P5W * std::pow(efield, P6W)) +
               P2W * (temperature - T0W));
       }
     }
 
     // MicroBooNE+ICARUS model (arXiv:2008.09765) with temperature dependence given by
     // Mike Mooney based on looking at Walkowiak data (NIM A 449 (2000) 288-294)
     if (fUseIcarusMicrobooneDriftModel) {
       constexpr double P0 = 0.;
       constexpr double P1 = 5.53416;
       constexpr double P2 = -6.53093;
       constexpr double P3 = 3.20752;
       constexpr double P4 = 0.389696;
       constexpr double P5 = -0.556184;
       vd = (1.0 - 0.0184 * (temperature - 89.0)) *
            (P0 + P1 * cet::pow<1>(efield) + P2 * cet::pow<2>(efield) + P3 * cet::pow<3>(efield) +
             P4 * cet::pow<4>(efield) + P5 * cet::pow<5>(efield));
     }
 
     vd *= fDriftVelFudgeFactor / 10.;
 
     return vd; // in cm/us
   }

double detinfo::DetectorPropertiesStandard::Efield ( unsigned int planegap = 0 ) const

overridevirtual

kV/cm

Implements detinfo::DetectorProperties.

Definition at line 95 of file DetectorPropertiesStandard.cxx.

References fEfield.

Referenced by BirksCorrection(), DataFor(), DriftVelocity(), and ModBoxCorrection().

   {
     if (planegap >= fEfield.size())
       throw cet::exception("DetectorPropertiesStandard")
         << "requesting Electric field in a plane gap that is not defined\n";
 
     return fEfield[planegap];
   }

double detinfo::DetectorPropertiesStandard::ElectronLifetime ( ) const

inlineoverridevirtual

Returns the attenuation constant for ionization electrons.

Returns: the attenuation constant [µs]

The returned constant τ can be used to know the attenuation the ionization charge undergoes after drifting for a certain time t: $A(t) = e^{-t/\tau}$ (t is measured in microseconds).

This is a uniform, constant value for the detector.

Implements detinfo::DetectorProperties.

Definition at line 166 of file DetectorPropertiesStandard.h.

References detinfo::DetectorProperties::Density(), and fElectronlifetime.

     {
       return fElectronlifetime; //< microseconds
     }

double detinfo::DetectorPropertiesStandard::ElectronsToADC ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 212 of file DetectorPropertiesStandard.h.

References fElectronsToADC.

212 { return fElectronsToADC; }

detinfo::DetectorPropertiesStandard::fElectronsToADC

double fElectronsToADC

Definition: DetectorPropertiesStandard.h:256

double detinfo::DetectorPropertiesStandard::Eloss	(	double	mom,
		double	mass,
		double	tcut
	)		const

overridevirtual

Restricted mean energy loss (dE/dx)

Parameters

mom	momentum of incident particle [GeV/c]
mass	mass of incident particle [GeV/c^2]
tcut	maximum kinetic energy of delta rays [MeV]; 0 for unlimited

Returns: the restricted mean energy loss (dE/dx) in units of MeV/cm

Returned value is always positive. For unrestricted mean energy loss, set tcut = 0 (special case), or tcut large.

Based on Bethe-Bloch formula as contained in particle data book. Material parameters are from the configuration.

Implements detinfo::DetectorProperties.

Definition at line 130 of file DetectorPropertiesStandard.cxx.

References detinfo::DetectorPropertiesStandard::SternheimerParameters_t::a, detinfo::LArProperties::AtomicMass(), detinfo::LArProperties::AtomicNumber(), detinfo::DetectorPropertiesStandard::SternheimerParameters_t::cbar, detinfo::DetectorProperties::Density(), e, detinfo::LArProperties::ExcitationEnergy(), fLP, fSternheimerParameters, detinfo::DetectorPropertiesStandard::SternheimerParameters_t::k, x, detinfo::DetectorPropertiesStandard::SternheimerParameters_t::x0, and detinfo::DetectorPropertiesStandard::SternheimerParameters_t::x1.

Referenced by Temperature().

   {
     // Some constants.
     constexpr double K = 0.307075;     // 4 pi N_A r_e^2 m_e c^2 (MeV cm^2/mol).
     constexpr double me = 0.510998918; // Electron mass (MeV/c^2).
 
     // Calculate kinematic quantities.
     double const bg = mom / mass;            // beta*gamma.
     double const gamma = sqrt(1. + bg * bg); // gamma.
     double const beta = bg / gamma;          // beta (velocity).
     double const mer = 0.001 * me / mass;    // electron mass / mass of incident particle.
     double const tmax =
       2. * me * bg * bg / (1. + 2. * gamma * mer + mer * mer); // Maximum delta ray energy (MeV).
 
     // Make sure tcut does not exceed tmax.
     if (tcut == 0. || tcut > tmax) tcut = tmax;
 
     // Calculate density effect correction (delta).
     double const x = std::log10(bg);
     double delta = 0.;
     if (x >= fSternheimerParameters.x0) {
       delta = 2. * std::log(10.) * x - fSternheimerParameters.cbar;
       if (x < fSternheimerParameters.x1)
         delta += fSternheimerParameters.a *
                  std::pow(fSternheimerParameters.x1 - x, fSternheimerParameters.k);
     }
 
     // Calculate stopping number.
     double B =
       0.5 * std::log(2. * me * bg * bg * tcut / (1.e-12 * cet::square(fLP->ExcitationEnergy()))) -
       0.5 * beta * beta * (1. + tcut / tmax) - 0.5 * delta;
 
     // Don't let the stopping number become negative.
     if (B < 1.) B = 1.;
 
     // Calculate dE/dx.
     return Density() * K * fLP->AtomicNumber() * B / (fLP->AtomicMass() * beta * beta);
   }

double detinfo::DetectorPropertiesStandard::ElossVar	(	double	mom,
		double	mass
	)		const

overridevirtual

Energy loss fluctuation ( $\sigma_{E}^2 / x$ )

Parameters

mom	momentum of incident particle in [GeV/c]
mass	mass of incident particle [GeV/c^2]

Returns: energy loss fluctuation in MeV^2/cm

Based on Bichsel formula referred to but not given in PDG.

Implements detinfo::DetectorProperties.

Definition at line 170 of file DetectorPropertiesStandard.cxx.

References detinfo::LArProperties::AtomicMass(), detinfo::LArProperties::AtomicNumber(), detinfo::DetectorProperties::Density(), and fLP.

Referenced by Temperature().

   {
     // Some constants.
     constexpr double K = 0.307075;     // 4 pi N_A r_e^2 m_e c^2 (MeV cm^2/mol).
     constexpr double me = 0.510998918; // Electron mass (MeV/c^2).
 
     // Calculate kinematic quantities.
     double const bg = mom / mass;          // beta*gamma.
     double const gamma2 = 1. + bg * bg;    // gamma^2.
     double const beta2 = bg * bg / gamma2; // beta^2.
     return gamma2 * (1. - 0.5 * beta2) * me * (fLP->AtomicNumber() / fLP->AtomicMass()) * K *
            Density();
   }

double detinfo::DetectorPropertiesStandard::ModBoxCorrection ( double dQdX ) const

overridevirtual

Implements detinfo::DetectorProperties.

Definition at line 319 of file DetectorPropertiesStandard.cxx.

References Efield().

Referenced by SetNumberTimeSamples().

   {
     return ModBoxCorrection(dQdx, Efield());
   }

double detinfo::DetectorPropertiesStandard::ModBoxCorrection	(	double	dQdX,
		double	EField
	)		const

overridevirtual

Implements detinfo::DetectorProperties.

Definition at line 323 of file DetectorPropertiesStandard.cxx.

References tca::dEdx(), detinfo::DetectorProperties::Density(), fModBoxA, fModBoxB, and util::kGeVToElectrons.

   {
     // Modified Box model correction has better behavior than the Birks
     // correction at high values of dQ/dx.
     double const rho = Density();                          // LAr density in g/cm^3
     constexpr double Wion = 1000. / util::kGeVToElectrons; // 23.6 eV = 1e, Wion in MeV/e
     double const Beta = fModBoxB / (rho * E_field);
     double const Alpha = fModBoxA;
     double const dEdx = (exp(Beta * Wion * dQdx) - Alpha) / Beta;
 
     return dEdx;
   }

unsigned int detinfo::DetectorPropertiesStandard::NumberTimeSamples ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 213 of file DetectorPropertiesStandard.h.

References fNumberTimeSamples.

Referenced by detinfo::DetectorPropertiesServiceStandard::postOpenFile().

213 { return fNumberTimeSamples; }

detinfo::DetectorPropertiesStandard::fNumberTimeSamples

unsigned int fNumberTimeSamples

number of clock ticks per event

Definition: DetectorPropertiesStandard.h:258

unsigned int detinfo::DetectorPropertiesStandard::ReadOutWindowSize ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 214 of file DetectorPropertiesStandard.h.

References fReadOutWindowSize.

214 { return fReadOutWindowSize; }

detinfo::DetectorPropertiesStandard::fReadOutWindowSize

unsigned int fReadOutWindowSize

number of clock ticks per readout window

Definition: DetectorPropertiesStandard.h:259

void detinfo::DetectorPropertiesStandard::SetNumberTimeSamples ( unsigned int nsamp )

inline

Definition at line 151 of file DetectorPropertiesStandard.h.

References BirksCorrection(), DriftVelocity(), detinfo::DetectorPropertiesStandard::Configuration_t::Efield, fNumberTimeSamples, and ModBoxCorrection().

Referenced by detinfo::DetectorPropertiesServiceStandard::postOpenFile().

151 { fNumberTimeSamples = nsamp; }

detinfo::DetectorPropertiesStandard::fNumberTimeSamples

unsigned int fNumberTimeSamples

number of clock ticks per event

Definition: DetectorPropertiesStandard.h:258

bool detinfo::DetectorPropertiesStandard::SimpleBoundary ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 220 of file DetectorPropertiesStandard.h.

References CheckTimeOffsets(), DataFor(), fSimpleBoundary, and ValidateAndConfigure().

220 { return fSimpleBoundary; }

detinfo::DetectorPropertiesStandard::fSimpleBoundary

bool fSimpleBoundary

Definition: DetectorPropertiesStandard.h:286

double detinfo::DetectorPropertiesStandard::Temperature ( ) const

inlineoverridevirtual

In kelvin.

Implements detinfo::DetectorProperties.

Definition at line 184 of file DetectorPropertiesStandard.h.

References Eloss(), ElossVar(), and fTemperature.

Referenced by DataFor(), Density(), and DriftVelocity().

184 { return fTemperature; }

detinfo::DetectorPropertiesStandard::fTemperature

double fTemperature

kelvin

Definition: DetectorPropertiesStandard.h:255

double detinfo::DetectorPropertiesStandard::TimeOffsetU ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 215 of file DetectorPropertiesStandard.h.

References fTimeOffsetU.

Referenced by ValidateAndConfigure().

215 { return fTimeOffsetU; };

detinfo::DetectorPropertiesStandard::fTimeOffsetU

double fTimeOffsetU

Definition: DetectorPropertiesStandard.h:260

double detinfo::DetectorPropertiesStandard::TimeOffsetV ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 216 of file DetectorPropertiesStandard.h.

References fTimeOffsetV.

Referenced by ValidateAndConfigure().

216 { return fTimeOffsetV; };

detinfo::DetectorPropertiesStandard::fTimeOffsetV

double fTimeOffsetV

Definition: DetectorPropertiesStandard.h:262

double detinfo::DetectorPropertiesStandard::TimeOffsetY ( ) const

inlineoverridevirtual

Reimplemented from detinfo::DetectorProperties.

Definition at line 218 of file DetectorPropertiesStandard.h.

References fTimeOffsetY.

Referenced by ValidateAndConfigure().

218 { return fTimeOffsetY; };

detinfo::DetectorPropertiesStandard::fTimeOffsetY

double fTimeOffsetY

Definition: DetectorPropertiesStandard.h:266

double detinfo::DetectorPropertiesStandard::TimeOffsetZ ( ) const

inlineoverridevirtual

Implements detinfo::DetectorProperties.

Definition at line 217 of file DetectorPropertiesStandard.h.

References fTimeOffsetZ.

Referenced by ValidateAndConfigure().

217 { return fTimeOffsetZ; };

detinfo::DetectorPropertiesStandard::fTimeOffsetZ

double fTimeOffsetZ

Definition: DetectorPropertiesStandard.h:264

void detinfo::DetectorPropertiesStandard::ValidateAndConfigure	(	fhicl::ParameterSet const &	p,
		std::set< std::string > const &	ignore_params
	)

private

Configures the provider, first validating the configuration.

Parameters

p	configuration parameter set
ignore_params	parameters to be ignored (optional)

This method will validate the parameter set (except for the parameters it's explicitly told to ignore) and extract the useful information out of it.

Definition at line 39 of file DetectorPropertiesStandard.cxx.

References detinfo::DetectorPropertiesStandard::SternheimerParameters_t::a, detinfo::DetectorPropertiesStandard::SternheimerParameters_t::cbar, CheckTimeOffsets(), tca::debug, fDriftVelFudgeFactor, fEfield, fElectronlifetime, fElectronsToADC, fIncludeInterPlanePitchInXTickOffsets, fModBoxA, fModBoxB, fNumberTimeSamples, fReadOutWindowSize, fSimpleBoundary, fSternheimerParameters, fTemperature, fTimeOffsetU, fTimeOffsetV, fTimeOffsetX, fTimeOffsetY, fTimeOffsetZ, fUseIcarusMicrobooneDriftModel, lar::IgnorableProviderConfigKeys(), detinfo::DetectorPropertiesStandard::SternheimerParameters_t::k, geo::kU, geo::kV, geo::kX, geo::kY, geo::kZ, TimeOffsetU(), TimeOffsetV(), TimeOffsetY(), TimeOffsetZ(), detinfo::DetectorPropertiesStandard::SternheimerParameters_t::x0, and detinfo::DetectorPropertiesStandard::SternheimerParameters_t::x1.

Referenced by DetectorPropertiesStandard(), and SimpleBoundary().

   {
     {
       mf::LogInfo debug("setupProvider<DetectorPropertiesStandard>");
 
       debug << "Asked to ignore " << ignore_params.size() << " keys:";
       for (auto const& key : ignore_params)
         debug << " '" << key << "'";
     }
 
     std::set<std::string> ignorable_keys = lar::IgnorableProviderConfigKeys();
     ignorable_keys.insert(ignore_params.begin(), ignore_params.end());
 
     // parses and validates the parameter set:
     fhicl::Table<Configuration_t> const config{p, ignorable_keys};
 
     fEfield = config().Efield();
     fElectronlifetime = config().Electronlifetime();
     fTemperature = config().Temperature();
     fElectronsToADC = config().ElectronsToADC();
     fNumberTimeSamples = config().NumberTimeSamples();
     fReadOutWindowSize = config().ReadOutWindowSize();
 
     std::set<geo::View_t> present_views;
     if (config().TimeOffsetU(fTimeOffsetU)) present_views.insert(geo::kU);
     if (config().TimeOffsetV(fTimeOffsetV)) present_views.insert(geo::kV);
     if (config().TimeOffsetZ(fTimeOffsetZ)) present_views.insert(geo::kZ);
     if (config().TimeOffsetY(fTimeOffsetY)) present_views.insert(geo::kY);
     if (config().TimeOffsetX(fTimeOffsetX)) present_views.insert(geo::kX);
 
     std::string const errors = CheckTimeOffsets(present_views);
     if (!errors.empty()) {
       throw cet::exception("DetectorPropertiesStandard") << "Detected configuration errors: \n"
                                                          << errors;
     }
 
     fSternheimerParameters.a = config().SternheimerA();
     fSternheimerParameters.k = config().SternheimerK();
     fSternheimerParameters.x0 = config().SternheimerX0();
     fSternheimerParameters.x1 = config().SternheimerX1();
     fSternheimerParameters.cbar = config().SternheimerCbar();
 
     fDriftVelFudgeFactor = config().DriftVelFudgeFactor();
 
     fUseIcarusMicrobooneDriftModel = config().UseIcarusMicrobooneDriftModel();
 
     fIncludeInterPlanePitchInXTickOffsets = config().IncludeInterPlanePitchInXTickOffsets();
 
     fSimpleBoundary = config().SimpleBoundary();
 
     fModBoxA = config().ModBoxAlpha();
     fModBoxB = config().ModBoxBeta();
   }

Member Data Documentation

std::vector<std::vector<double> > detinfo::DetectorPropertiesStandard::fDriftDirection

private

Definition at line 284 of file DetectorPropertiesStandard.h.

double detinfo::DetectorPropertiesStandard::fDriftVelFudgeFactor

private

Scaling factor to allow "fudging" of drift velocity

Definition at line 270 of file DetectorPropertiesStandard.h.

Referenced by DriftVelocity(), and ValidateAndConfigure().

std::vector<double> detinfo::DetectorPropertiesStandard::fEfield

private

kV/cm (per inter-plane volume) !

Definition at line 253 of file DetectorPropertiesStandard.h.

Referenced by Efield(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fElectronlifetime

private

microseconds

Definition at line 254 of file DetectorPropertiesStandard.h.

Referenced by ElectronLifetime(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fElectronsToADC

private

conversion factor for # of ionization electrons to 1 ADC count

Definition at line 256 of file DetectorPropertiesStandard.h.

Referenced by ElectronsToADC(), and ValidateAndConfigure().

const geo::GeometryCore* detinfo::DetectorPropertiesStandard::fGeo

private

Definition at line 251 of file DetectorPropertiesStandard.h.

Referenced by CheckTimeOffsets(), and DataFor().

bool detinfo::DetectorPropertiesStandard::fIncludeInterPlanePitchInXTickOffsets

private

Historically, ConvertTicksToX has allowed for the drift time between the wire planes. This is appropriate for recob::RawDigits, and recob::Wires from the 1D unfolding, but is not appropriate for recob::Wires from WireCell.

Definition at line 280 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), and ValidateAndConfigure().

const detinfo::LArProperties* detinfo::DetectorPropertiesStandard::fLP

private

Definition at line 250 of file DetectorPropertiesStandard.h.

Referenced by Eloss(), and ElossVar().

double detinfo::DetectorPropertiesStandard::fModBoxA

private

Definition at line 288 of file DetectorPropertiesStandard.h.

Referenced by ModBoxCorrection(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fModBoxB

private

Definition at line 289 of file DetectorPropertiesStandard.h.

Referenced by ModBoxCorrection(), and ValidateAndConfigure().

unsigned int detinfo::DetectorPropertiesStandard::fNumberTimeSamples

private

number of clock ticks per event

Definition at line 258 of file DetectorPropertiesStandard.h.

Referenced by NumberTimeSamples(), SetNumberTimeSamples(), and ValidateAndConfigure().

unsigned int detinfo::DetectorPropertiesStandard::fReadOutWindowSize

private

number of clock ticks per readout window

Definition at line 259 of file DetectorPropertiesStandard.h.

Referenced by ReadOutWindowSize(), and ValidateAndConfigure().

bool detinfo::DetectorPropertiesStandard::fSimpleBoundary

private

Definition at line 286 of file DetectorPropertiesStandard.h.

Referenced by SimpleBoundary(), and ValidateAndConfigure().

SternheimerParameters_t detinfo::DetectorPropertiesStandard::fSternheimerParameters

private

Sternheimer parameters.

Definition at line 282 of file DetectorPropertiesStandard.h.

Referenced by Eloss(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTemperature

private

kelvin

Definition at line 255 of file DetectorPropertiesStandard.h.

Referenced by Temperature(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTimeOffsetU

private

time offset to convert spacepoint coordinates to hit times on view U

Definition at line 260 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), TimeOffsetU(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTimeOffsetV

private

time offset to convert spacepoint coordinates to hit times on view V

Definition at line 262 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), TimeOffsetV(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTimeOffsetX

private

time offset to convert spacepoint coordinates to hit times on view X

Definition at line 268 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTimeOffsetY

private

time offset to convert spacepoint coordinates to hit times on view Y

Definition at line 266 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), TimeOffsetY(), and ValidateAndConfigure().

double detinfo::DetectorPropertiesStandard::fTimeOffsetZ

private

time offset to convert spacepoint coordinates to hit times on view Z

Definition at line 264 of file DetectorPropertiesStandard.h.

Referenced by DataFor(), TimeOffsetZ(), and ValidateAndConfigure().

bool detinfo::DetectorPropertiesStandard::fUseIcarusMicrobooneDriftModel

private

if true, use alternative ICARUS-MicroBooNE drift model instead of Walkowiak-based one

Definition at line 273 of file DetectorPropertiesStandard.h.

Referenced by DriftVelocity(), and ValidateAndConfigure().

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

lardataalg/v09_17_03/source/lardataalg/DetectorInfo/DetectorPropertiesStandard.h
lardataalg/v09_17_03/source/lardataalg/DetectorInfo/DetectorPropertiesStandard.cxx

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation