DetectorProperties.h

Go to the documentation of this file.

// \file DetectorProperties.h
//
// \brief pure virtual base interface for detector properties
//
// \author jpaley@fnal.gov
//
#ifndef LARDATA_DETINFO_DETECTORPROPERTIES_H
#define LARDATA_DETINFO_DETECTORPROPERTIES_H

#include "lardataalg/DetectorInfo/DetectorPropertiesData.h"

namespace detinfo {

  class DetectorClocksData;
  class DetectorProperties {
  public:
    DetectorProperties() = default;
    DetectorProperties(const DetectorProperties&) = delete;
    DetectorProperties(DetectorProperties&&) = delete;
    DetectorProperties& operator=(const DetectorProperties&) = delete;
    DetectorProperties& operator=(DetectorProperties&&) = delete;
    virtual ~DetectorProperties() = default;

    virtual double Efield(unsigned int planegap = 0) const = 0;

    virtual double DriftVelocity(double efield = 0., double temperature = 0.) const = 0;

    virtual double BirksCorrection(double dQdX) const = 0;
    virtual double BirksCorrection(double dQdX, double EField) const = 0;
    virtual double ModBoxCorrection(double dQdX) const = 0;
    virtual double ModBoxCorrection(double dQdX, double EField) const = 0;

    virtual double ElectronLifetime() const = 0;

    virtual double Density(double temperature) const = 0;
    virtual double Temperature() const = 0;

    virtual double Eloss(double mom, double mass, double tcut) const = 0;

    virtual double ElossVar(double mom, double mass) const = 0;

    virtual double Density() const { return Density(Temperature()); }

    virtual double ElectronsToADC() const = 0;
    virtual unsigned int NumberTimeSamples() const = 0;
    virtual unsigned int ReadOutWindowSize() const = 0;
    virtual double TimeOffsetU() const = 0;
    virtual double TimeOffsetV() const = 0;
    virtual double TimeOffsetZ() const = 0;
    virtual double TimeOffsetY() const
    {
      throw std::runtime_error("DetectorProperties::TimeOffsetY() not implemented");
    }

    // To set the model we want for the optical boundary simulation Simple or G4
    // default
    virtual bool SimpleBoundary() const = 0;

    // Returns data object that corresponds to data specific for a
    // given clock-data object instance.
    virtual DetectorPropertiesData DataFor(DetectorClocksData const& clockData) const = 0;

  }; // class DetectorProperties
} // namespace detinfo

#endif // LARDATA_DETINFO_DETECTORPROPERTIES_H