ICalibDataSvc.h

Go to the documentation of this file.

/*
 *  ICalibDataSvc.h
 *
 *  Interface for Calibration Data
 *
 *  Created by Dan Dwyer on 2008/09/26
 */

#ifndef DATASVC_ICALIBDATASVC_H
#define DATASVC_ICALIBDATASVC_H

#include "GaudiKernel/IInterface.h"
#include "Conventions/Detectors.h"
#include "Conventions/Electronics.h"
#include "Context/ServiceMode.h"
#include "math.h"
#include <vector>

namespace DayaBay {

  // Calibration Data for one PMT
  class PmtCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
      kBadEfficiency = 0x02,
      kBadTiming     = 0x04,
      kBadGain       = 0x08,      
      kBadGainWidth  = 0x10,
      kBadPedestal   = 0x20
    };
    PmtCalibData(){m_status=kUnknown; m_speHigh=0.; m_sigmaSpeHigh=0.; 
      m_speLow=0.; m_timeOffset=0.; m_timeSpread=0.; m_efficiency=0.; 
      m_prePulseProb=0.; m_afterPulseProb=0.; m_darkRate=0.;}
    ~PmtCalibData(){;}
  public:
    DayaBay::DetectorSensor m_pmtId;  // PMT Sensor ID number
    Status_t m_status;       // Status check on the PMT
    double m_speHigh;        // Single photoelectron mean ADC value (high gain)
    double m_sigmaSpeHigh;   // Single p.e. 1-sigma peak width (high gain)
    double m_speLow;         // ADC per P.E. ratio for low gain ADC channel
    double m_timeOffset;     // Relative transit time offset
    double m_timeSpread;     // Transit time spread
    double m_efficiency;     // Relative efficiency
    double m_prePulseProb;   // Probability of prepulsing
    double m_afterPulseProb; // Probability of afterpulsing
    double m_darkRate;       // Dark Rate
  };

  // Calibration Data for pedestal bias (jpochoa)
  class PedBiasCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
    };
    struct GausLine { 
      double amp, mean, sigma, offset, b, m;
    };
    struct Line {
      double b,m;
    };
    PedBiasCalibData(){m_status=kUnknown;m_amp.b=0;m_amp.m=0;m_mean.amp=0;m_mean.mean=0;m_mean.sigma=0;m_mean.offset=0;m_mean.b=0;m_mean.m=0;m_sigma.amp=0;m_sigma.mean=0;m_sigma.sigma=0;m_sigma.offset=0;m_sigma.b=0;m_sigma.m=0;m_a0.b=0;m_a0.m=0;m_a1.b=0;m_a1.m=0;m_a2.b=0;m_a2.m=0;m_a3.b=0;m_a3.m=0;}
    ~PedBiasCalibData(){;}
  public:
    DayaBay::DetectorSensor m_pmtId;  // PMT Sensor ID number
    Status_t m_status;       // Status check on the PMT
    GausLine m_mean, m_sigma;
    Line m_amp, m_a0, m_a1, m_a2, m_a3; 
      
  };

  // PMT Calibration Data for high-gain (jpochoa)
  class HighGainCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
    };
    HighGainCalibData(){m_status=kUnknown; m_speHigh=0; m_speHighError=0; m_sigmaSpeHigh=0; m_speHighFitQual=0;}
    ~HighGainCalibData(){;}
  public:
    DayaBay::DetectorSensor m_pmtId;  // PMT Sensor ID number
    Status_t m_status;       // Status check on the PMT
    double m_speHigh;
    double m_speHighError;
    double m_sigmaSpeHigh;
    double m_speHighFitQual;
  };

  // PMT Calibration Data for fine-gain (jpochoa)
  // Note: is same as above, but with FeeChannelId rather than DetectorSensor. See trac #1196
  class FineGainCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
      kBad           = 0x02
    };
    FineGainCalibData(){m_status=kUnknown; m_speHigh=0; m_speHighError=0; m_sigmaSpeHigh=0; m_speHighFitQual=0;}
    ~FineGainCalibData(){;}
  public:
    DayaBay::FeeChannelId m_channelId;  // FEE channel ID of channel connected to PMT 
    Status_t m_status;       // Status check on the PMT
    double m_speHigh;
    double m_speHighError;
    double m_sigmaSpeHigh;
    double m_speHighFitQual;
  };

  // PMT Calibration Data for timing (jpochoa)
  class TimingCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
      kBad           = 0x02
    };
    TimingCalibData(){m_status=kUnknown; m_par0=0; m_par1=0; m_par2=0; m_par3=0; m_par4=0; m_par5=0; m_fitqual=0;}
    double fullCorrection(float charge){     
      if(charge>0)
        return m_par0+m_par1*exp(-m_par2*charge)+m_par3*exp(-m_par4*charge)+m_par5*log(charge);
      else return m_par0;
    }
    ~TimingCalibData(){;}
  public:
    DayaBay::FeeChannelId m_channelId;  // PMT Sensor ID number
    Status_t m_status;       // Status check on the PMT
    double m_par0;
    double m_par1;
    double m_par2;
    double m_par3;
    double m_par4;
    double m_par5;
    double m_fitqual;
  };

  // FEE Channel Coarse-Fine Gain Conversion (jpochoa)
  class GainConvCalibData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
    };
    struct Line {
      double slope,uncert;
    };
    GainConvCalibData(){m_status=kUnknown; m_fineCoarseRatio=0; m_fineCoarseRatioErr=0;}
    ~GainConvCalibData(){;}
  public:
    DayaBay::FeeChannelId m_channelId;  // PMT Sensor ID number
    Status_t m_status;       // Status check on the Fee Channel 
    double m_fineCoarseRatio;
    double m_fineCoarseRatioErr;
    Line m_frline,m_crline; 
  };
  
  //  Calibration Data for one RPC strip
  class RpcCalibData {
  public:
    enum Status_t {
      kUnknown      = 0x00,
      kGood         = 0x01
    };
    RpcCalibData(){m_status=kUnknown; m_gain=0.; m_sigmaGain=0.; 
      m_timeOffset=0.; m_timeSpread=0.; m_efficiency=0.; m_noiseRate=0.;}
    ~RpcCalibData(){;}
  public:
    DayaBay::RpcSensor m_rpcId;      // RPC Sensor ID number
    Status_t m_status;      // RPC strip status
    double m_gain;          // Relative gain of rpc strip
    double m_sigmaGain;     // 1-sigma variation in pulse size
    double m_timeOffset;    // Relative time offset
    double m_timeSpread;    // Time spread
    double m_efficiency;    // Relative efficiency
    double m_noiseRate;     // Single pulse noise rate
  };

  // Calibration data for one Front-end electronics channel
  class FeeCalibData {
  public:
    enum Status_t {
      kUnknown      = 0x00,
      kGood         = 0x01
    };
    FeeCalibData(){m_status = kUnknown; m_adcThresholdHigh=0.; 
      m_adcThresholdLow=0.; m_adcBaselineHigh=0.; m_adcBaselineLow=0.;}
    ~FeeCalibData(){;}
  public:
    DayaBay::FeeChannelId m_channelId;  // Electronics channel ID number
    Status_t m_status;         // Channel status
    double m_adcThresholdHigh; // Channel threshold, as measured in ~ADC counts
    double m_adcThresholdLow;  // Channel threshold, as measured in ~ADC counts
    double m_adcBaselineHigh;  // Measured high-gain baseline ADC value
    double m_adcBaselineLow;   // Measured low-gain baseline ADC value
  };

  // Calibration data for one RPC Front-end electronics channel
  class FecCalibData {
  public:
    enum Status_t {
      kUnknown      = 0x00,
      kGood         = 0x01
    };
    FecCalibData(){m_status = kUnknown;}
    ~FecCalibData(){;}
  public:
    DayaBay::FecChannelId m_channelId;  // Electronics channel ID number
    Status_t m_status;         // Channel status
  };
    
  // Energy Scale Calibration Points from Calibration Sources (littlejo)
  class SrcEnergyData {
  public:
    enum Status_t {
      kUnknown       = 0x00,
      kGood          = 0x01,
    };
    SrcEnergyData(){m_status=kUnknown; m_sourcePeakType=0; m_xSrcPosition=0; m_ySrcPosition=0; m_zSrcPosition=0; m_pePeak=0; m_pePeakUnc=0; m_pePeakFitQuality=0;}
    ~SrcEnergyData(){;}
  public:
    Status_t m_status;    // Status check on the calibration delpoyment
    int m_sourcePeakType;  // Source peak type DayaBay::Calibration::SourceType::SourcePeakType_t
    double m_xSrcPosition;
    double m_ySrcPosition;
    double m_zSrcPosition;
    double m_pePeak;
    double m_pePeakUnc;
    double m_pePeakFitQuality;
  };

}

// Declaration of the interface ID
static const InterfaceID IID_ICalibDataSvc("ICalibDataSvc",1,0);

class ICalibDataSvc : virtual public IInterface
{
 public:
  // Retrieve interface ID
  static const InterfaceID& interfaceID(){
    return IID_ICalibDataSvc;
  }

  // Return the PMT Calibration data
  virtual const DayaBay::PmtCalibData* pmtCalibData(
                                           const DayaBay::DetectorSensor& pmtId,
                                           const ServiceMode& svcMode)= 0;

  // Return the PedBias Calibration data
  virtual const DayaBay::PedBiasCalibData* pedBiasCalibData(
                                           const DayaBay::DetectorSensor& pmtId,
                                           const ServiceMode& svcMode)= 0;

  // Return the HighGain Calibration data
  virtual const DayaBay::HighGainCalibData* highGainCalibData(
                                           const DayaBay::DetectorSensor& pmtId,
                                           const ServiceMode& svcMode)= 0;

  //The timing classes are now superseded by DybKernel/IPmtCalibSvc.h
  // Return the Timing Calibration data
  //virtual const DayaBay::TimingCalibData* timingCalibData(
  //                               const DayaBay::DetectorSensor& pmtId,
  //                               const ServiceMode& svcMode)= 0;

  // Return the Timing Calibration data
  //virtual const DayaBay::GainConvCalibData* gainConvCalibData(
  //                                       const DayaBay::FeeChannelId& channelId,
  //                                       const ServiceMode& svcMode)= 0;

  // Return the RPC Calibration data
  virtual const DayaBay::RpcCalibData* rpcCalibData(
                                           const DayaBay::RpcSensor& rpcId,
                                           const ServiceMode& svcMode)= 0;

  // Return the FEE Calibration data
  virtual const DayaBay::FeeCalibData* feeCalibData(
                                         const DayaBay::FeeChannelId& channelId,
                                         const ServiceMode& svcMode)= 0;

  // Return the FEC Calibration data
  virtual const DayaBay::FecCalibData* fecCalibData(
                                         const DayaBay::FecChannelId& channelId,
                                         const ServiceMode& svcMode)= 0;

  // Return the Calibration Source energy values for a given runNumber
  virtual const DayaBay::SrcEnergyData* srcEnergyData( int type,
                                                      const ServiceMode& svcMode)= 0;

  // Return the array of Calibration data by detector
  virtual const std::vector<DayaBay::PmtCalibData>& pmtCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of PedBias data by detector
  virtual const std::vector<DayaBay::PedBiasCalibData>& pedBiasCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of HighGain data by detector
  virtual const std::vector<DayaBay::HighGainCalibData>& highGainCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of Timing data by detector
  //virtual const std::vector<DayaBay::TimingCalibData>& timingCalibList(
  //                                        const DayaBay::Detector& detectorId,
  //                                       const ServiceMode& svcMode)= 0;

  // Return the array of Timing data by detector
  //virtual const std::vector<DayaBay::GainConvCalibData>& gainConvCalibList(
  //                                         const DayaBay::Detector& detectorId,
  //                                       const ServiceMode& svcMode)= 0;

  // Return the array of Calibration data by detector
  virtual const std::vector<DayaBay::RpcCalibData>& rpcCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of Calibration data by detector
  virtual const std::vector<DayaBay::FeeCalibData>& feeCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of Calibration data by detector
  virtual const std::vector<DayaBay::FecCalibData>& fecCalibList(
                                           const DayaBay::Detector& detectorId,
                                           const ServiceMode& svcMode)= 0;

  // Return the array of HighGain data by detector
  virtual const std::vector<DayaBay::SrcEnergyData>& srcEnergyList(
                                                                   const ServiceMode& svcMode)= 0;

};

#endif  // DATASVC_ICALIBDATASVC_H