SiPixelOfflineCalibAnalysisBase.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    SiPixelOfflineCalibAnalysisBase
// Class:      SiPixelOfflineCalibAnalysisBase
//
//
// Original Author:  Evan Klose Friis
//    additions by:  Freya Blekman
//         Created:  Tue Nov  6 17:27:19 CET 2007
//
//

#include "FWCore/Framework/interface/MakerMacros.h"

#include "CalibTracker/SiPixelTools/interface/SiPixelOfflineCalibAnalysisBase.h"

#include "Geometry/CommonDetUnit/interface/PixelGeomDetUnit.h"
#include "Geometry/CommonDetUnit/interface/PixelGeomDetType.h"

#include "CondFormats/SiPixelObjects/interface/SiPixelFrameConverter.h"
#include "CondFormats/SiPixelObjects/interface/ElectronicIndex.h"
#include "CondFormats/SiPixelObjects/interface/DetectorIndex.h"
#include "CondFormats/SiPixelObjects/interface/LocalPixel.h"
#include "TList.h"

TF1* SiPixelOfflineCalibAnalysisBase::fitFunction_ = nullptr;
std::vector<short> SiPixelOfflineCalibAnalysisBase::vCalValues_(0);
// constructors and destructor
//
SiPixelOfflineCalibAnalysisBase::SiPixelOfflineCalibAnalysisBase(const edm::ParameterSet& iConfig)
    : runnumbers_(0), eventCounter_(0) {
  siPixelCalibDigiProducer_ = iConfig.getParameter<edm::InputTag>("DetSetVectorSiPixelCalibDigiTag");
  createOutputFile_ = iConfig.getUntrackedParameter<bool>("saveFile", false);
  outputFileName_ = iConfig.getParameter<std::string>("outputFileName");
  daqBE_ = &*edm::Service<DQMStore>();
  folderMaker_ = new SiPixelFolderOrganizer();
  tPixelCalibDigi = consumes<edm::DetSetVector<SiPixelCalibDigi> >(siPixelCalibDigiProducer_);

  calibTokenBeginRun_ =
      esConsumes<SiPixelCalibConfiguration, SiPixelCalibConfigurationRcd, edm::Transition::BeginRun>();
  calibToken_ = esConsumes<SiPixelCalibConfiguration, SiPixelCalibConfigurationRcd>();
  trackerGeomToken_ = esConsumes<TrackerGeometry, TrackerDigiGeometryRecord>();
  cablingMapToken_ = esConsumes<SiPixelFedCablingMap, SiPixelFedCablingMapRcd>();
}

SiPixelOfflineCalibAnalysisBase::SiPixelOfflineCalibAnalysisBase() {
  throw cms::Exception("") << "ERROR: Classes derived from SiPixelOfflineCalibAnalysisBase must call "
                              "SiPixelOfflineCalibAnalysisBase::SiPixelOfflineCalibAnalysisBase(const "
                              "edm::ParameterSet& iConfig) from their constructor."
                           << std::endl;
}

SiPixelOfflineCalibAnalysisBase::~SiPixelOfflineCalibAnalysisBase() {}

//
// member functions
//

// ------------ method called to for each event  ------------
void SiPixelOfflineCalibAnalysisBase::analyze(const edm::Event& iEvent, const edm::EventSetup& iSetup) {
  using namespace edm;

  calib_ = iSetup.getHandle(calibToken_);
  geom_ = iSetup.getHandle(trackerGeomToken_);
  theCablingMap_ = iSetup.getHandle(cablingMapToken_);
  if (eventCounter_ == 0)
    this->calibrationSetup(iSetup);
  eventCounter_++;

  // check first if you're analyzing the right type of calibration
  if (!checkCorrectCalibrationType())
    return;

  uint32_t runnumber = iEvent.id().run();
  if (runnumbers_.empty())
    runnumbers_.push_back(runnumber);
  else {
    bool foundnumber = false;
    for (size_t iter = 0; iter < runnumbers_.size() && !foundnumber; ++iter) {
      if (runnumbers_[iter] == runnumber) {
        foundnumber = true;
        continue;
      }
    }
    if (!foundnumber)
      runnumbers_.push_back(runnumber);
  }

  Handle<DetSetVector<SiPixelCalibDigi> > thePlaquettes;
  iEvent.getByToken(tPixelCalibDigi, thePlaquettes);

  DetSetVector<SiPixelCalibDigi>::const_iterator digiIter;

  //loop over the plaquettes pulsed in this pattern
  for (digiIter = thePlaquettes->begin(); digiIter != thePlaquettes->end(); ++digiIter) {
    uint32_t detId = digiIter->id;
    //check to see if this detID has not been encountered.  If not, run the newDetID (pure virtual) function
    if (detIdsEntered_.find(detId) == detIdsEntered_.end()) {
      detIdsEntered_.insert(std::make_pair(detId, 0));
      detIdNames_.insert(std::make_pair(detId, translateDetIdToString(detId)));
      newDetID(detId);
    }
    DetSet<SiPixelCalibDigi>::const_iterator ipix;
    //loop over pixels pulsed in the current plaquette
    for (ipix = digiIter->data.begin(); ipix != digiIter->end(); ++ipix) {
      //called derived function to fit this curve
      this->doFits(detId, ipix);
    }
  }
}

