#include <CalorimetryAlg.h>

Classes
struct	Config

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

	CalorimetryAlg (const Config &config)

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, recob::Hit const &hit, double pitch, double T0=0) const

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQ, double time, double pitch, unsigned int plane, double T0=0) const

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx, double time, unsigned int plane, double T0=0) const

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, recob::Hit const &hit, double pitch, double T0, double EField) const

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQ, double time, double pitch, unsigned int plane, double T0, double EField) const

double	dEdx_AMP (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx, double time, unsigned int plane, double T0, double EField) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, recob::Hit const &hit, double pitch, double T0=0) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQ, double time, double pitch, unsigned int plane, double T0=0) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx, double time, unsigned int plane, double T0=0) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, recob::Hit const &hit, double pitch, double T0, double EField) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQ, double time, double pitch, unsigned int plane, double T0, double EField) const

double	dEdx_AREA (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx, double time, unsigned int plane, double T0, double EField) const

double	ElectronsFromADCPeak (double adc, unsigned short plane) const

double	ElectronsFromADCArea (double area, unsigned short plane) const

double	LifetimeCorrection (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double time, double T0=0) const

Private Member Functions
double	dEdx_from_dQdx_e (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx_e, double time, double T0=0) const

double	dEdx_from_dQdx_e (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double dQdx_e, double time, double T0, double EField) const

Private Attributes
art::ServiceHandle< geo::Geometry const >	geom

std::vector< double > const	fCalAmpConstants

std::vector< double > const	fCalAreaConstants

bool const	fUseModBox

int const	fLifeTimeForm

bool const	fDoLifeTimeCorrection

Detailed Description

Definition at line 33 of file CalorimetryAlg.h.

Constructor & Destructor Documentation

calo::CalorimetryAlg::CalorimetryAlg ( const fhicl::ParameterSet & pset )

inline

Definition at line 57 of file CalorimetryAlg.h.

58 : CalorimetryAlg(fhicl::Table<Config>(pset, {})())

59 {}

fhicl::Table< Config >

calo::CalorimetryAlg::CalorimetryAlg

CalorimetryAlg(const fhicl::ParameterSet &pset)

Definition: CalorimetryAlg.h:57

calo::CalorimetryAlg::CalorimetryAlg ( const Config & config )

Definition at line 23 of file CalorimetryAlg.cxx.

     : fCalAmpConstants{config.CalAmpConstants()}
     , fCalAreaConstants{config.CalAreaConstants()}
     , fUseModBox{config.CaloUseModBox()}
     , fLifeTimeForm{config.CaloLifeTimeForm()}
     , fDoLifeTimeCorrection{config.CaloDoLifeTimeCorrection()}
   {
     if (fLifeTimeForm != 0 and fLifeTimeForm != 1) {
       throw cet::exception("CalorimetryAlg")
         << "Unknow CaloLifeTimeForm " << fLifeTimeForm << '\n'
         << "Must select either '0' for exponential or '1' for exponential + "
            "constant.\n";
     }
   }

Member Function Documentation

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		recob::Hit const &	hit,
		double	pitch,
		double	T0 = `0`
	)		const

