DaqScopeModeAnalysis.cc

Go to the documentation of this file.

#include "CondFormats/SiStripObjects/interface/DaqScopeModeAnalysis.h"
#include "DataFormats/SiStripCommon/interface/SiStripHistoTitle.h"
#include "DataFormats/SiStripCommon/interface/SiStripEnumsAndStrings.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include <iostream>
#include <iomanip>
#include <cmath>

using namespace sistrip;

const float DaqScopeModeAnalysis::tickMarkHeightThreshold_ = 50.;      // [ADC]
const float DaqScopeModeAnalysis::frameFindingThreshold_ = (2. / 3.);  // fraction of tick mark height

// ----------------------------------------------------------------------------
//
DaqScopeModeAnalysis::DaqScopeModeAnalysis(const uint32_t& key)
    : CommissioningAnalysis(key, "DaqScopeModeAnalysis"),
      height_(1. * sistrip::invalid_),
      base_(1. * sistrip::invalid_),
      peak_(1. * sistrip::invalid_),
      peds_(2, VFloat(128, sistrip::invalid_)),
      noise_(2, VFloat(128, sistrip::invalid_)),
      raw_(2, VFloat(128, sistrip::invalid_)),
      dead_(2, VInt(0, sistrip::invalid_)),
      noisy_(2, VInt(0, sistrip::invalid_)),
      pedsMean_(2, sistrip::invalid_),
      pedsSpread_(2, sistrip::invalid_),
      noiseMean_(2, sistrip::invalid_),
      noiseSpread_(2, sistrip::invalid_),
      rawMean_(2, sistrip::invalid_),
      rawSpread_(2, sistrip::invalid_),
      pedsMax_(2, sistrip::invalid_),
      pedsMin_(2, sistrip::invalid_),
      noiseMax_(2, sistrip::invalid_),
      noiseMin_(2, sistrip::invalid_),
      rawMax_(2, sistrip::invalid_),
      rawMin_(2, sistrip::invalid_) {
  dead_[0].reserve(256);
  dead_[1].reserve(256);
  noisy_[0].reserve(256);
  noisy_[1].reserve(256);
}

// ----------------------------------------------------------------------------
//
DaqScopeModeAnalysis::DaqScopeModeAnalysis()
    : CommissioningAnalysis("DaqScopeModeAnalysis"),
      height_(1. * sistrip::invalid_),
      base_(1. * sistrip::invalid_),
      peak_(1. * sistrip::invalid_),
      peds_(2, VFloat(128, sistrip::invalid_)),
      noise_(2, VFloat(128, sistrip::invalid_)),
      raw_(2, VFloat(128, sistrip::invalid_)),
      dead_(2, VInt(0, sistrip::invalid_)),
      noisy_(2, VInt(0, sistrip::invalid_)),
      pedsMean_(2, sistrip::invalid_),
      pedsSpread_(2, sistrip::invalid_),
      noiseMean_(2, sistrip::invalid_),
      noiseSpread_(2, sistrip::invalid_),
      rawMean_(2, sistrip::invalid_),
      rawSpread_(2, sistrip::invalid_),
      pedsMax_(2, sistrip::invalid_),
      pedsMin_(2, sistrip::invalid_),
      noiseMax_(2, sistrip::invalid_),
      noiseMin_(2, sistrip::invalid_),
      rawMax_(2, sistrip::invalid_),
      rawMin_(2, sistrip::invalid_) {
  dead_[0].reserve(256);
  dead_[1].reserve(256);
  noisy_[0].reserve(256);
  noisy_[1].reserve(256);
}

// ----------------------------------------------------------------------------
//
void DaqScopeModeAnalysis::reset() {
  height_ = 1. * sistrip::invalid_;
  base_ = 1. * sistrip::invalid_;
  peak_ = 1. * sistrip::invalid_;

  peds_ = VVFloat(2, VFloat(128, sistrip::invalid_));
  noise_ = VVFloat(2, VFloat(128, sistrip::invalid_));
  raw_ = VVFloat(2, VFloat(128, sistrip::invalid_));
  dead_ = VVInt(2, VInt(0, sistrip::invalid_));
  noisy_ = VVInt(2, VInt(0, sistrip::invalid_));
  pedsMean_ = VFloat(2, sistrip::invalid_);
  pedsSpread_ = VFloat(2, sistrip::invalid_);
  noiseMean_ = VFloat(2, sistrip::invalid_);
  noiseSpread_ = VFloat(2, sistrip::invalid_);
  rawMean_ = VFloat(2, sistrip::invalid_);
  rawSpread_ = VFloat(2, sistrip::invalid_);
  pedsMax_ = VFloat(2, sistrip::invalid_);
  pedsMin_ = VFloat(2, sistrip::invalid_);
  noiseMax_ = VFloat(2, sistrip::invalid_);
  noiseMin_ = VFloat(2, sistrip::invalid_);
  rawMax_ = VFloat(2, sistrip::invalid_);
  rawMin_ = VFloat(2, sistrip::invalid_);
  dead_[0].reserve(256);
  dead_[1].reserve(256);
  noisy_[0].reserve(256);
  noisy_[1].reserve(256);
}