void SiPixelOfflineCalibAnalysisBase::beginRun(const edm::Run&, const edm::EventSetup& iSetup) {
  //load the calibration information from the database
  edm::ESHandle<SiPixelCalibConfiguration> calib = iSetup.getHandle(calibTokenBeginRun_);

  calibrationMode_ = calib->getCalibrationMode();
  nTriggers_ = calib->getNTriggers();
  vCalValues_ = calib->getVCalValues();
  std::cout << "!!!! in beginRun" << std::endl;
  edm::LogInfo("SiPixelOfflineCalibAnalysisBase")
      << "Calibration file loaded. Mode: " << calibrationMode_ << " nTriggers: " << nTriggers_
      << " Vcal steps: " << vCalValues_.size() << std::endl;
  //call calibrationSetup virtual function
  this->calibrationSetup(iSetup);
  theHistogramIdWorker_ = new SiPixelHistogramId(siPixelCalibDigiProducer_.label());
}

void SiPixelOfflineCalibAnalysisBase::endRun(const edm::Run&, const edm::EventSetup& iSetup) {}

void SiPixelOfflineCalibAnalysisBase::beginJob() {}
// ------------ method called once each job just before starting event loop  ------------

// ------------ method called once each job just after ending the event loop  ------------
void SiPixelOfflineCalibAnalysisBase::endJob() {
  this->calibrationEnd();
  edm::LogInfo("SiPixelOfflineCalibAnalysisBase") << "Running end job... output file name is: " << outputFileName_;
  if (!outputFileName_.empty() && createOutputFile_) {
    edm::LogInfo("SiPixelOfflineCalibAnalysisBase") << "Writing ROOT file to: " << outputFileName_ << std::endl;
    daqBE_->save(outputFileName_);
  }
}

// ------------ helper functions ---------------------------------------------------------

const std::vector<short>* SiPixelOfflineCalibAnalysisBase::getVcalValues() { return &vCalValues_; }

std::string SiPixelOfflineCalibAnalysisBase::translateDetIdToString(uint32_t detid) {
  std::map<uint32_t, std::string>::iterator detNameIter = detIdNames_.find(detid);
  if (detNameIter != detIdNames_.end()) {
    return detNameIter->second;
  }
  std::string output = "DetID translation error";
  DetId detId(detid);
  uint32_t detSubId = detId.subdetId();
  if (detSubId > 2 || detSubId < 1) {
    edm::LogError("SiPixelOfflineCalibAnalysisBase")
        << "ERROR: Expected a pixel detector ID (1 - barrel, 2 - forward) but got " << detSubId << std::endl;
    return output;
  }
  if (detSubId == 2)  //FPIX
  {
    PixelEndcapName nameworker(detid);
    output = nameworker.name();
  } else  //BPIX
  {
    PixelBarrelName nameworker(detid);
    output = nameworker.name();
  }
  detIdNames_.insert(std::make_pair(detid, output));
  return output;
}

SiPixelOfflineCalibAnalysisBase::MonitorElement* SiPixelOfflineCalibAnalysisBase::bookDQMHistogram1D(
    uint32_t detid, std::string name, std::string title, int nchX, double lowX, double highX) {
  std::string hid = theHistogramIdWorker_->setHistoId(name, detid);
  return daqBE_->book1D(hid, title, nchX, lowX, highX);
}

SiPixelOfflineCalibAnalysisBase::MonitorElement* SiPixelOfflineCalibAnalysisBase::bookDQMHistogram1D(
    uint32_t detid, std::string name, std::string title, int nchX, float* xbinsize) {
  std::string hid = theHistogramIdWorker_->setHistoId(name, detid);
  return daqBE_->book1D(hid, title, nchX, xbinsize);
}

SiPixelOfflineCalibAnalysisBase::MonitorElement* SiPixelOfflineCalibAnalysisBase::bookDQMHistogram2D(uint32_t detid,
                                                                                                     std::string name,
                                                                                                     std::string title,
                                                                                                     int nchX,
                                                                                                     double lowX,
                                                                                                     double highX,
                                                                                                     int nchY,
                                                                                                     double lowY,
                                                                                                     double highY) {
  std::string hid = theHistogramIdWorker_->setHistoId(name, detid);
  return daqBE_->book2D(hid, title, nchX, lowX, highX, nchY, lowY, highY);
}

