PixelDetectorConfig.cc

Go to the documentation of this file.

//
// Implementation of the detector configuration
//
//
//
//

#include "CalibFormats/SiPixelObjects/interface/PixelDetectorConfig.h"
#include "CalibFormats/SiPixelObjects/interface/PixelTimeFormatter.h"
#include <fstream>
#include <iostream>
#include <sstream>
#include <ios>
#include <stdexcept>
#include <cassert>
#include <cstdio>

using namespace std;
using namespace pos;

PixelDetectorConfig::PixelDetectorConfig(std::vector<std::vector<std::string> > &tableMat)
    : PixelConfigBase("", "", "") {
  std::string mthn = "]\t[PixelDetectorConfig::PixelDetectorConfig()]\t\t    ";
  std::vector<std::string> ins = tableMat[0];
  std::map<std::string, int> colM;
  std::vector<std::string> colNames;
  /*
    EXTENSION_TABLE_NAME: PIXEL_DETECTOR_CONFIG (VIEW: CONF_KEY_DET_CONFIG_V)
    
    CONFIG_KEY                    NOT NULL VARCHAR2(80)
    KEY_TYPE                      NOT NULL VARCHAR2(80)
    KEY_ALIAS                     NOT NULL VARCHAR2(80)
    VERSION                        VARCHAR2(40)
    KIND_OF_COND                  NOT NULL VARCHAR2(40)
    ROC_NAME                      NOT NULL VARCHAR2(200)
    ROC_STATUS                    NOT NULL VARCHAR2(200)
  */
  colNames.push_back("CONFIG_KEY");
  colNames.push_back("KEY_TYPE");
  colNames.push_back("KEY_ALIAS");
  colNames.push_back("VERSION");
  colNames.push_back("KIND_OF_COND");
  colNames.push_back("ROC_NAME");
  colNames.push_back("ROC_STATUS");

  for (unsigned int c = 0; c < ins.size(); c++) {
    for (unsigned int n = 0; n < colNames.size(); n++) {
      if (tableMat[0][c] == colNames[n]) {
        colM[colNames[n]] = c;
        break;
      }
    }
  }  //end for

  /*
  for(unsigned int n=0; n<colNames.size(); n++){
    if(colM.find(colNames[n]) == colM.end()){
      std::cerr << __LINE__ << mthn << "Couldn't find in the database the column with name " << colNames[n] << std::endl;
      assert(0);
    }
  }
  */

  modules_.clear();
  rocs_.clear();
  std::string module = "";
  for (unsigned int r = 1; r < tableMat.size(); r++) {  //Goes to every row of the Matrix
    PixelROCName roc(tableMat[r][colM["ROC_NAME"]]);    // see DACSettings!!!!
    PixelROCStatus rocstatus;
    std::string status = tableMat[r][colM["ROC_STATUS"]];
    // The following is due to the fact that enabled ROCs are
    // labelled as ON in the DataBase, but have NO label in
    // configuration files!!!
    if (status.find("on") != string::npos) {
      status = "";
    }
    if (!status.empty()) {
      rocstatus.set(status);
    }
    rocs_[roc] = rocstatus;
    if (!rocstatus.get(PixelROCStatus::noInit)) {
      PixelModuleName module(tableMat[r][colM["ROC_NAME"]]);
      if (!containsModule(module)) {
        modules_.push_back(module);
      }
    }
  }  //end for r

  //   std::cout << __LINE__ << mthn << "Number of Modules in Detector Configuration Class: " << getNModules() << std::endl;

}  //end constructor

//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

