FDetector/Pixel.h

Go to the documentation of this file.

#ifndef _fdet_Pixel_h_
#define _fdet_Pixel_h_

#include <string>

#include <det/ValidityStamp.h>

#include <utl/ErrorLogger.h>
#include <utl/Vector.h>
#include <utl/CoordinateSystem.h>
#include <utl/TabulatedFunction.h>


namespace fdet {

  class Telescope;


  class Pixel {

  public:
    enum Status {
      eGood = 0,
      eBadCalibration = 1,
      eUnknown
    };

    void Update();

    unsigned int GetRow(const unsigned int pixelid) const;
    unsigned int GetColumn(const unsigned int pixelid) const;

    const utl::Vector& GetDirection() const;

    const utl::CoordinateSystemPtr& GetPixelCoordinateSystem() const;

    double GetEndToEndCalibrationAtReferenceWavelength() const;
    double GetEndToEndCalibrationConstantAtReferenceWavelength() const;
    double GetOpticalEfficiencyCorrectionAtReferenceWavelength() const;


    const utl::TabulatedFunction& GetEndToEndCalibrationConstant() const;
    const utl::TabulatedFunction& GetOpticalEfficiencyCorrection() const;
    double GetEndToEndCalibration(const double wavelength) const;
    double GetEndToEndCalibrationConstant(const double wavelength) const;
    double GetOpticalEfficiencyCorrection(const double wavelength) const;

    double GetSimulatedEndToEndCalibration(const std::string& configSignature) const;
    double GetSimulatedDiaPhoton2ADC(const std::string& configSignature, const double wavelength) const;

    Status GetStatus() const;
    Status GetOpticalEfficiencyStatus() const;

    double GetTimeOffset() const;

    unsigned int GetId() const { return fPixelId; }
    unsigned int GetChannelId() const;
    bool IsMismatched() const { return (GetChannelId() != GetId()); }
    unsigned int GetTelescopeId() const { return fTelescopeId; }
    unsigned int GetEyeId() const { return fEyeId; }

    unsigned int GetRow() const { return GetRow(fPixelId); }
    unsigned int GetColumn() const { return GetColumn(fPixelId); }

    double GetSolidAngle() const;

    const utl::TabulatedFunction& GetQEfficiency() const;

    //In Reconstruction do not! call this with configSignature. This only exists in Simulation!
    double GetDiaPhoton2PEFactor(const double wavelength, const std::string& configSignature = "") const;

    float GetCloudFraction() const;
    bool HasCloudFraction() const;

    bool IsObscuredByCloud() const { return GetCloudIndex() > 0; }

    const Telescope& GetTelescope() const;

  private:
    Pixel(const unsigned int eyeId, const unsigned int telescopeId,
          const unsigned int pixelId,
          const std::string& physEyeIdString,
          const std::string& physTelIdString);
    ~Pixel();
    // prevent copying
    Pixel(const Pixel&);
    Pixel& operator=(const Pixel&);

    mutable utl::Vector fDirection;
    mutable utl::CoordinateSystemPtr fCoordinateSystem;

    mutable utl::TabulatedFunction fWavelengthCalib; // filled by Telescope
    mutable utl::TabulatedFunction fWavelengthOpticalEfficiencyCorrection; // filled by Telescope

    mutable double* fTimeOffset;
    mutable Status fPixelStatus;
    mutable Status fPixelOpticalEfficiencyStatus;
    mutable double* fSimulatedEndToEnd;

    unsigned int fEyeId;
    unsigned int fTelescopeId;
    unsigned int fPixelId;

    std::string fPhysicalEyeIdString;
    std::string fPhysicalTelescopeIdString;
    std::string fPixelIdString;

    mutable double* fSolidAngle;
    mutable utl::TabulatedFunction* fQEfficiency;

    mutable int fCloudIndex;
    mutable det::ValidityStamp fCloudValidityStamp;

    template<typename T>
    const T&
    GetPixelData(T*& requestedData,
                 const std::string& property,
                 const std::string& component,
                 const std::string& errorMsg,
                 const std::string& extraIndex = "") const;

    template<typename T>
    void
    GetPixelData(T& requestedData,
                 const std::string& property,
                 const std::string& component,
                 const std::string& errorMsg,
                 const std::string& extraIndex = "") const;

    template<typename T>
    const T&
    GetPixelDataDiaphragm(T*& requestedData,
                          const std::string& property,
                          const std::string& component,
                          const std::string& errorMsg) const;

    template<typename T>
    void
    GetPixelDataDiaphragm(T& requestedData,
                          const std::string& property,
                          const std::string& component,
                          const std::string& errorMsg) const;

    int GetCloudIndex() const;

    friend class fdet::Telescope;

  };

}


#endif

// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// compile-command: "make -C .. FDetector/Pixel.o  -k"
// End: