EcalCoder.h

Go to the documentation of this file.

#ifndef EcalSimAlgos_EcalCoder_h
#define EcalSimAlgos_EcalCoder_h 1

#include "CalibFormats/CaloObjects/interface/CaloTSamples.h"
#include "CondFormats/EcalObjects/interface/EcalPedestals.h"
#include "CondFormats/EcalObjects/interface/EcalIntercalibConstantsMC.h"
#include "CondFormats/EcalObjects/interface/EcalGainRatios.h"
#include "SimCalorimetry/EcalSimAlgos/interface/EcalCorrelatedNoiseMatrix.h"

template<typename M> class CorrelatedNoisifier ;
class EcalMGPASample;
class EcalDataFrame;
class DetId;

#include<vector>

namespace CLHEP {
  class HepRandomEngine;
}

/* \class EEDigitizerTraits
 * \brief Converts CaloDataFrame in CaloTimeSample and vice versa.
 *
 */
class EcalCoder
{
   public:

      typedef CaloTSamples<float,10> EcalSamples ;
      
      typedef CorrelatedNoisifier<EcalCorrMatrix> Noisifier ;

      enum { NBITS         =   12 , // number of available bits
         MAXADC        = 4095 , // 2^12 -1,  adc max range
         ADCGAINSWITCH = 4079 , // adc gain switch
         NGAINS        =    3   // number of electronic gains
      };

      EcalCoder( bool        addNoise        , 
         bool        PreMix1         ,
         Noisifier* ebCorrNoise0     ,
         Noisifier* eeCorrNoise0 = nullptr ,
         Noisifier* ebCorrNoise1 = nullptr ,
         Noisifier* eeCorrNoise1 = nullptr ,
         Noisifier* ebCorrNoise2 = nullptr ,
         Noisifier* eeCorrNoise2 = nullptr   ) ; // make EE version optional for tb compatibility
      virtual ~EcalCoder() ;

      void setPedestals( const EcalPedestals* pedestals ) ;

      void setGainRatios( const EcalGainRatios* gainRatios ) ;

      void setFullScaleEnergy( double EBscale ,
                   double EEscale   ) ;

      void setIntercalibConstants( const EcalIntercalibConstantsMC* ical ) ; 
 

      virtual void analogToDigital( CLHEP::HepRandomEngine*,
                                    const EcalSamples& clf ,
                    EcalDataFrame&     df    ) const;
 
   private:

      double fullScaleEnergy( const DetId & did ) const ;

      void encode( const EcalSamples& ecalSamples , 
           EcalDataFrame&     df,
                   CLHEP::HepRandomEngine* ) const ;

//      double decode( const EcalMGPASample& sample , 
//           const DetId&          detId    ) const ;

      //      void noisify( const EcalIntercalibConstantsMC* values ,
      //            int                              size     ) const ;

      void findPedestal( const DetId& detId    , 
             int          gainId   , 
             double&      pedestal ,
             double&      width      ) const ;
    
      void findGains( const DetId& detId, 
              double       theGains[] ) const ;

      void findIntercalibConstant( const DetId& detId ,
                   double&      icalconst ) const ;
   
      const EcalPedestals* m_peds ;
      
      const EcalGainRatios* m_gainRatios ; // the electronics gains

      const EcalIntercalibConstantsMC* m_intercals ; //record specific for simulation of gain variation in MC

      double m_maxEneEB ; // max attainable energy in the ecal barrel
      double m_maxEneEE ; // max attainable energy in the ecal endcap
      
      bool m_addNoise ;   // whether add noise to the pedestals and the gains
      bool m_PreMix1 ;   // Follow necessary steps for PreMixing input

      const Noisifier* m_ebCorrNoise[3] ;
      const Noisifier* m_eeCorrNoise[3] ;
};

#endif