RunInfoRead.cc

Go to the documentation of this file.

//#include "CondFormats/Common/interface/TimeConversions.h"
//#include "CondFormats/Common/interface/Time.h"
#include "CondTools/RunInfo/interface/RunInfoRead.h"
#include "CondCore/CondDB/interface/ConnectionPool.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "RelationalAccess/ISessionProxy.h"
#include "RelationalAccess/ITransaction.h"
#include "RelationalAccess/ISchema.h"
#include "RelationalAccess/ITable.h"
#include "RelationalAccess/IQuery.h"
#include "RelationalAccess/ICursor.h"
#include "CoralBase/AttributeList.h"
#include "CoralBase/Attribute.h"
#include "CoralBase/AttributeSpecification.h"
#include "CoralBase/TimeStamp.h"
#include <algorithm>
#include <iostream>
#include <iterator>
#include <memory>
#include <stdexcept>
#include <vector>
#include <cmath>

namespace {
  //const std::string dot(".");
  const std::string quote("\"");
  //const std::string bNOTb(" NOT ");
  const std::string squoted(const std::string& s) { return quote + s + quote; }
  //now strings for the tables and columns to be queried
  const std::string sParameterTable("RUNSESSION_PARAMETER");
  const std::string sDateTable("RUNSESSION_DATE");
  const std::string sStringTable("RUNSESSION_STRING");
  const std::string sIdParameterColumn("ID");
  const std::string sRunNumberParameterColumn("RUNNUMBER");
  const std::string sNameParameterColumn("NAME");
  const std::string sRunSessionParameterIdDataColumn("RUNSESSION_PARAMETER_ID");
  const std::string sValueDataColumn("VALUE");
  const std::string sDCSMagnetTable("CMSFWMAGNET");
  const std::string sDCSMagnetCurrentColumn("CURRENT");
  const std::string sDCSMagnetChangeDateColumn("CHANGE_DATE");
}  // namespace

RunInfoRead::RunInfoRead(const std::string& connectionString, const edm::ParameterSet& connectionPset)
    : m_connectionString(connectionString), m_connectionPset(connectionPset) {}

RunInfoRead::~RunInfoRead() {}

