calo::CalorimetryAlg Class Reference

#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 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, double phi=90) 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, double phi=90) 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 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, double phi=90) 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, double phi=90) 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
double	BirksCorrection (double dQdx, double phi, double rho, double E_field) const
double	ModBoxCorrection (double dQdx, double phi, double rho, double E_field) 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, double phi=90) 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
double	fModBoxA
TF1	fModBoxBF
double	fBirksA
TF1	fBirksKF

Detailed Description

Definition at line 37 of file CalorimetryAlg.h.

Constructor & Destructor Documentation

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

inline

Definition at line 89 of file CalorimetryAlg.h.

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

calo::CalorimetryAlg::CalorimetryAlg

(

const Config &

config

)

Definition at line 23 of file CalorimetryAlg.cxx.

References calo::CalorimetryAlg::Config::CalAmpConstants, fBirksA, fBirksKF, fCalAreaConstants, fDoLifeTimeCorrection, fLifeTimeForm, fModBoxA, fModBoxBF, fUseModBox, util::kModBoxB, and util::kRecombk.

    : fCalAmpConstants{config.CalAmpConstants()}
    , fCalAreaConstants{config.CalAreaConstants()}
    , fUseModBox{config.CaloUseModBox()}
    , fLifeTimeForm{config.CaloLifeTimeForm()}
    , fDoLifeTimeCorrection{config.CaloDoLifeTimeCorrection()}
    , fModBoxA{config.ModBoxA()}
    , fModBoxBF("ModBoxB", config.ModBoxBTF1().c_str(), 0, 90)
    , fBirksA{config.BirksA()}
    , fBirksKF("BirksK", config.BirksKTF1().c_str(), 0, 90)
  {
    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";
    }

    // Set the parameters for the TF1s
    std::vector<double> modboxb_param;
    if (!config.ModBoxBParam(modboxb_param)) modboxb_param = {util::kModBoxB};

    for (unsigned i = 0; i < modboxb_param.size(); i++) {
      fModBoxBF.SetParameter(i, modboxb_param[i]);
    }

    std::vector<double> birksk_param;
    if (!config.BirksKParam(birksk_param)) birksk_param = {util::kRecombk};

    for (unsigned i = 0; i < birksk_param.size(); i++) {
      fBirksKF.SetParameter(i, birksk_param[i]);
    }
  }

Member Function Documentation

double calo::CalorimetryAlg::BirksCorrection	(	double	dQdx,
		double	phi,
		double	rho,
		double	E_field
	)		const

Definition at line 262 of file CalorimetryAlg.cxx.

References tca::dEdx(), fBirksA, fBirksKF, and util::kGeVToElectrons.

Referenced by dEdx_from_dQdx_e().

  {
    // from: S.Amoruso et al., NIM A 523 (2004) 275

    double A = fBirksA;
    double K = fBirksKF.Eval(phi);                              // in KV/cm*(g/cm^2)/MeV
    constexpr double Wion = 1000. / util::kGeVToElectrons;      // 23.6 eV = 1e, Wion in MeV/e
    K /= rho;                                                   // KV/MeV
    double const dEdx = dQdx / (A / Wion - K / E_field * dQdx); // MeV/cm

    return dEdx;
  }

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 60 of file CalorimetryAlg.cxx.

References detinfo::DetectorPropertiesData::Efield(), recob::Hit::PeakAmplitude(), recob::Hit::PeakTime(), geo::PlaneID::Plane, and recob::Hit::WireID().

Referenced by dEdx_AMP(), shwf::ShowerReco::LongTransEnergy(), calo::Calorimetry::produce(), calo::GnocchiCalorimetry::produce(), and showerreco::ShowerRecoAlg::RecoOneShower().

  {
    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	dQdx,
		double	time,
		unsigned int	plane,
		double	T0 = 0
	)		const

Definition at line 76 of file CalorimetryAlg.cxx.

References dEdx_from_dQdx_e(), detinfo::DetectorPropertiesData::Efield(), and fCalAmpConstants.

  {
    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,
		double	phi = 90
	)		const

Definition at line 91 of file CalorimetryAlg.cxx.

References dEdx_AMP(), recob::Hit::PeakAmplitude(), recob::Hit::PeakTime(), geo::PlaneID::Plane, and recob::Hit::WireID().

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

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,
		double	phi = 90
	)		const

Definition at line 110 of file CalorimetryAlg.cxx.

References dEdx_from_dQdx_e(), and fCalAmpConstants.

  {
    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, phi);
  }

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 127 of file CalorimetryAlg.cxx.

References detinfo::DetectorPropertiesData::Efield(), recob::Hit::Integral(), recob::Hit::PeakTime(), geo::PlaneID::Plane, and recob::Hit::WireID().

Referenced by calo::TrackCalorimetryAlg::AnalyzeHit(), mvapid::MVAAlg::CalcSegmentdEdxDist(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), ems::EMShower3D::ConvertFrom(), ems::EMShower3D::ConvertFrom2(), tca::dEdx(), dEdx_AREA(), shower::EMShowerAlg::FinddEdx_(), shwf::ShowerReco::LongTransEnergy(), shower::EMShowerAlg::MakeShower(), calo::ShowerCalorimetry::produce(), calo::Calorimetry::produce(), calo::GnocchiCalorimetry::produce(), and showerreco::ShowerRecoAlg::RecoOneShower().

  {
    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	dQdx,
		double	time,
		unsigned int	plane,
		double	T0 = 0
	)		const

