TileEMScale.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2018 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TILECONDITIONS_TILEEMSCALE_H
#define TILECONDITIONS_TILEEMSCALE_H

 
// Tile includes
#include "TileConditions/TileCalibData.h"
#include "TileIdentifier/TileRawChannelUnit.h"
#include "TileCalibBlobObjs/TileCalibDrawerFlt.h"
 
#include <vector>
#include <array>
 
class TileEMScale {
  public:
 
    TileEMScale();
    virtual ~TileEMScale();
 
    bool initialize();

    float calibrateChannel(unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude,
                           TileRawChannelUnit::UNIT rawDataUnitIn, TileRawChannelUnit::UNIT rawDataUnitOut) const;

    float applyEMScaleCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyCesiumCalibration(unsigned int drawerIdx, unsigned int channel,
                                 float amplitude, bool applyLasCorr = true) const;

    float applyLaserCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyLaserLinearCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyLaserNonLinearCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyChargeCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                 float amplitude) const;

    float applyChargLinearCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                      float amplitude) const;

    float applyChargeNonLinearCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                          float amplitude) const;
 

    float calibrateOnlineChannel(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                 float amplitude, TileRawChannelUnit::UNIT onlUnit) const;

    float applyOnlineEMScaleCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyOnlineCesiumCalibration(unsigned int drawerIdx, unsigned int channel,
                                       float amplitude, bool applyLasCorr = true) const;

    float applyOnlineLaserCalibration(unsigned int drawerIdx, unsigned int channel, float amplitude) const;

    float applyOnlineChargeCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                       float amplitude) const;

    float undoOnlineChannelCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                                       float amplitude, TileRawChannelUnit::UNIT onlUnit) const;

    float getCesiumReferenceLaserGain(unsigned int drawerIdx, unsigned int channel, unsigned int adc) const;

    float getCesiumReferenceHV(unsigned int drawerIdx, unsigned int channel) const;

    float getCesiumReferenceTemperature(unsigned int drawerIdx, unsigned int channel) const;

    float getLaserFiberVariation(unsigned int drawerIdx, unsigned int channel) const;

    float getLaserPartitionVariation(unsigned int drawerIdx) const;

    float getLaserReferenceHV(unsigned int drawerIdx, unsigned int channel) const;

    TileRawChannelUnit::UNIT getOnlineCacheUnit() const;

    void setOnlineCacheUnit(TileRawChannelUnit::UNIT onlCacheUnit);
 
    void setCalibOflCisLin(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflCisNln(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflLasLin(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflLasNln(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflLasFib(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflCes(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOflEms(std::unique_ptr<TileCalibDataFlt> calibData);
 
    void setCalibOnlCis(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOnlLas(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOnlCes(std::unique_ptr<TileCalibDataFlt> calibData);
    void setCalibOnlEms(std::unique_ptr<TileCalibDataFlt> calibData);
 
    void setMaxChannels(unsigned int maxChannels);
    void setMaxGains(unsigned int maxGains);
 
  protected:

    void resetOnlineCache();

    float getOnlineCalibration(unsigned int drawerIdx, unsigned int channel, unsigned int adc,
                               TileRawChannelUnit::UNIT onlUnit) const;

    bool checkIfOflLaserLinearCalibrationUsed() const;

    bool checkIfOflLaserNonLinearCalibrationUsed() const;

 
    unsigned int getCacheIndex(unsigned int drawerIdx, unsigned int channel, unsigned int adc) const;
 
    //=== cache of total online calibration factors
    TileRawChannelUnit::UNIT m_onlCacheUnit;
    std::vector<float> m_onlCache;
 
    bool m_isOflLasLinUsed;
    bool m_isOflLasNlnUsed;
 
    //=== TileCondProxies are needed by the TileCalibEms
    //--- offline TileCalibData
    std::unique_ptr<TileCalibDataFlt> m_calibOflCisLin;
    std::unique_ptr<TileCalibDataFlt> m_calibOflCisNln;
    std::unique_ptr<TileCalibDataFlt> m_calibOflLasLin;
    std::unique_ptr<TileCalibDataFlt> m_calibOflLasNln;
    std::unique_ptr<TileCalibDataFlt> m_calibOflLasFib;
    std::unique_ptr<TileCalibDataFlt> m_calibOflCes;
    std::unique_ptr<TileCalibDataFlt> m_calibOflEms;
 
    //--- online TileCalibData
    std::unique_ptr<TileCalibDataFlt> m_calibOnlCis;
    std::unique_ptr<TileCalibDataFlt> m_calibOnlLas;
    std::unique_ptr<TileCalibDataFlt> m_calibOnlCes;
    std::unique_ptr<TileCalibDataFlt> m_calibOnlEms;
 
    bool m_useOflLasFib;
 
    unsigned int m_maxChannels;
    unsigned int m_maxGains;
    unsigned int m_drawerCacheSize;
 
    const float m_epsilon = 1.e-5;
};
 
#include "AthenaKernel/CLASS_DEF.h"
#include "AthenaKernel/CondCont.h"
CLASS_DEF(TileEMScale, 166690091, 0)
CONDCONT_DEF(TileEMScale, 177875727);
 
 
// inlines
 
inline
TileRawChannelUnit::UNIT TileEMScale::getOnlineCacheUnit() const {
  return m_onlCacheUnit;
}
 
inline
void TileEMScale::setOnlineCacheUnit(TileRawChannelUnit::UNIT onlCacheUnit) {
  m_onlCacheUnit = onlCacheUnit;
}
 
inline
void TileEMScale::setMaxChannels(unsigned int maxChannels) {
  m_maxChannels = maxChannels;
}
 
inline
void TileEMScale::setMaxGains(unsigned int maxGains) {
  m_maxGains = maxGains;
}
 
inline
unsigned int TileEMScale::getCacheIndex(unsigned int drawerIdx, unsigned int channel, unsigned int adc) const {
  return m_drawerCacheSize * drawerIdx + m_maxChannels * adc + channel;
}
 
#endif // TILECONDITIONS_TILEEMSCALE_H