Definition at line 42 of file CalorimetryAlg.cxx.

   {
     return dEdx_AMP(
       clock_data, det_prop, hit.PeakAmplitude() / pitch, hit.PeakTime(), hit.WireID().Plane, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQ,
		double	time,
		double	pitch,
		unsigned int	plane,
		double	T0 = `0`
	)		const

Todo:: The plane argument should really be for a view instead

Definition at line 55 of file CalorimetryAlg.cxx.

   {
     double const dQdx = dQ / pitch; // in ADC/cm
     return dEdx_AMP(clock_data, det_prop, dQdx, time, plane, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx,
		double	time,
		unsigned int	plane,
		double	T0 = `0`
	)		const

Definition at line 69 of file CalorimetryAlg.cxx.

   {
     double const fADCtoEl = fCalAmpConstants[plane];
     double const dQdx_e = dQdx / fADCtoEl; // Conversion from ADC/cm to e/cm
     return dEdx_from_dQdx_e(clock_data, det_prop, dQdx_e, time, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		recob::Hit const &	hit,
		double	pitch,
		double	T0,
		double	EField
	)		const

Definition at line 85 of file CalorimetryAlg.cxx.

   {
     return dEdx_AMP(
       clock_data, det_prop, hit.PeakAmplitude() / pitch, hit.PeakTime(), hit.WireID().Plane, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQ,
		double	time,
		double	pitch,
		unsigned int	plane,
		double	T0,
		double	EField
	)		const

Todo:: The plane argument should really be for a view instead

Definition at line 99 of file CalorimetryAlg.cxx.

   {
     double const dQdx = dQ / pitch; // in ADC/cm
     return dEdx_AMP(clock_data, det_prop, dQdx, time, plane, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_AMP	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx,
		double	time,
		unsigned int	plane,
		double	T0,
		double	EField
	)		const

Definition at line 114 of file CalorimetryAlg.cxx.

   {
     double const fADCtoEl = fCalAmpConstants[plane];
     double const dQdx_e = dQdx / fADCtoEl; // Conversion from ADC/cm to e/cm
     return dEdx_from_dQdx_e(clock_data, det_prop, dQdx_e, time, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		recob::Hit const &	hit,
		double	pitch,
		double	T0 = `0`
	)		const

Definition at line 131 of file CalorimetryAlg.cxx.

   {
     return dEdx_AREA(
       clock_data, det_prop, hit.Integral() / pitch, hit.PeakTime(), hit.WireID().Plane, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQ,
		double	time,
		double	pitch,
		unsigned int	plane,
		double	T0 = `0`
	)		const

Definition at line 143 of file CalorimetryAlg.cxx.

   {
     double const dQdx = dQ / pitch; // in ADC/cm
     return dEdx_AREA(clock_data, det_prop, dQdx, time, plane, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx,
		double	time,
		unsigned int	plane,
		double	T0 = `0`
	)		const

Definition at line 157 of file CalorimetryAlg.cxx.

   {
     double const fADCtoEl = fCalAreaConstants[plane];
     double const dQdx_e = dQdx / fADCtoEl; // Conversion from ADC/cm to e/cm
     return dEdx_from_dQdx_e(clock_data, det_prop, dQdx_e, time, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		recob::Hit const &	hit,
		double	pitch,
		double	T0,
		double	EField
	)		const

Definition at line 173 of file CalorimetryAlg.cxx.

   {
     return dEdx_AREA(
       clock_data, det_prop, hit.Integral() / pitch, hit.PeakTime(), hit.WireID().Plane, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQ,
		double	time,
		double	pitch,
		unsigned int	plane,
		double	T0,
		double	EField
	)		const

Definition at line 186 of file CalorimetryAlg.cxx.

   {
     double const dQdx = dQ / pitch; // in ADC/cm
     return dEdx_AREA(clock_data, det_prop, dQdx, time, plane, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_AREA	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx,
		double	time,
		unsigned int	plane,
		double	T0,
		double	EField
	)		const

Definition at line 201 of file CalorimetryAlg.cxx.

   {
     double const fADCtoEl = fCalAreaConstants[plane];
     double const dQdx_e = dQdx / fADCtoEl; // Conversion from ADC/cm to e/cm
     return dEdx_from_dQdx_e(clock_data, det_prop, dQdx_e, time, T0, EField);
   }

double calo::CalorimetryAlg::dEdx_from_dQdx_e	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx_e,
		double	time,
		double	T0 = `0`
	)		const

private

Definition at line 216 of file CalorimetryAlg.cxx.

   {
     return dEdx_from_dQdx_e(clock_data, det_prop, dQdx_e, time, T0, det_prop.Efield());
   }

double calo::CalorimetryAlg::dEdx_from_dQdx_e	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	dQdx_e,
		double	time,
		double	T0,
		double	EField
	)		const

private

Definition at line 225 of file CalorimetryAlg.cxx.

   {
     if (fDoLifeTimeCorrection) {
       dQdx_e *= LifetimeCorrection(clock_data, det_prop, time, T0); // (dQdx_e in e/cm)
     }
 
     if (fUseModBox) { return det_prop.ModBoxCorrection(dQdx_e, EField); }
 
     return det_prop.BirksCorrection(dQdx_e, EField);
   }

double calo::CalorimetryAlg::ElectronsFromADCArea	(	double	area,
		unsigned short	plane
	)		const

inline

Definition at line 153 of file CalorimetryAlg.h.

     {
       return area / fCalAreaConstants[plane];
     }

double calo::CalorimetryAlg::ElectronsFromADCPeak	(	double	adc,
		unsigned short	plane
	)		const

inline

Definition at line 147 of file CalorimetryAlg.h.

     {
       return adc / fCalAmpConstants[plane];
     }

double calo::CalorimetryAlg::LifetimeCorrection	(	detinfo::DetectorClocksData const &	clock_data,
		detinfo::DetectorPropertiesData const &	det_prop,
		double	time,
		double	T0 = `0`
	)		const

Definition at line 246 of file CalorimetryAlg.cxx.

   {
     float const t = time - trigger_offset(clock_data);
     double const timetick = sampling_rate(clock_data) * 1.e-3; // time sample in microsec
     double const adjusted_time = t * timetick - T0 * 1e-3;     //  (in microsec)
 
     assert(fLifeTimeForm < 2);
     if (fLifeTimeForm == 0) {
       // Exponential form
       double const tau = det_prop.ElectronLifetime();
       return exp(adjusted_time / tau);
     }
 
     // Exponential+constant form
     auto const& elifetime_provider =
       art::ServiceHandle<lariov::ElectronLifetimeService const>()->GetProvider();
     return elifetime_provider.Lifetime(adjusted_time);
   }

Member Data Documentation

std::vector<double> const calo::CalorimetryAlg::fCalAmpConstants

private

Definition at line 178 of file CalorimetryAlg.h.

std::vector<double> const calo::CalorimetryAlg::fCalAreaConstants

private

Definition at line 179 of file CalorimetryAlg.h.

bool const calo::CalorimetryAlg::fDoLifeTimeCorrection

private

Definition at line 182 of file CalorimetryAlg.h.

int const calo::CalorimetryAlg::fLifeTimeForm

private

Definition at line 181 of file CalorimetryAlg.h.

bool const calo::CalorimetryAlg::fUseModBox

private

Definition at line 180 of file CalorimetryAlg.h.

art::ServiceHandle<geo::Geometry const> calo::CalorimetryAlg::geom

private

Definition at line 164 of file CalorimetryAlg.h.

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

larreco/larreco/Calorimetry/CalorimetryAlg.h
larreco/larreco/Calorimetry/CalorimetryAlg.cxx

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation