lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t Struct Reference

Internal structure containing the calibration information. More...

Public Member Functions
double	evalFactor (double E) const
double	evalError (double E) const
bool	present () const
bool	uniform () const
CalibrationInfo_t &	applyTo (PDGID_t id)
CalibrationInfo_t &	applyTo (std::initializer_list< PDGID_t > ids)
template<typename Stream >
void	reportTo (Stream &&out) const
	Prints a short report of this correction. More...

Public Attributes
std::vector< PDGID_t >	appliesTo
	PID it applies to; unused. More...
double	minE = -1.
	lower end of the energy range covered [GeV] More...
double	maxE = -1.
	upper end of the energy range covered [GeV] More...
std::unique_ptr< ROOT::Math::Interpolator >	factor
	parametrisation of the correction factor More...
std::unique_ptr< ROOT::Math::Interpolator >	error
	parametrisation of the correction uncertainty More...

Detailed Description

Internal structure containing the calibration information.

Definition at line 209 of file ShowerCalibrationGaloreFromPID.h.

Member Function Documentation

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t & lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo

(

PDGID_t

id

)

Definition at line 271 of file ShowerCalibrationGaloreFromPID.cxx.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::OpenROOTdirectory(), and lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration().

{
   auto it = std::lower_bound(appliesTo.begin(), appliesTo.end(), id);
   if ((it == appliesTo.end()) || (*it != id))
      appliesTo.insert(it, id);
   return *this;
} // ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo(ID)

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t & lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo

(

std::initializer_list< PDGID_t >

ids

)

Definition at line 282 of file ShowerCalibrationGaloreFromPID.cxx.

References evalFactor().

{
   appliesTo.insert(appliesTo.begin(), ids.begin(), ids.end());
   std::sort(appliesTo.begin(), appliesTo.end());
   return *this;
} // ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo(IDs)

double lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalError

(

double

E

)

const

Definition at line 301 of file ShowerCalibrationGaloreFromPID.cxx.

References lar::example::ShowerCalibrationGaloreFromPID::createInterpolator(), max, maxE, min, and minE.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::correction(), and evalFactor().

{
   double const boundE = std::min(maxE, std::max(minE, E));
   return error->Eval(boundE);
}

double lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalFactor

(

double

E

)

const

Definition at line 293 of file ShowerCalibrationGaloreFromPID.cxx.

References evalError(), max, maxE, min, and minE.

Referenced by applyTo(), lar::example::ShowerCalibrationGaloreFromPID::correction(), and lar::example::ShowerCalibrationGaloreFromPID::correctionFactor().

{
   double const boundE = std::min(maxE, std::max(minE, E));
   return factor->Eval(boundE);
}

bool lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::present ( ) const

inline

Definition at line 223 of file ShowerCalibrationGaloreFromPID.h.

{ return maxE >= 0.; }

template<typename Stream >

void lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::reportTo

(

Stream &&

out

)

const

Prints a short report of this correction.

Definition at line 342 of file ShowerCalibrationGaloreFromPID.h.

References maxE, minE, and art::productstatus::present().

Referenced by lar::example::ShowerCalibrationGaloreFromPID::reportTo().

{
   if (!present()) {
      out << "not present";
      return;
   }
   if (uniform()) {
      out << "uniform correction " << factor->Eval(minE) << " +/- "
         << error->Eval(minE) << " for all energies";
   }
   else {
      out << "correction valid from E=" << minE
         << " GeV (" << factor->Eval(minE) << " +/- " << error->Eval(minE)
         << ") to E=" << maxE
         << " GeV (" << factor->Eval(maxE) << " +/- " << error->Eval(maxE)
         << ")";
   }
   if (!appliesTo.empty()) {
      out << "; covers particles ID={";
      for (auto id: appliesTo) out << " " << id;
      out << " }";
   }
   
} // lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::report()

bool lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::uniform ( ) const

inline

Definition at line 224 of file ShowerCalibrationGaloreFromPID.h.

References maxE.

{ return minE == maxE; }

Member Data Documentation

std::vector<PDGID_t> lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::appliesTo

PID it applies to; unused.

Definition at line 210 of file ShowerCalibrationGaloreFromPID.h.

std::unique_ptr<ROOT::Math::Interpolator> lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::error

parametrisation of the correction uncertainty

Definition at line 218 of file ShowerCalibrationGaloreFromPID.h.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration().

std::unique_ptr<ROOT::Math::Interpolator> lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::factor

parametrisation of the correction factor

Definition at line 215 of file ShowerCalibrationGaloreFromPID.h.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration().

double lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::maxE = -1.

upper end of the energy range covered [GeV]

Definition at line 212 of file ShowerCalibrationGaloreFromPID.h.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration().

double lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::minE = -1.

lower end of the energy range covered [GeV]

Definition at line 211 of file ShowerCalibrationGaloreFromPID.h.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/Services/ShowerCalibrationGalore/Providers/ShowerCalibrationGaloreFromPID.h
• /cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/Services/ShowerCalibrationGalore/Providers/ShowerCalibrationGaloreFromPID.cxx