// ----------------------------------------------------------------------------
//
uint16_t DaqScopeModeAnalysis::frameFindingThreshold() const {
  if ((getErrorCodes().empty() || getErrorCodes()[0] == "TickMarkRecovered") && base_ < sistrip::valid_ &&
      peak_ < sistrip::valid_ && height_ < sistrip::valid_ && height_ > tickMarkHeightThreshold_) {
    return ((static_cast<uint16_t>(base_ + height_ * DaqScopeModeAnalysis::frameFindingThreshold_) / 32) * 32);
  } else {
    return sistrip::invalid_;
  }
}

// ----------------------------------------------------------------------------
//
bool DaqScopeModeAnalysis::foundTickMark() const {
  return ((getErrorCodes().empty() || getErrorCodes()[0] == "TickMarkRecovered") && base_ < sistrip::valid_ &&
          peak_ < sistrip::valid_ && height_ < sistrip::valid_ && frameFindingThreshold() < sistrip::valid_);
}

// ----------------------------------------------------------------------------
//
bool DaqScopeModeAnalysis::isValid() const {
  return (getErrorCodes().empty() && base_ < sistrip::valid_ && peak_ < sistrip::valid_ && height_ < sistrip::valid_ &&
          frameFindingThreshold() < sistrip::valid_ && pedsMean_[0] < sistrip::maximum_ &&
          pedsMean_[1] < sistrip::maximum_ && pedsSpread_[0] < sistrip::maximum_ &&
          pedsSpread_[1] < sistrip::maximum_ && noiseMean_[0] < sistrip::maximum_ &&
          noiseMean_[1] < sistrip::maximum_ && noiseSpread_[0] < sistrip::maximum_ &&
          noiseSpread_[1] < sistrip::maximum_ && rawMean_[0] < sistrip::maximum_ && rawMean_[1] < sistrip::maximum_ &&
          rawSpread_[0] < sistrip::maximum_ && rawSpread_[1] < sistrip::maximum_ && pedsMax_[0] < sistrip::maximum_ &&
          pedsMax_[1] < sistrip::maximum_ && pedsMin_[0] < sistrip::maximum_ && pedsMin_[1] < sistrip::maximum_ &&
          noiseMax_[0] < sistrip::maximum_ && noiseMax_[1] < sistrip::maximum_ && noiseMin_[0] < sistrip::maximum_ &&
          noiseMin_[1] < sistrip::maximum_ && rawMax_[0] < sistrip::maximum_ && rawMax_[1] < sistrip::maximum_ &&
          rawMin_[0] < sistrip::maximum_ && rawMin_[1] < sistrip::maximum_);
}