PixelDetectorConfig::PixelDetectorConfig(std::string filename) : PixelConfigBase("", "", "") {
  std::string mthn = "[PixelDetectorConfig::PixelDetectorConfig()]\t\t    ";

  if (filename[filename.size() - 1] == 't') {
    std::ifstream in(filename.c_str());

    if (!in.good()) {
      std::cout << __LINE__ << "]\t" << mthn << "Could not open: " << filename << std::endl;
      throw std::runtime_error("Failed to open file " + filename);
    } else {
      std::cout << __LINE__ << "]\t" << mthn << "Opened: " << filename << std::endl;
    }

    if (in.eof()) {
      std::cout << __LINE__ << "]\t" << mthn << "EOF before reading anything!" << std::endl;
      throw std::runtime_error("File seems to be empty " + filename);
    }

    modules_.clear();
    rocs_.clear();

    std::string module;

    in >> module;

    if (module == "Rocs:") {
      std::cout << __LINE__ << "]\t" << mthn << "New format of detconfig" << std::endl;
      //new format with list of ROCs.
      std::string rocname;
      in >> rocname;
      while (!in.eof()) {
        //cout << __LINE__ << "]\t" << mthn << "Read rocname:"<<rocname<<endl;
        PixelROCName roc(rocname);
        std::string line;
        getline(in, line);
        //cout << __LINE__ << "]\t" << mthn << "Read line:'"<<line<<"'"<<endl;
        istringstream instring(line);
        PixelROCStatus rocstatus;
        std::string status;
        while (!instring.eof()) {
          instring >> status;
          //        cout << __LINE__ << "]\t" << mthn << "Read status:"<<status<<endl;
          if (!status.empty()) {
            rocstatus.set(status);
          }
        }
        rocs_[roc] = rocstatus;
        if (!rocstatus.get(PixelROCStatus::noInit)) {
          PixelModuleName module(rocname);
          if (!containsModule(module)) {
            modules_.push_back(module);
          }
        }
        in >> rocname;
      }
      return;
    }

    //std::cout << __LINE__ << "]\t" << mthn << "Read module:"<<module<<std::endl;

    if (in.eof())
      std::cout << mthn << "EOF after reading first module name" << std::endl;

    std::cout << __LINE__ << "]\t" << mthn << "Old format of detconfig" << std::endl;
    while (!in.eof()) {
      //std::cout << __LINE__ << "]\t" << mthn << "Read module:"<<module<<std::endl;

      PixelModuleName moduleName(module);

      modules_.push_back(moduleName);

      in >> module;

      assert(modules_.size() < 10000);
    }

    in.close();

  } else {
    assert(0);

    /*
      std::ifstream in(filename.c_str(),std::ios::binary);

      if (!in.good()){
      std::cout << __LINE__ << "]\t" << mthn << "Could not open:"<<filename<<std::endl;
      assert(0);
      }
      else {
      std::cout << __LINE__ << "]\t" << mthn << "Opened:"<<filename<<std::endl;
      }

      char nchar;

      in.read(&nchar,1);
        
      std::string s1;

      //wrote these lines of code without ref. needs to be fixed
      for(int i=0;i< nchar; i++){
      char c;
      in >>c;
      s1.push_back(c);
      }

      //std::cout << __LINE__ << "]\t" << mthn << "READ ROC name:"<<s1<<std::endl;

      dacsettings_.clear();


      while (!in.eof()){

      //std::cout << __LINE__ << "]\t" << mthn << "read s1:"<<s1<<std::endl;

      PixelROCName rocid(s1);

      //std::cout << __LINE__ << "]\t" << mthn << "read rocid:"<<rocid<<std::endl;
            
      PixelROCDetectorConfig tmp;
      
      tmp.readBinary(in, rocid);

      dacsettings_.push_back(tmp);


      in.read(&nchar,1);

      s1.clear();

      if (in.eof()) continue;

      //wrote these lines of code without ref. needs to be fixed
      for(int i=0;i< nchar; i++){
      char c;
      in >>c;
      s1.push_back(c);
      }


      }

      in.close();

    */
  }

  //std::cout << __LINE__ << "]\t" << mthn << "Read dac settings for "<<dacsettings_.size()<<" ROCs"<<std::endl;
}

unsigned int PixelDetectorConfig::getNModules() const { return modules_.size(); }

PixelModuleName PixelDetectorConfig::getModule(unsigned int i) const { return modules_[i]; }

std::set<unsigned int> PixelDetectorConfig::getFEDs(PixelNameTranslation *translation) const {
  std::set<unsigned int> feds;
  assert(!modules_.empty());
  std::vector<PixelModuleName>::const_iterator imodule = modules_.begin();

  for (; imodule != modules_.end(); ++imodule) {
    std::set<PixelChannel> channelsOnThisModule = translation->getChannelsOnModule(*imodule);
    for (std::set<PixelChannel>::const_iterator channelsOnThisModule_itr = channelsOnThisModule.begin();
         channelsOnThisModule_itr != channelsOnThisModule.end();
         ++channelsOnThisModule_itr) {
      const PixelHdwAddress &channel_hdwaddress = translation->getHdwAddress(*channelsOnThisModule_itr);
      unsigned int fednumber = channel_hdwaddress.fednumber();
      feds.insert(fednumber);
    }
  }

  return feds;
}

// Returns the FED numbers and channels within each FED that are used
std::map<unsigned int, std::set<unsigned int> > PixelDetectorConfig::getFEDsAndChannels(
    PixelNameTranslation *translation) const {
  //      FED Number                channels

  std::map<unsigned int, std::set<unsigned int> > fedsChannels;
  assert(!modules_.empty());
  std::vector<PixelModuleName>::const_iterator imodule = modules_.begin();

  for (; imodule != modules_.end(); ++imodule) {
    std::set<PixelChannel> channelsOnThisModule = translation->getChannelsOnModule(*imodule);
    for (std::set<PixelChannel>::const_iterator channelsOnThisModule_itr = channelsOnThisModule.begin();
         channelsOnThisModule_itr != channelsOnThisModule.end();
         ++channelsOnThisModule_itr) {
      const PixelHdwAddress &channel_hdwaddress = translation->getHdwAddress(*channelsOnThisModule_itr);
      unsigned int fednumber = channel_hdwaddress.fednumber();
      unsigned int fedchannel = channel_hdwaddress.fedchannel();
      fedsChannels[fednumber].insert(fedchannel);
    }
  }

  return fedsChannels;
}

bool PixelDetectorConfig::containsModule(const PixelModuleName &moduleToFind) const {
  for (std::vector<PixelModuleName>::const_iterator modules_itr = modules_.begin(); modules_itr != modules_.end();
       ++modules_itr) {
    if (*modules_itr == moduleToFind)
      return true;
  }
  return false;
}

// modified by MR on 11-01-2008 15:06:51
void PixelDetectorConfig::writeASCII(std::string dir) const {
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::writeASCII()]\t\t    ";
  std::string mthn = s.str();

  if (!dir.empty())
    dir += "/";
  std::string filename = dir + "detectconfig.dat";

  std::ofstream out(filename.c_str(), std::ios_base::out);
  if (!out) {
    std::cout << __LINE__ << "]\t" << mthn << "Could not open file " << filename << " for write" << std::endl;
    exit(1);
  }

  if (rocs_.empty()) {
    std::vector<PixelModuleName>::const_iterator imodule = modules_.begin();

    for (; imodule != modules_.end(); ++imodule) {
      out << *imodule << std::endl;
    }
  } else {
    out << "Rocs:" << endl;
    std::map<PixelROCName, PixelROCStatus>::const_iterator irocs = rocs_.begin();
    for (; irocs != rocs_.end(); ++irocs) {
      out << (irocs->first).rocname() << " " << (irocs->second).statusName() << endl;
    }
  }

  out.close();
}

//=============================================================================================
void PixelDetectorConfig::writeXMLHeader(pos::PixelConfigKey key,
                                         int version,
                                         std::string path,
                                         std::ofstream *outstream,
                                         std::ofstream *out1stream,
                                         std::ofstream *out2stream) const {
  std::string mthn = "]\t[PixelDetectorConfig::writeXMLHeader()]\t\t\t    ";
  std::stringstream fullPath;
  fullPath << path << "/Pixel_DetectorConfig_" << PixelTimeFormatter::getmSecTime() << ".xml";
  cout << __LINE__ << mthn << "Writing to: " << fullPath.str() << endl;

  outstream->open(fullPath.str().c_str());

  if (!outstream->good()) {
    cout << __LINE__ << mthn << "FATAL: could not open file " << fullPath.str() << endl;
    assert(0);
  }

  *outstream << "<?xml version='1.0' encoding='UTF-8' standalone='yes'?>" << std::endl;
  *outstream << "<ROOT xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>" << std::endl;
  *outstream << "" << std::endl;
  *outstream << " <!-- " << mthn << "-->" << std::endl;
  *outstream << "" << std::endl;
  *outstream << " <HEADER>" << std::endl;
  *outstream << "  <TYPE>" << std::endl;
  *outstream << "   <EXTENSION_TABLE_NAME>PIXEL_DETECTOR_CONFIG</EXTENSION_TABLE_NAME>" << std::endl;
  *outstream << "   <NAME>Pixel Detector Configuration</NAME>" << std::endl;
  *outstream << "  </TYPE>" << std::endl;
  *outstream << "  <RUN>" << std::endl;
  *outstream << "   <RUN_TYPE>Pixel Detector Configuration test</RUN_TYPE>" << std::endl;
  *outstream << "   <RUN_NUMBER>1</RUN_NUMBER>" << std::endl;
  *outstream << "   <RUN_BEGIN_TIMESTAMP>" << pos::PixelTimeFormatter::getTime() << "</RUN_BEGIN_TIMESTAMP>"
             << std::endl;
  *outstream << "   <LOCATION>CERN P5</LOCATION>" << std::endl;
  *outstream << "  </RUN>" << std::endl;
  *outstream << " </HEADER>" << std::endl;
  *outstream << "" << std::endl;
  *outstream << "  <DATA_SET>" << std::endl;
  *outstream << " " << std::endl;
  *outstream << "   <VERSION>" << version << "</VERSION>" << std::endl;
  *outstream << "   <COMMENT_DESCRIPTION>" << getComment() << "</COMMENT_DESCRIPTION>" << std::endl;
  *outstream << "   <CREATED_BY_USER>" << getAuthor() << "</CREATED_BY_USER>" << std::endl;
  *outstream << " " << std::endl;
  *outstream << "   <PART>" << std::endl;
  *outstream << "    <NAME_LABEL>CMS-PIXEL-ROOT</NAME_LABEL>" << std::endl;
  *outstream << "    <KIND_OF_PART>Detector ROOT</KIND_OF_PART>" << std::endl;
  *outstream << "   </PART>" << std::endl;
}

//=============================================================================================
void PixelDetectorConfig::writeXML(std::ofstream *outstream,
                                   std::ofstream *out1stream,
                                   std::ofstream *out2stream) const {
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::writeXML()]\t\t\t    ";
  std::string mthn = s.str();
  if (rocs_.empty()) {
    std::vector<PixelModuleName>::const_iterator imodule = modules_.begin();

    // This needs to be fixed: given a module name, actually loop over ROCs to write the XML data
    for (; imodule != modules_.end(); ++imodule) {
      *outstream << "  <DATA>" << std::endl;
      //---->          out << "   <ROC_NAME>" << (irocs->first).rocname() << "</ROC_NAME>"                         << std::endl ;
      *outstream << "   <ROC_STATUS>on</ROC_STATUS>" << std::endl;
      *outstream << "  </DATA>" << std::endl;
      *outstream << " " << std::endl;
    }
  } else {
    std::map<PixelROCName, PixelROCStatus>::const_iterator irocs = rocs_.begin();
    for (; irocs != rocs_.end(); ++irocs) {
      std::string sts = (irocs->second).statusName();
      if (sts.empty()) {
        sts = "on";
      }
      *outstream << " " << std::endl;
      *outstream << "   <DATA>" << std::endl;
      *outstream << "    <ROC_NAME>" << (irocs->first).rocname() << "</ROC_NAME>" << std::endl;
      *outstream << "    <ROC_STATUS>" << sts << "</ROC_STATUS>" << std::endl;
      *outstream << "   </DATA>" << std::endl;
    }
  }
}

//=============================================================================================
void PixelDetectorConfig::writeXMLTrailer(std::ofstream *outstream,
                                          std::ofstream *out1stream,
                                          std::ofstream *out2stream) const {
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::writeXMLTrailer()]\t\t\t    ";
  std::string mthn = s.str();

  *outstream << " " << std::endl;
  *outstream << " </DATA_SET>" << std::endl;
  *outstream << "</ROOT> " << std::endl;

  outstream->close();
}
//=============================================================================================
void PixelDetectorConfig::writeXML(pos::PixelConfigKey key, int version, std::string path) const {
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::writeXML()]\t\t\t    ";
  std::string mthn = s.str();

  std::stringstream fullPath;

  fullPath << path << "/Pixel_DetectorConfig.xml";
  cout << __LINE__ << "]\t" << mthn << "Writing to: " << fullPath.str() << std::endl;

  std::ofstream out(fullPath.str().c_str());

  out << "<?xml version='1.0' encoding='UTF-8' standalone='yes'?>" << std::endl;
  out << "<ROOT xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>" << std::endl;
  out << " <HEADER>" << std::endl;
  out << "  <TYPE>" << std::endl;
  out << "   <EXTENSION_TABLE_NAME>PIXEL_DETECTOR_CONFIG</EXTENSION_TABLE_NAME>" << std::endl;
  out << "   <NAME>Pixel Detector Configuration</NAME>" << std::endl;
  out << "  </TYPE>" << std::endl;
  out << "  <RUN>" << std::endl;
  out << "   <RUN_TYPE>Pixel Detector Configuration test</RUN_TYPE>" << std::endl;
  out << "   <RUN_NUMBER>1</RUN_NUMBER>" << std::endl;
  out << "   <RUN_BEGIN_TIMESTAMP>" << pos::PixelTimeFormatter::getTime() << "</RUN_BEGIN_TIMESTAMP>" << std::endl;
  out << "   <COMMENT_DESCRIPTION>Test of DetectorConfig xml</COMMENT_DESCRIPTION>" << std::endl;
  out << "   <LOCATION>CERN TAC</LOCATION>" << std::endl;
  out << "   <CREATED_BY_USER>Dario Menasce</CREATED_BY_USER>" << std::endl;
  out << "  </RUN>" << std::endl;
  out << " </HEADER>" << std::endl;
  out << "" << std::endl;
  out << "" << std::endl;

  if (rocs_.empty()) {
    std::vector<PixelModuleName>::const_iterator imodule = modules_.begin();

    // This needs to be fixed: given a module name, actually loop over ROCs to write the XML data
    for (; imodule != modules_.end(); ++imodule) {
      out << "  <DATA>" << std::endl;
      //---->          out << "   <ROC_NAME>" << (irocs->first).rocname() << "</ROC_NAME>"                  << std::endl ;
      out << "   <ROC_STATUS>on</ROC_STATUS>" << std::endl;
      out << "  </DATA>" << std::endl;
      out << " " << std::endl;
    }
  } else {
    std::map<PixelROCName, PixelROCStatus>::const_iterator irocs = rocs_.begin();
    for (; irocs != rocs_.end(); ++irocs) {
      std::string sts = (irocs->second).statusName();
      if (sts.empty()) {
        sts = "on";
      }
      out << "  <DATA_SET>" << std::endl;
      out << "   <VERSION>" << version << "</VERSION>" << std::endl;
      out << "    <PART>" << std::endl;
      out << "     <NAME_LABEL>" << (irocs->first).rocname() << "</NAME_LABEL>" << std::endl;
      out << "     <KIND_OF_PART>ROC</KIND_OF_PART>" << std::endl;
      out << "    </PART>" << std::endl;
      out << "   <DATA>" << std::endl;
      out << "    <ROC_NAME>" << (irocs->first).rocname() << "</ROC_NAME>" << std::endl;
      out << "    <ROC_STATUS>" << sts << "</ROC_STATUS>" << std::endl;
      out << "   </DATA>" << std::endl;
      out << "  </DATA_SET>" << std::endl;
      out << " " << std::endl;
    }
  }
  out << " </DATA_SET>" << std::endl;
  out << "</ROOT> " << std::endl;
  out.close();
  assert(0);
}