RunInfo RunInfoRead::readData(const std::string& runinfo_schema, const std::string& dcsenv_schema, const int r_number) {
  RunInfo temp_sum;
  //for B currents...
  bool Bnotchanged = false;
  //from TimeConversions.h
  const boost::posix_time::ptime time0 = boost::posix_time::from_time_t(0);
  //if cursor is null setting null values
  temp_sum.m_run = r_number;
  edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: Initialising Connection Pool" << std::endl;
  cond::persistency::ConnectionPool connection;
  connection.setParameters(m_connectionPset);
  connection.configure();
  edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: Initialising read-only session to "
                                << m_connectionString << std::endl;
  std::shared_ptr<coral::ISessionProxy> session = connection.createCoralSession(m_connectionString, false);
  try {
    session->transaction().start(true);
    coral::ISchema& schema = session->schema(runinfo_schema);
    edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: Accessing schema " << runinfo_schema
                                  << std::endl;
    //new query to obtain the start_time
    std::unique_ptr<coral::IQuery> query(schema.newQuery());
    query->addToTableList(sParameterTable);
    query->addToTableList(sDateTable);
    query->addToOutputList(sValueDataColumn);
    coral::AttributeList runTimeDataOutput;
    runTimeDataOutput.extend<coral::TimeStamp>(sValueDataColumn);
    query->defineOutput(runTimeDataOutput);
    std::string runStartWhereClause(sRunNumberParameterColumn + std::string("=:n_run AND ") + sNameParameterColumn +
                                    std::string("='CMS.LVL0:START_TIME_T' AND ") + sIdParameterColumn +
                                    std::string("=") + sRunSessionParameterIdDataColumn);
    coral::AttributeList runNumberBindVariableList;
    runNumberBindVariableList.extend<int>("n_run");
    runNumberBindVariableList["n_run"].data<int>() = r_number;
    query->setCondition(runStartWhereClause, runNumberBindVariableList);
    coral::ICursor& runStartCursor = query->execute();
    coral::TimeStamp start;  //now all times are UTC!
    if (runStartCursor.next()) {
      std::ostringstream osstartdebug;
      runStartCursor.currentRow().toOutputStream(osstartdebug);
      LogDebug("RunInfoReader") << osstartdebug.str() << std::endl;
      const coral::AttributeList& row = runStartCursor.currentRow();
      start = row[sValueDataColumn].data<coral::TimeStamp>();
      LogDebug("RunInfoReader") << "UTC start time extracted == "
                                << "-->year " << start.year() << "-- month " << start.month() << "-- day "
                                << start.day() << "-- hour " << start.hour() << "-- minute " << start.minute()
                                << "-- second " << start.second() << "-- nanosecond " << start.nanosecond()
                                << std::endl;
      boost::posix_time::ptime start_ptime = start.time();
      boost::posix_time::time_duration startTimeFromEpoch = start_ptime - time0;
      temp_sum.m_start_time_str = boost::posix_time::to_iso_extended_string(start_ptime);
      temp_sum.m_start_time_ll = startTimeFromEpoch.total_microseconds();
      std::ostringstream osstart;
      osstart << "[RunInfoRead::" << __func__ << "]: Timestamp for start of run " << r_number << std::endl
              << "Posix time: " << start_ptime << std::endl
              << "ISO string: " << temp_sum.m_start_time_str << std::endl
              << "Microsecond since Epoch (UTC): " << temp_sum.m_start_time_ll;
      edm::LogInfo("RunInfoReader") << osstart.str() << std::endl;
    } else {
      std::stringstream errMsg;
      errMsg << "[RunInfoRead::" << __func__ << "]: run " << r_number << " start time not found.";
      throw std::runtime_error(errMsg.str());
    }

    //new query to obtain the stop_time
    query.reset(schema.newQuery());
    query->addToTableList(sParameterTable);
    query->addToTableList(sDateTable);
    query->addToOutputList(sValueDataColumn);
    query->defineOutput(runTimeDataOutput);
    std::string runStopWhereClause(sRunNumberParameterColumn + std::string("=:n_run AND ") + sNameParameterColumn +
                                   std::string("='CMS.LVL0:STOP_TIME_T' AND ") + sIdParameterColumn + std::string("=") +
                                   sRunSessionParameterIdDataColumn);
    query->setCondition(runStopWhereClause, runNumberBindVariableList);
    coral::ICursor& runStopCursor = query->execute();
    coral::TimeStamp stop;
    if (runStopCursor.next()) {
      std::ostringstream osstopdebug;
      runStopCursor.currentRow().toOutputStream(osstopdebug);
      LogDebug("RunInfoReader") << osstopdebug.str() << std::endl;
      const coral::AttributeList& row = runStopCursor.currentRow();
      stop = row[sValueDataColumn].data<coral::TimeStamp>();
      LogDebug("RunInfoReader") << "stop time extracted == "
                                << "-->year " << stop.year() << "-- month " << stop.month() << "-- day " << stop.day()
                                << "-- hour " << stop.hour() << "-- minute " << stop.minute() << "-- second "
                                << stop.second() << "-- nanosecond " << stop.nanosecond() << std::endl;
      boost::posix_time::ptime stop_ptime = stop.time();
      boost::posix_time::time_duration stopTimeFromEpoch = stop_ptime - time0;
      temp_sum.m_stop_time_str = boost::posix_time::to_iso_extended_string(stop_ptime);
      temp_sum.m_stop_time_ll = stopTimeFromEpoch.total_microseconds();
      std::ostringstream osstop;
      osstop << "[RunInfoRead::" << __func__ << "]: Timestamp for stop of run " << r_number << std::endl
             << "Posix time: " << stop_ptime << std::endl
             << "ISO string: " << temp_sum.m_stop_time_str << std::endl
             << "Microsecond since Epoch (UTC): " << temp_sum.m_stop_time_ll;
      edm::LogInfo("RunInfoReader") << osstop.str() << std::endl;
    } else {
      edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: run " << r_number << " stop time not found."
                                    << std::endl;
      temp_sum.m_stop_time_str = "null";
      temp_sum.m_stop_time_ll = -1;
    }

    //new query for obtaining the list of FEDs included in the run
    query.reset(schema.newQuery());
    query->addToTableList(sParameterTable);
    query->addToTableList(sStringTable);
    query->addToOutputList(sValueDataColumn);
    query->defineOutputType(sValueDataColumn, "string");
    std::string fedWhereClause(sRunNumberParameterColumn + std::string("=:n_run AND ") + sNameParameterColumn +
                               std::string("='CMS.LVL0:FED_ENABLE_MASK' AND ") + sIdParameterColumn + std::string("=") +
                               sRunSessionParameterIdDataColumn);
    query->setCondition(fedWhereClause, runNumberBindVariableList);
    coral::ICursor& fedCursor = query->execute();
    std::string fed;
    if (fedCursor.next()) {
      std::ostringstream osfeddebug;
      fedCursor.currentRow().toOutputStream(osfeddebug);
      LogDebug("RunInfoReader") << osfeddebug.str() << std::endl;
      const coral::AttributeList& row = fedCursor.currentRow();
      fed = row[sValueDataColumn].data<std::string>();
    } else {
      edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: run " << r_number << "has no FED included."
                                    << std::endl;
      fed = "null";
    }
    std::replace(fed.begin(), fed.end(), '%', ' ');
    std::stringstream stream(fed);
    for (;;) {
      std::string word;
      if (!(stream >> word)) {
        break;
      }
      std::replace(word.begin(), word.end(), '&', ' ');
      std::stringstream ss(word);
      int fedNumber;
      int val;
      ss >> fedNumber >> val;
      LogDebug("RunInfoReader") << "FED: " << fedNumber << " --> value: " << val << std::endl;
      //val bit 0 represents the status of the SLINK, but 5 and 7 means the SLINK/TTS is ON but NA or BROKEN (see mail of alex....)
      if ((val & 0001) == 1 && (val != 5) && (val != 7))
        temp_sum.m_fed_in.push_back(fedNumber);
    }
    std::ostringstream osfed;
    osfed << "[RunInfoRead::" << __func__ << "]: feds included in run " << r_number << ": ";
    std::copy(temp_sum.m_fed_in.begin(), temp_sum.m_fed_in.end(), std::ostream_iterator<int>(osfed, ", "));
    edm::LogInfo("RunInfoReader") << osfed.str() << std::endl;

    //we connect now to the DCS schema in order to retrieve the magnet current
    edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: Accessing schema " << dcsenv_schema
                                  << std::endl;
    coral::ISchema& schema2 = session->schema(dcsenv_schema);
    query.reset(schema2.tableHandle(sDCSMagnetTable).newQuery());
    query->addToOutputList(squoted(sDCSMagnetCurrentColumn), sDCSMagnetCurrentColumn);
    query->addToOutputList(sDCSMagnetChangeDateColumn);
    coral::AttributeList magnetDataOutput;
    magnetDataOutput.extend<float>(sDCSMagnetCurrentColumn);
    magnetDataOutput.extend<coral::TimeStamp>(sDCSMagnetChangeDateColumn);
    query->defineOutput(magnetDataOutput);
    //condition
    coral::AttributeList magnetCurrentBindVariableList;
    float last_current = -1;
    magnetCurrentBindVariableList.extend<coral::TimeStamp>("runstart_time");
    magnetCurrentBindVariableList["runstart_time"].data<coral::TimeStamp>() = start;
    std::string magnetCurrentWhereClause;
    if (temp_sum.m_stop_time_str != "null") {
      edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__
                                    << "]: Accessing the magnet currents measured during run " << r_number
                                    << " between " << temp_sum.m_start_time_str << " and " << temp_sum.m_stop_time_str
                                    << std::endl;
      magnetCurrentBindVariableList.extend<coral::TimeStamp>("runstop_time");
      magnetCurrentBindVariableList["runstop_time"].data<coral::TimeStamp>() = stop;
      magnetCurrentWhereClause = std::string("NOT ") + squoted(sDCSMagnetCurrentColumn) + std::string(" IS NULL AND ") +
                                 sDCSMagnetChangeDateColumn + std::string(">:runstart_time AND ") +
                                 sDCSMagnetChangeDateColumn + std::string("<:runstop_time");
    } else {
      edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__
                                    << "]: Accessing the magnet currents measured before run " << r_number
                                    << "start time " << temp_sum.m_start_time_str << std::endl;
      magnetCurrentWhereClause = std::string("NOT ") + squoted(sDCSMagnetCurrentColumn) + std::string(" IS NULL AND ") +
                                 sDCSMagnetChangeDateColumn + std::string("<:runstart_time");
    }
    query->setCondition(magnetCurrentWhereClause, magnetCurrentBindVariableList);
    query->addToOrderList(sDCSMagnetChangeDateColumn + std::string(" DESC"));
    query->limitReturnedRows(10000);
    coral::ICursor& magnetCurrentCursor = query->execute();
    coral::TimeStamp lastCurrentDate;
    std::string last_date;
    std::vector<double> time_curr;

    bool changeFound = false;
    // first process the changes found within the run boundaries
    while (magnetCurrentCursor.next()) {
      std::ostringstream oscurrentdebug;
      magnetCurrentCursor.currentRow().toOutputStream(oscurrentdebug);
      LogDebug("RunInfoReader") << oscurrentdebug.str() << std::endl;
      const coral::AttributeList& row = magnetCurrentCursor.currentRow();
      lastCurrentDate = row[sDCSMagnetChangeDateColumn].data<coral::TimeStamp>();
      temp_sum.m_current.push_back(row[sDCSMagnetCurrentColumn].data<float>());
      changeFound = true;
      if (temp_sum.m_stop_time_str == "null")
        break;
      LogDebug("RunInfoReader") << "  last current time extracted == "
                                << "-->year " << lastCurrentDate.year() << "-- month " << lastCurrentDate.month()
                                << "-- day " << lastCurrentDate.day() << "-- hour " << lastCurrentDate.hour()
                                << "-- minute " << lastCurrentDate.minute() << "-- second " << lastCurrentDate.second()
                                << "-- nanosecond " << lastCurrentDate.nanosecond() << std::endl;
      boost::posix_time::ptime lastCurrentDate_ptime = lastCurrentDate.time();
      boost::posix_time::time_duration lastCurrentDateTimeFromEpoch = lastCurrentDate_ptime - time0;
      last_date = boost::posix_time::to_iso_extended_string(lastCurrentDate_ptime);
      long long last_date_ll = lastCurrentDateTimeFromEpoch.total_microseconds();
      time_curr.push_back(last_date_ll);
      std::ostringstream ostrans;
      ostrans << "[RunInfoRead::" << __func__ << "]: Transition of the magnet current " << std::endl
              << "New value: " << row[sDCSMagnetCurrentColumn].data<float>() << std::endl
              << "Posix time for the transition timestamp: " << lastCurrentDate_ptime << std::endl
              << "ISO string for the transition timestamp: " << last_date << std::endl
              << "Microseconds since Epoch (UTC) for the transition timestamp: " << last_date_ll;
      edm::LogInfo("RunInfoReader") << ostrans.str() << std::endl;
    }

    // if not change is found within run boundaries, search for the most recent change
    if (!changeFound) {
      // we should deal with stable currents... so the query is returning no value and we should take the last modified current value...
      edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__
                                    << "]: The magnet current did not change during run " << r_number
                                    << ". Looking for the most recent change before " << temp_sum.m_stop_time_str
                                    << std::endl;
      Bnotchanged = true;
      std::unique_ptr<coral::IQuery> lastValueQuery(schema2.tableHandle(sDCSMagnetTable).newQuery());
      lastValueQuery->addToOutputList(squoted(sDCSMagnetCurrentColumn), sDCSMagnetCurrentColumn);
      lastValueQuery->defineOutputType(sDCSMagnetCurrentColumn, "float");
      coral::AttributeList lastValueBindVariableList;
      lastValueBindVariableList.extend<coral::TimeStamp>("runstop_time");
      lastValueBindVariableList["runstop_time"].data<coral::TimeStamp>() = stop;
      std::string lastValueWhereClause(std::string(" NOT ") + squoted(sDCSMagnetCurrentColumn) +
                                       std::string(" IS NULL AND ") + sDCSMagnetChangeDateColumn +
                                       std::string(" <:runstop_time"));
      lastValueQuery->setCondition(lastValueWhereClause, lastValueBindVariableList);
      lastValueQuery->addToOrderList(sDCSMagnetChangeDateColumn + std::string(" DESC"));
      coral::ICursor& lastValueCursor = lastValueQuery->execute();
      if (lastValueCursor.next()) {
        std::ostringstream oslastvaluedebug;
        lastValueCursor.currentRow().toOutputStream(oslastvaluedebug);
        LogDebug("RunInfoReader") << oslastvaluedebug.str() << std::endl;
        const coral::AttributeList& row = lastValueCursor.currentRow();
        last_current = row[sDCSMagnetCurrentColumn].data<float>();
        edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__
                                      << "]: Magnet current of previos run(s), not changed during run " << r_number
                                      << ": " << last_current << std::endl;
      }
      temp_sum.m_avg_current = last_current;
      temp_sum.m_min_current = last_current;
      temp_sum.m_max_current = last_current;
      temp_sum.m_stop_current = last_current;
      temp_sum.m_start_current = last_current;
    }
    size_t csize = temp_sum.m_current.size();
    size_t tsize = time_curr.size();
    edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: size of time: " << tsize
                                  << ", size of currents: " << csize << std::endl;
    if (csize != tsize) {
      edm::LogWarning("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: current and time not filled correctly."
                                       << std::endl;
    }
    if (tsize > 1) {
      temp_sum.m_run_intervall_micros = time_curr.front() - time_curr.back();
    } else {
      temp_sum.m_run_intervall_micros = 0;
    }
    edm::LogInfo("RunInfoReader") << "[RunInfoRead::" << __func__
                                  << "]: Duration in microseconds of the magnet ramp during run " << r_number << ": "
                                  << temp_sum.m_run_intervall_micros << std::endl;

    double wi = 0;
    double sumwixi = 0;
    double sumwi = 0;
    float min = -1;
    float max = -1;

    if (csize != 0) {
      min = temp_sum.m_current.front();
      max = temp_sum.m_current.front();
      for (size_t i = 0; i < csize; ++i) {
        if ((tsize > 1) && (i < csize - 1)) {
          wi = (time_curr[i] - time_curr[i + 1]);
          temp_sum.m_times_of_currents.push_back(wi);
          sumwixi += wi * temp_sum.m_current[i];
          sumwi += wi;
        }
        min = std::min(min, temp_sum.m_current[i]);
        max = std::max(max, temp_sum.m_current[i]);
      }
      std::ostringstream oswi;
      oswi << "[RunInfoRead::" << __func__ << "]: Duration of current values in run " << r_number << ": ";
      std::copy(temp_sum.m_times_of_currents.begin(),
                temp_sum.m_times_of_currents.end(),
                std::ostream_iterator<float>(oswi, ", "));
      edm::LogInfo("RunInfoReader") << oswi.str() << std::endl;
      temp_sum.m_start_current = temp_sum.m_current.back();
      LogDebug("RunInfoReader") << "start current: " << temp_sum.m_start_current << std::endl;
      temp_sum.m_stop_current = temp_sum.m_current.front();
      LogDebug("RunInfoReader") << "stop current: " << temp_sum.m_stop_current << std::endl;
      if (tsize > 1) {
        temp_sum.m_avg_current = sumwixi / sumwi;
      } else {
        temp_sum.m_avg_current = temp_sum.m_start_current;
      }
      LogDebug("RunInfoReader") << "average current: " << temp_sum.m_avg_current << std::endl;
      temp_sum.m_max_current = max;
      LogDebug("RunInfoReader") << "maximum current: " << temp_sum.m_max_current << std::endl;
      temp_sum.m_min_current = min;
      LogDebug("RunInfoReader") << "minimum current: " << temp_sum.m_min_current << std::endl;
    } else {
      if (!Bnotchanged) {
        edm::LogWarning("RunInfoReader") << "Inserting fake values for magnet current." << std::endl;
        temp_sum.m_avg_current = -1;
        temp_sum.m_min_current = -1;
        temp_sum.m_max_current = -1;
        temp_sum.m_stop_current = -1;
        temp_sum.m_start_current = -1;
      }
    }
    std::ostringstream oscurr;
    oscurr << "[RunInfoRead::" << __func__ << "]: Values of currents for run " << r_number << std::endl;
    oscurr << "Average current (A): " << temp_sum.m_avg_current << std::endl;
    oscurr << "Minimum current (A): " << temp_sum.m_min_current << std::endl;
    oscurr << "Maximum current (A): " << temp_sum.m_max_current << std::endl;
    oscurr << "Current at run stop (A): " << temp_sum.m_stop_current << std::endl;
    oscurr << "Current at run start (A): " << temp_sum.m_start_current;
    edm::LogInfo("RunInfoReader") << oscurr.str() << std::endl;

    session->transaction().commit();
  } catch (const std::exception& e) {
    throw cms::Exception("RunInfoReader") << "[RunInfoRead::" << __func__ << "]: "
                                          << "Unable to create a RunInfo payload. Original Exception:\n"
                                          << e.what() << std::endl;
  }

  return temp_sum;
}