SiPixelGainCalibrationOffline.h

Go to the documentation of this file.

#ifndef CondFormats_SiPixelObjects_SiPixelGainCalibrationOffline_h
#define CondFormats_SiPixelObjects_SiPixelGainCalibrationOffline_h
// -*- C++ -*-
//
// Package:    SiPixelObjects
// Class:      SiPixelGainCalibrationOffline
//
//
// Original Author:  Vincenzo Chiochia
//         Modified: Evan Friis
//         Created:  Tue 8 12:31:25 CEST 2007
// $Id: SiPixelGainCalibrationOffline.h,v 1.5 2009/02/10 17:26:50 rougny Exp $
//
//
#include "CondFormats/Serialization/interface/Serializable.h"

#include <vector>
#include <map>
#include <iostream>
#include <cstdint>

class SiPixelGainCalibrationOffline {
public:
  struct DecodingStructure {
    unsigned int datum : 8;
  };

  struct DetRegistry {
    uint32_t detid;
    uint32_t ibegin;
    uint32_t iend;
    int ncols;

    COND_SERIALIZABLE;
  };

  class StrictWeakOrdering {
  public:
    bool operator()(const DetRegistry& p, const uint32_t& i) const { return p.detid < i; }
  };

  typedef std::vector<char>::const_iterator ContainerIterator;
  typedef std::pair<ContainerIterator, ContainerIterator> Range;
  typedef std::vector<DetRegistry> Registry;
  typedef Registry::const_iterator RegistryIterator;

  // Constructors
  SiPixelGainCalibrationOffline();
  SiPixelGainCalibrationOffline(float minPed, float maxPed, float minGain, float maxGain);
  ~SiPixelGainCalibrationOffline() {}

  void initialize() {}

  bool put(const uint32_t& detID, Range input, const int& nCols);
  const Range getRange(const uint32_t& detID) const;
  void getDetIds(std::vector<uint32_t>& DetIds_) const;
  const int getNCols(const uint32_t& detID) const;
  const std::pair<const Range, const int> getRangeAndNCols(const uint32_t& detID) const;

  // Set and get public methods
  void setDataGain(float gain,
                   const int& nRows,
                   std::vector<char>& vped,
                   bool thisColumnIsDead = false,
                   bool thisColumnIsNoisy = false);
  void setDataPedestal(float pedestal,
                       std::vector<char>& vped,
                       bool thisPixelIsDead = false,
                       bool thisPixelIsNoisy = false);

  unsigned int getNumberOfRowsToAverageOver() const { return numberOfRowsToAverageOver_; }
  double getGainLow() const { return minGain_; }
  double getGainHigh() const { return maxGain_; }
  double getPedLow() const { return minPed_; }
  double getPedHigh() const { return maxPed_; }

  // Set dead pixels
  void setDeadPixel(std::vector<char>& vped) { setDataPedestal(0 /*dummy value, not used*/, vped, true); }
  void setDeadColumn(const int& nRows, std::vector<char>& vped) {
    setDataGain(0 /*dummy value, not used*/, nRows, vped, true);
  }

  // Set noisy pixels
  void setNoisyPixel(std::vector<char>& vped) { setDataPedestal(0 /*dummy value, not used*/, vped, false, true); }
  void setNoisyColumn(const int& nRows, std::vector<char>& vped) {
    setDataGain(0 /*dummy value, not used*/, nRows, vped, false, true);
  }

  // these methods SHOULD NEVER BE ACESSED BY THE USER - use the services in CondTools/SiPixel!!!!
  float getPed(const int& col, const int& row, const Range& range, const int& nCols, bool& isDead, bool& isNoisy) const;
  float getGain(const int& col,
                const int& row,
                const Range& range,
                const int& nCols,
                bool& isDeadColumn,
                bool& isNoisyColumn) const;

private:
  float encodeGain(const float& gain);
  float encodePed(const float& ped);
  float decodeGain(unsigned int gain) const;
  float decodePed(unsigned int ped) const;

  std::vector<char> v_pedestals;  //@@@ blob streaming doesn't work with uint16_t and with classes
  std::vector<DetRegistry> indexes;
  float minPed_, maxPed_, minGain_, maxGain_;

  //THIS WILL BE HARDCODED TO 80 (all rows in a ROC) DON'T CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!
  unsigned int numberOfRowsToAverageOver_;

  unsigned int nBinsToUseForEncoding_;
  unsigned int deadFlag_;
  unsigned int noisyFlag_;

  COND_SERIALIZABLE;
};

#endif