//=============================================================================================
void PixelDetectorConfig::addROC(PixelROCName &theROC)  // Added by Dario (March 3, 2008)
{
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::addROC()]\t\t\t\t    ";
  std::string mthn = s.str();

  std::map<PixelROCName, PixelROCStatus>::iterator theROCIt = rocs_.find(theROC);
  if (theROCIt == rocs_.end())  // if theROC was not there, add it and turn it on
  {
    PixelROCStatus theStatus;
    theStatus.reset();
    rocs_[theROC] = theStatus;
    //  cout << __LINE__ << "]\t" << mthn << "Non existing ROC (" << theROC.rocname() << "): adding it"  << endl ;
  } else {
    theROCIt->second.reset();  // otherwise just turn it on by resetting it to zero
    //  cout << __LINE__ << "]\t" << mthn << "Already existing ROC (" << theROC.rocname() << "): switching it on"  << endl ;
  }
}

//=============================================================================================
void PixelDetectorConfig::addROC(PixelROCName &theROC, string statusLabel)  // modified by MR on 14-05-2008 11:29:51
{
  std::stringstream s;
  s << __LINE__ << "]\t[PixelDetectorConfig::addROC()]\t\t\t\t    ";
  std::string mthn = s.str();

  std::map<PixelROCName, PixelROCStatus>::iterator theROCIt = rocs_.find(theROC);
  if (theROCIt == rocs_.end())  // if theROC was not there, add it and turn it on
  {
    PixelROCStatus theStatus;
    theStatus.set(statusLabel);
    theStatus.reset();
    rocs_[theROC] = theStatus;
    //  cout << __LINE__ << "]\t" << mthn << "Non existing ROC (" << theROC.rocname() << "): adding it"  << endl ;
  } else {
    theROCIt->second.set(statusLabel);  // otherwise just turn it on by resetting it to zero
    //  cout << __LINE__ << "]\t" << mthn << "Already existing ROC (" << theROC.rocname() << "): switching it on"  << endl ;
  }
}

//=============================================================================================
void PixelDetectorConfig::removeROC(PixelROCName &theROC)  // Added by Dario (March 3, 2008)
{
  std::string mthn = "[PixelDetectorConfig::removeROC()]\t\t\t\t    ";

  std::map<PixelROCName, PixelROCStatus>::iterator theROCIt = rocs_.find(theROC);
  if (theROCIt != rocs_.end())  // if theROC was there remove it, otherwise ignore
  {
    theROCIt->second.set("noInit");
    //  cout << __LINE__ << "]\t" << mthn << "Already existing ROC (" << theROC.rocname() << "): switching it off"  << endl ;
  } else {
    PixelROCStatus theStatus;
    theStatus.set("noInit");
    rocs_[theROC] = theStatus;
    //  cout << __LINE__ << "]\t" << mthn << "ROC " << theROC.rocname() << " was not individually declared in the file: declare and switch off"  << endl ;
  }
}

//std::ostream& operator<<(std::ostream& s, const PixelDetectorConfig& dacs){
//
//  s << dacs.getDetectorConfig(0) <<std::endl;
//
//  return s;
//
//}