// ----------------------------------------------------------------------------
//
void DaqScopeModeAnalysis::print(std::stringstream& ss, uint32_t iapv) {
  if (iapv == 1 || iapv == 2) {
    iapv--;
  } else {
    iapv = 0;
  }

  header(ss);
  ss << std::fixed << std::setprecision(2) << " Tick mark bottom (baseline)       [ADC] : " << base_ << std::endl
     << " Tick mark top                     [ADC] : " << peak_ << std::endl
     << " Tick mark height                  [ADC] : " << height_ << std::endl
     << " Frame finding threshold           [ADC] : " << frameFindingThreshold() << std::endl
     << std::boolalpha << " Tick mark found                         : " << foundTickMark() << std::endl
     << " isValid                                 : " << isValid() << std::endl;

  if (peds_[iapv].size() < 128 || noise_[iapv].size() < 128 || raw_[iapv].size() < 128) {
    edm::LogWarning(mlCommissioning_) << "[" << myName() << "::" << __func__ << "]"
                                      << " Unexpected number of pedestal/noise values: " << peds_[iapv].size() << ", "
                                      << noise_[iapv].size() << ", " << raw_[iapv].size();
    return;
  }

  ss << " Monitorables for APV number     : " << iapv;
  if (iapv == 0) {
    ss << " (first of pair)";
  } else if (iapv == 1) {
    ss << " (second of pair)";
  }
  ss << std::endl;
  ss << std::fixed << std::setprecision(2);
  ss << " Example peds/noise for strips   : "
     << "     0,     31,     63,    127" << std::endl
     << "  Peds                     [ADC] : " << std::setw(6) << peds_[iapv][0] << ", " << std::setw(6)
     << peds_[iapv][31] << ", " << std::setw(6) << peds_[iapv][63] << ", " << std::setw(6) << peds_[iapv][127]
     << std::endl
     << "  Noise                    [ADC] : " << std::setw(6) << noise_[iapv][0] << ", " << std::setw(6)
     << noise_[iapv][31] << ", " << std::setw(6) << noise_[iapv][63] << ", " << std::setw(6) << noise_[iapv][127]
     << std::endl
     << "  Raw noise                [ADC] : " << std::setw(6) << raw_[iapv][0] << ", " << std::setw(6) << raw_[iapv][31]
     << ", " << std::setw(6) << raw_[iapv][63] << ", " << std::setw(6) << raw_[iapv][127] << std::endl
     << " Dead strips (<5s)       [strip] : (" << dead_[iapv].size() << " in total) ";
  for (uint16_t ii = 0; ii < dead_[iapv].size(); ii++) {
    ss << dead_[iapv][ii] << " ";
  }

  ss << std::endl;
  ss << " Noisy strips (>5s)      [strip] : (" << noisy_[iapv].size() << " in total) ";
  for (uint16_t ii = 0; ii < noisy_[iapv].size(); ii++) {
    ss << noisy_[iapv][ii] << " ";
  }
  ss << std::endl;
  ss << " Mean peds +/- spread      [ADC] : " << pedsMean_[iapv] << " +/- " << pedsSpread_[iapv] << std::endl
     << " Min/Max pedestal          [ADC] : " << pedsMin_[iapv] << " <-> " << pedsMax_[iapv] << std::endl
     << " Mean noise +/- spread     [ADC] : " << noiseMean_[iapv] << " +/- " << noiseSpread_[iapv] << std::endl
     << " Min/Max noise             [ADC] : " << noiseMin_[iapv] << " <-> " << noiseMax_[iapv] << std::endl
     << " Mean raw noise +/- spread [ADC] : " << rawMean_[iapv] << " +/- " << rawSpread_[iapv] << std::endl
     << " Min/Max raw noise         [ADC] : " << rawMin_[iapv] << " <-> " << rawMax_[iapv] << std::endl
     << " Normalised noise                : "
     << "(yet to be implemented...)" << std::endl
     << std::boolalpha << " isValid                         : " << isValid() << std::endl
     << std::noboolalpha << " Error codes (found " << std::setw(2) << std::setfill(' ') << getErrorCodes().size()
     << ")          : ";
  if (getErrorCodes().empty()) {
    ss << "(none)";
  } else {
    VString::const_iterator istr = getErrorCodes().begin();
    VString::const_iterator jstr = getErrorCodes().end();
    for (; istr != jstr; ++istr) {
      ss << *istr << " ";
    }
  }
  ss << std::endl;
}

// ----------------------------------------------------------------------------
//
void DaqScopeModeAnalysis::summary(std::stringstream& ss) const {
  SiStripFecKey fec_key(fecKey());
  SiStripFedKey fed_key(fedKey());

  sistrip::RunType type = SiStripEnumsAndStrings::runType(myName());

  std::stringstream extra1, extra2, extra3, extra4, extra5, extra6;
  extra1 << sistrip::extrainfo::pedestals_;
  extra2 << sistrip::extrainfo::rawNoise_;
  extra3 << sistrip::extrainfo::commonMode_;
  extra4 << sistrip::extrainfo::scopeModeFrame_;
  extra5 << sistrip::extrainfo::scopeModeHeaderLow_;
  extra6 << sistrip::extrainfo::scopeModeHeaderHigh_;

  std::string title1 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         fec_key.lldChan(),
                                         extra1.str())
                           .title();
  std::string title2 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         fec_key.lldChan(),
                                         extra2.str())
                           .title();
  std::string title3 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::APV,
                                         SiStripFecKey::i2cAddr(fec_key.lldChan(), true),
                                         extra3.str())
                           .title();
  std::string title4 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::APV,
                                         SiStripFecKey::i2cAddr(fec_key.lldChan(), false),
                                         extra3.str())
                           .title();

  std::string title5 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         SiStripFecKey::i2cAddr(fec_key.lldChan()),
                                         extra4.str())
                           .title();

  std::string title6 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         SiStripFecKey::i2cAddr(fec_key.lldChan()),
                                         extra5.str())
                           .title();

  std::string title7 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         SiStripFecKey::i2cAddr(fec_key.lldChan()),
                                         extra6.str())
                           .title();

  ss << " Summary"
     << ":" << (isValid() ? "Valid" : "Invalid") << ":" << sistrip::controlView_ << ":" << fec_key.fecCrate() << "/"
     << fec_key.fecSlot() << "/" << fec_key.fecRing() << "/" << fec_key.ccuAddr() << "/" << fec_key.ccuChan() << ":"
     << sistrip::dqmRoot_ << sistrip::dir_ << "Collate" << sistrip::dir_
     << SiStripFecKey(fec_key.fecCrate(), fec_key.fecSlot(), fec_key.fecRing(), fec_key.ccuAddr(), fec_key.ccuChan())
            .path()
     << ":" << title1 << ";" << title2 << ";" << title3 << ";" << title4 << ";" << title5 << ";" << title6 << ";"
     << title7 << std::endl;
}