SiPixelOfflineCalibAnalysisBase::MonitorElement* SiPixelOfflineCalibAnalysisBase::bookDQMHistoPlaquetteSummary2D(
    uint32_t detid, std::string name, std::string title) {
  DetId detId(detid);
  const TrackerGeometry& theTracker(*geom_);
  const PixelGeomDetUnit* theGeomDet = dynamic_cast<const PixelGeomDetUnit*>(theTracker.idToDet(detId));
  int maxcol = theGeomDet->specificTopology().ncolumns();
  int maxrow = theGeomDet->specificTopology().nrows();

  std::string hid = theHistogramIdWorker_->setHistoId(name, detid);
  return daqBE_->book2D(hid, title, maxcol, 0, maxcol, maxrow, 0, maxrow);
}

bool SiPixelOfflineCalibAnalysisBase::setDQMDirectory(std::string dirName) {
  daqBE_->setCurrentFolder(dirName);
  return daqBE_->dirExists(dirName);
}

bool SiPixelOfflineCalibAnalysisBase::setDQMDirectory(uint32_t detID) {
  return folderMaker_->setModuleFolder(detID, 0);
}

// ------------ virtual functions ------------------------------------------------
bool SiPixelOfflineCalibAnalysisBase::checkCorrectCalibrationType() { return true; }

bool SiPixelOfflineCalibAnalysisBase::doFits(uint32_t detid, std::vector<SiPixelCalibDigi>::const_iterator ipix) {
  short row = ipix->row();
  short col = ipix->col();
  std::vector<uint8_t> nentries = ipix->getnentries();
  std::vector<uint32_t> sum = ipix->getsum();
  std::vector<uint32_t> sumquares = ipix->getsumsquares();
  //do nothing
  //return false;
  //
  //DEBUG
  std::cout << "Row: " << row << "   Col: " << col << std::endl;
  for (unsigned int i = 0; i < sum.size(); i++) {
    std::cout << sum[i] << "  ";
  }
  std::cout << std::endl;
  return false;
}

void SiPixelOfflineCalibAnalysisBase::calibrationSetup(const edm::EventSetup&) {
  //do nothing
}

void SiPixelOfflineCalibAnalysisBase::calibrationEnd() {
  // do nothing
}
void SiPixelOfflineCalibAnalysisBase::newDetID(uint32_t detid) {
  //do nothing
  edm::LogInfo("SiPixelOfflineCalibAnalysisBase")
      << "SiPixelOfflineCalibAnalysisBase - Found new DetID: " << detid << "  Name: " << detIdNames_[detid];
}

bool SiPixelOfflineCalibAnalysisBase::checkPixel(uint32_t detid, short row, short col) {
  // finds the fed ID:
  int thefedid = -1;
  for (int fedid = 0; fedid <= 40 && thefedid == -1; ++fedid) {
    SiPixelFrameConverter converter(theCablingMap_.product(), fedid);
    if (converter.hasDetUnit(detid)) {
      thefedid = fedid;
    }
  }
  if (thefedid == -1)
    return false;  // fed ID not associated with det ID. No pattern check possible

  SiPixelFrameConverter formatter(theCablingMap_.product(), thefedid);
  sipixelobjects::DetectorIndex detector = {detid, row, col};
  sipixelobjects::ElectronicIndex cabling;

  formatter.toCabling(cabling, detector);
  // cabling should now contain cabling.roc and cabling.dcol  and cabling.pxid

  // however, the coordinates now need to be converted from dcl, pxid to the row,col coordinates used in the calibration info
  sipixelobjects::LocalPixel::DcolPxid loc;
  loc.dcol = cabling.dcol;
  loc.pxid = cabling.pxid;
  sipixelobjects::LocalPixel locpixel(loc);
  short localrow = locpixel.rocRow();
  short localcol = locpixel.rocCol();

  // now get the patterns from the calib object:
  std::vector<short> calibcols = calib_->getColumnPattern();
  std::vector<short> calibrows = calib_->getRowPattern();
  // first check rows:
  for (size_t irow = 0; irow < calibrows.size(); ++irow) {
    if (calibrows[irow] == localrow) {
      // check the columns
      for (size_t icol = 0; icol < calibcols.size(); ++icol) {
        if (calibcols[icol] == localcol)
          return true;
      }
    }
  }

  return false;
}

// function to add tf1's to ME's:
void SiPixelOfflineCalibAnalysisBase::addTF1ToDQMMonitoringElement(MonitorElement* ele, TF1* func) {
  if (func) {
    ele->getTH1()->GetListOfFunctions()->Add(func);
  }
  return;
}