Definition at line 143 of file CalorimetryAlg.cxx.

References dEdx_from_dQdx_e(), detinfo::DetectorPropertiesData::Efield(), and fCalAreaConstants.

  {
    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,
		double	phi = 90
	)		const

Definition at line 158 of file CalorimetryAlg.cxx.

References dEdx_AREA(), recob::Hit::Integral(), recob::Hit::PeakTime(), geo::PlaneID::Plane, and recob::Hit::WireID().

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

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,
		double	phi = 90
	)		const

Definition at line 177 of file CalorimetryAlg.cxx.

References dEdx_from_dQdx_e(), and fCalAreaConstants.

  {
    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, phi);
  }

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 192 of file CalorimetryAlg.cxx.

References detinfo::DetectorPropertiesData::Efield().

Referenced by dEdx_AMP(), and dEdx_AREA().

  {
    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, double  phi = 90  ) const

private

Definition at line 200 of file CalorimetryAlg.cxx.

References BirksCorrection(), detinfo::DetectorPropertiesData::Density(), fDoLifeTimeCorrection, fUseModBox, LifetimeCorrection(), and ModBoxCorrection().

  {
    if (fDoLifeTimeCorrection) {
      dQdx_e *= LifetimeCorrection(clock_data, det_prop, time, T0); // (dQdx_e in e/cm)
    }

    if (fUseModBox) { return ModBoxCorrection(dQdx_e, phi, det_prop.Density(), EField); }

    return BirksCorrection(dQdx_e, phi, det_prop.Density(), EField);
  }

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

inline

Definition at line 155 of file CalorimetryAlg.h.

Referenced by ShowerRecoTools::ShowerNumElectronsEnergy::CalculateEnergy(), and showerreco::ShowerRecoAlg::RecoOneShower().

    {
      return area / fCalAreaConstants[plane];
    }

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

inline

Definition at line 150 of file CalorimetryAlg.h.

Referenced by img::DataProviderAlg::DataProviderAlg(), and showerreco::ShowerRecoAlg::RecoOneShower().

    {
      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 221 of file CalorimetryAlg.cxx.

References e, detinfo::DetectorPropertiesData::ElectronLifetime(), fLifeTimeForm, detinfo::sampling_rate(), and detinfo::trigger_offset().

Referenced by ShowerRecoTools::ShowerNumElectronsEnergy::CalculateEnergy(), nnet::PointIdEffTest::countPfpDep(), dEdx_from_dQdx_e(), shower::TCShowerElectronLikelihood::getShowerProfile(), showerreco::ShowerRecoAlg::RecoOneShower(), img::DataProviderAlg::resizeView(), shower::TCShowerTemplateMaker::showerProfile(), and nnet::PointIdEffTest::testCNN().

  {
    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);
  }

double calo::CalorimetryAlg::ModBoxCorrection	(	double	dQdx,
		double	phi,
		double	rho,
		double	E_field
	)		const

Definition at line 247 of file CalorimetryAlg.cxx.

References tca::dEdx(), fModBoxA, fModBoxBF, and util::kGeVToElectrons.

Referenced by dEdx_from_dQdx_e().

  {
    // Modified Box model correction has better behavior than the Birks
    // correction at high values of dQ/dx.
    constexpr double Wion = 1000. / util::kGeVToElectrons; // 23.6 eV = 1e, Wion in MeV/e
    double const Beta = fModBoxBF.Eval(phi) / (rho * E_field);
    double const Alpha = fModBoxA;
    double const dEdx = (exp(Beta * Wion * dQdx) - Alpha) / Beta;

    return dEdx;
  }

Member Data Documentation

double calo::CalorimetryAlg::fBirksA

private

Definition at line 194 of file CalorimetryAlg.h.

Referenced by BirksCorrection(), and CalorimetryAlg().

TF1 calo::CalorimetryAlg::fBirksKF

private

Definition at line 195 of file CalorimetryAlg.h.

Referenced by BirksCorrection(), and CalorimetryAlg().

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

private

Definition at line 185 of file CalorimetryAlg.h.

Referenced by dEdx_AMP().

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

private

Definition at line 186 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and dEdx_AREA().

bool const calo::CalorimetryAlg::fDoLifeTimeCorrection

private

Definition at line 189 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and dEdx_from_dQdx_e().

int const calo::CalorimetryAlg::fLifeTimeForm

private

Definition at line 188 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and LifetimeCorrection().

double calo::CalorimetryAlg::fModBoxA

private

Definition at line 192 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and ModBoxCorrection().

TF1 calo::CalorimetryAlg::fModBoxBF

private

Definition at line 193 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and ModBoxCorrection().

bool const calo::CalorimetryAlg::fUseModBox

private

Definition at line 187 of file CalorimetryAlg.h.

Referenced by CalorimetryAlg(), and dEdx_from_dQdx_e().

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

private

Definition at line 170 of file CalorimetryAlg.h.

---

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

• larreco/v09_25_00/source/larreco/Calorimetry/CalorimetryAlg.h
• larreco/v09_25_00/source/larreco/Calorimetry/CalorimetryAlg.cxx