DBoxMetadataHelper::DBMetaDataPlotDisplay Class Reference

#include <DropBoxMetaDataPayloadInspectorHelper.h>

Public Member Functions
	DBMetaDataPlotDisplay (DBoxMetadataHelper::recordMap theMap, std::string theTag, std::string theIOV)
void	plotDiffWithMetadata (const DBoxMetadataHelper::recordMap &theRefMap, std::string theRefTag, std::string theRefIOV)
void	plotMetaDatas ()
void	setImageFileName (const std::string &theFileName)
	~DBMetaDataPlotDisplay ()=default

Private Member Functions
std::string	cleanJson (std::string str)
void	cleanPrepString (std::string &myString)
void	cleanProdString (std::string &myString)
std::vector< std::string >	decompose (const std::string &s) const
void	eraseAllSubStr (std::string &s, const std::string &toErase)
void	prepareLine (const std::vector< std::string > &thePaths, std::vector< std::string > &output, std::string &tmp, const std::string &header)
std::string	replaceAll (std::string str, const std::string &from, const std::string &to)

Private Attributes
std::string	m_imageFileName
	image file name More...
std::string	m_IOVsinceDisplay
	iov since More...
DBoxMetadataHelper::recordMap	m_Map
	map of the record / metadata associations More...
std::string	m_tagName
	tag name More...

Detailed Description

Definition at line 181 of file DropBoxMetaDataPayloadInspectorHelper.h.

Constructor & Destructor Documentation

DBMetaDataPlotDisplay()

DBoxMetadataHelper::DBMetaDataPlotDisplay::DBMetaDataPlotDisplay ( DBoxMetadataHelper::recordMap  theMap, std::string  theTag, std::string  theIOV  )

inline

Definition at line 183 of file DropBoxMetaDataPayloadInspectorHelper.h.

        : m_Map(theMap), m_tagName(theTag), m_IOVsinceDisplay(theIOV) {}

~DBMetaDataPlotDisplay()

DBoxMetadataHelper::DBMetaDataPlotDisplay::~DBMetaDataPlotDisplay ( )

default

Member Function Documentation

cleanJson()

std::string DBoxMetadataHelper::DBMetaDataPlotDisplay::cleanJson ( std::string  str )

inlineprivate

Definition at line 534 of file DropBoxMetaDataPayloadInspectorHelper.h.

References MillePedeFileConverter_cfg::out, replaceAll(), str, and AlCaHLTBitMon_QueryRunRegistry::string.

                                       {
      std::string out = replaceAll(str, std::string("""), std::string("'"));
      return out;
    }

cleanPrepString()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::cleanPrepString ( std::string &  myString )

inlineprivate

Definition at line 551 of file DropBoxMetaDataPayloadInspectorHelper.h.

References eraseAllSubStr(), and replaceAll().

Referenced by plotDiffWithMetadata(), and plotMetaDatas().

                                              {
      eraseAllSubStr(myString, """);
      eraseAllSubStr(myString, "destinationDatabase: oracle://cms_orcoff_prep/CMS_CONDITIONS, ");
      eraseAllSubStr(myString, "since: null, ");
      eraseAllSubStr(myString, "{");
      eraseAllSubStr(myString, "}");
      eraseAllSubStr(myString, ":");
      myString = replaceAll(myString, "destinationTags", "destinationTags:");
      myString = replaceAll(myString, "inputTag", "inputTag:");
      return;
    }

cleanProdString()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::cleanProdString ( std::string &  myString )

inlineprivate

Definition at line 564 of file DropBoxMetaDataPayloadInspectorHelper.h.

References eraseAllSubStr(), and replaceAll().

Referenced by plotDiffWithMetadata(), and plotMetaDatas().

                                              {
      eraseAllSubStr(myString, """);
      eraseAllSubStr(myString, "destinationDatabase: oracle://cms_orcon_prod/CMS_CONDITIONS, ");
      eraseAllSubStr(myString, "since: null, ");
      eraseAllSubStr(myString, "{");
      eraseAllSubStr(myString, "}");
      eraseAllSubStr(myString, ":");
      myString = replaceAll(myString, "destinationTags", "destinationTags:");
      myString = replaceAll(myString, "inputTag", "inputTag:");
      return;
    }

decompose()

std::vector<std::string> DBoxMetadataHelper::DBMetaDataPlotDisplay::decompose ( const std::string &  s ) const

inlineprivate

Definition at line 577 of file DropBoxMetaDataPayloadInspectorHelper.h.

References mps_fire::result, and alignCSCRings::s.

Referenced by plotDiffWithMetadata(), and plotMetaDatas().

                                                             {
      // decompose 's' into its parts that are separated by 'delimeter_'
      // (similar as in
      //  Alignment/CommonAlignmentAlgorithm/src/AlignmentParameterSelector.cc)

      const std::string::value_type delimeter_ = ',';  // separator
      const std::string::value_type space_ = ' ';      // separator

      std::vector<std::string> result;
      if (!(s.size() == 1 && s[0] == delimeter_)) {
        // delimeter_ only indicates an empty list as DB cannot store empty strings
        std::string::size_type previousPos = 0;
        while (true) {
          const std::string::size_type delimiterPos = s.find(delimeter_, previousPos);
          if (delimiterPos == std::string::npos) {
            result.push_back(s.substr(previousPos));  // until end
            break;
          }
          result.push_back(s.substr(previousPos, delimiterPos - previousPos));
          previousPos = delimiterPos + 1;  // +1: skip delim
          if (s[previousPos] == space_)
            previousPos++;  // remove space
        }
      }
      return result;
    }

eraseAllSubStr()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::eraseAllSubStr ( std::string &  s, const std::string &  toErase  )

inlineprivate

Definition at line 540 of file DropBoxMetaDataPayloadInspectorHelper.h.

References alignCSCRings::s.

Referenced by cleanPrepString(), cleanProdString(), and plotDiffWithMetadata().

                                                                {
      size_t pos = std::string::npos;
      // Search for the substring in string in a loop until nothing is found
      while ((pos = s.find(toErase)) != std::string::npos) {
        // If found then erase it from string
        s.erase(pos, toErase.length());
      }
      return;
    }

plotDiffWithMetadata()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::plotDiffWithMetadata ( const DBoxMetadataHelper::recordMap &  theRefMap, std::string  theRefTag, std::string  theRefIOV  )

inline

Definition at line 332 of file DropBoxMetaDataPayloadInspectorHelper.h.

References beamvalidation::br, svgfig::canvas(), cleanPrepString(), cleanProdString(), decompose(), eraseAllSubStr(), MillePedeFileConverter_cfg::fileName, spr::find(), DBoxMetadataHelper::getAllRecords(), mps_fire::i, submitPVResolutionJobs::key, MainPageGenerator::l, mps_splice::line, groupFilesInBlocks::lines, m_imageFileName, m_IOVsinceDisplay, m_Map, m_tagName, SiStripPI::max, convertSQLitetoXML_cfg::output, prepareLine(), DBoxMetadataHelper::set_intersection(), AlCaHLTBitMon_QueryRunRegistry::string, and heppy_batch::val.

                                                   {
      const auto& ref_records = DBoxMetadataHelper::getAllRecords(theRefMap);
      const auto& tar_records = DBoxMetadataHelper::getAllRecords(m_Map);

      //      const auto& diff = DBoxMetadataHelper::set_difference(ref_records, tar_records);
      const auto& common = DBoxMetadataHelper::set_intersection(ref_records, tar_records);

      // preparations for plotting
      // starting table at y=1.0 (top of the canvas)
      // first column is at 0.03, second column at 0.22 NDC
      unsigned int mapsize = 2 * m_Map.size();
      float pitch = 1. / (mapsize * 1.1);
      float y, x1, x2;
      std::vector<float> y_x1, y_x2, y_line;
      std::vector<std::string> s_x1, s_x2, s_x3;
      y = 1.0;
      x1 = 0.02;
      x2 = x1 + 0.30;
      y -= pitch;

      // title for plot
      y_x1.push_back(y);
      s_x1.push_back("#scale[1.2]{Key}");
      y_x2.push_back(y);
      s_x2.push_back("#scale[1.2]{Target tag / IOV :" + m_tagName + " / " + m_IOVsinceDisplay + "}");

      y -= pitch;
      y_x1.push_back(y);
      s_x1.push_back("");
      y_x2.push_back(y);
      s_x2.push_back("#scale[1.2]{Reference tag / IOV :" + theRefTag + " / " + theRefIOV + "}");

      y -= pitch / 2.;
      y_line.push_back(y);

      // do first the common parts
      for (const auto& key : common) {
        const auto& val = m_Map.at(key);
        const auto& refval = theRefMap.at(key);

        y -= pitch;
        y_x1.push_back(y);
        s_x1.push_back(key);

        std::vector<std::string> output;

        std::string tarPrepMetaData = val.getPrepMetaData();
        std::string tarProdMetaData = val.getProdMetaData();
        std::string refPrepMetaData = refval.getPrepMetaData();
        std::string refProdMetaData = refval.getProdMetaData();

        // Remove &quot and uninteresting text from output for sake of clarity
        cleanPrepString(tarPrepMetaData);
        cleanPrepString(refPrepMetaData);
        cleanProdString(tarProdMetaData);
        cleanProdString(refProdMetaData);

        const std::vector<std::string> tarPathsPrep = decompose(tarPrepMetaData);
        const std::vector<std::string> refPathsPrep = decompose(refPrepMetaData);
        const std::vector<std::string> tarPathsProd = decompose(tarProdMetaData);
        const std::vector<std::string> refPathsProd = decompose(refProdMetaData);

        bool refAndTarIdentical = true;
        std::string tmpTar = "";
        std::string tmpRef = "";

        prepareLine(tarPathsPrep, output, tmpTar, "PREP/tar");
        prepareLine(refPathsPrep, output, tmpRef, "PREP/ref");

        // check if printouts are identical for PREP
        eraseAllSubStr(tmpTar, "PREP/tar: ");
        eraseAllSubStr(tmpRef, "PREP/ref: ");
        if (tmpTar != tmpRef) {
          refAndTarIdentical = false;
        } else {
          output.clear();
        }

        // determine the size after having filled the prep- metadata
        size_t lenAfterPrep = output.size();

        // clear the tmps
        tmpTar = "";
        tmpRef = "";

        prepareLine(tarPathsProd, output, tmpTar, "PROD/tar");
        prepareLine(refPathsProd, output, tmpRef, "PROD/ref");

        // check if printouts are identical for PROD
        eraseAllSubStr(tmpTar, "PROD/tar: ");
        eraseAllSubStr(tmpRef, "PROD/ref: ");
        if (tmpTar != tmpRef) {
          refAndTarIdentical = false;
        } else {
          // remove everything after the prep one
          output.erase(output.end() - lenAfterPrep, output.end());
        }

        // print either "identical" or contents of tags
        if (refAndTarIdentical) {
          y_x2.push_back(y);
          s_x2.push_back("#color[4]{identical}");
        } else {
          for (unsigned int br = 0; br < output.size(); br++) {
            y_x2.push_back(y);
            // do not use red color since colors get mixed if output[br]
            // contains a right curly brace (I could not find a way to circumvent that)
            s_x2.push_back(output[br]);

            if (br != output.size() - 1)
              y -= pitch;
          }
        }
        y_line.push_back(y - (pitch / 2.));
      }

      // now when common parts are handled, check if there are additional records
      // (one could check if diff is empty, but his doesn't seem to work as expected)

      // First, check if there are records in reference which are not in target
      for (const auto& ref : ref_records) {
        if (std::find(tar_records.begin(), tar_records.end(), ref) == tar_records.end()) {
          y -= pitch;
          y_x1.push_back(y);
          s_x1.push_back(ref);
          y_x2.push_back(y);
          s_x2.push_back("#bf{Only in reference, not in target.}");
          y_line.push_back(y - (pitch / 2.));
        }
      }

      // Second, check if there are records in target which are not in reference
      for (const auto& tar : tar_records) {
        if (std::find(ref_records.begin(), ref_records.end(), tar) == ref_records.end()) {
          y -= pitch;
          y_x1.push_back(y);
          s_x1.push_back(tar);
          y_x2.push_back(y);
          s_x2.push_back("#bf{Only in target, not in reference.}");
          y_line.push_back(y - (pitch / 2.));
        }
      }

      // Finally, print text to TCanvas

      TCanvas canvas("DropBoxMetaData", "DropBoxMetaData", 2000, std::max(y_x1.size(), y_x2.size()) * 40);
      TLatex l;
      // Draw the columns titles
      l.SetTextAlign(12);

      float newpitch = 1 / (std::max(y_x1.size(), y_x2.size()) * 1.1);
      float factor = newpitch / pitch;
      l.SetTextSize(newpitch - 0.002);
      canvas.cd();
      for (unsigned int i = 0; i < y_x1.size(); i++) {
        l.DrawLatexNDC(x1, 1 - (1 - y_x1[i]) * factor, s_x1[i].c_str());
      }

      for (unsigned int i = 0; i < y_x2.size(); i++) {
        l.DrawLatexNDC(x2, 1 - (1 - y_x2[i]) * factor, s_x2[i].c_str());
      }

      canvas.cd();
      canvas.Update();

      // Draw horizontal lines separating records
      TLine lines[y_line.size()];
      unsigned int iL = 0;
      for (const auto& line : y_line) {
        lines[iL] = TLine(gPad->GetUxmin(), 1 - (1 - line) * factor, gPad->GetUxmax(), 1 - (1 - line) * factor);
        lines[iL].SetLineWidth(1);
        lines[iL].SetLineStyle(9);
        lines[iL].SetLineColor(2);
        lines[iL].Draw("same");
        iL++;
      }

      std::string fileName("DropBoxMetadata_Compare.png");
      if (!m_imageFileName.empty())
        fileName = m_imageFileName;
      canvas.SaveAs(fileName.c_str());
    }

plotMetaDatas()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::plotMetaDatas ( )

inline

Definition at line 193 of file DropBoxMetaDataPayloadInspectorHelper.h.

References beamvalidation::br, svgfig::canvas(), cleanPrepString(), cleanProdString(), decompose(), MillePedeFileConverter_cfg::fileName, mps_fire::i, MainPageGenerator::l, mps_splice::line, groupFilesInBlocks::lines, m_imageFileName, m_IOVsinceDisplay, m_Map, m_tagName, SiStripPI::max, convertSQLitetoXML_cfg::output, and AlCaHLTBitMon_QueryRunRegistry::string.

                         {
      unsigned int mapsize = m_Map.size();
      float pitch = 1. / (mapsize * 1.1);

      float y, x1, x2;
      std::vector<float> y_x1, y_x2, y_line;
      std::vector<std::string> s_x1, s_x2, s_x3;

      // starting table at y=1.0 (top of the canvas)
      // first column is at 0.02, second column at 0.32 NDC
      y = 1.0;
      x1 = 0.02;
      x2 = x1 + 0.30;

      y -= pitch;
      y_x1.push_back(y);
      s_x1.push_back("#scale[1.2]{Key}");
      y_x2.push_back(y);
      s_x2.push_back("#scale[1.2]{tag: " + m_tagName + " in IOV: " + m_IOVsinceDisplay + "}");

      y -= pitch / 2.;
      y_line.push_back(y);

      for (const auto& element : m_Map) {
        y -= pitch;
        y_x1.push_back(y);
        s_x1.push_back(element.first);

        std::vector<std::string> output;
        std::string toAppend = "";

        std::string prepMetaData = element.second.getPrepMetaData();
        std::string prodMetaData = element.second.getProdMetaData();

        // Remove &quot and uninteresting text from output for sake of clarity
        cleanPrepString(prepMetaData);
        cleanProdString(prodMetaData);

        const std::vector<std::string> pathsPrep = decompose(prepMetaData);
        const std::vector<std::string> pathsProd = decompose(prodMetaData);

        const int colWidth = 80;

        toAppend = "PREP: ";
        output.push_back(toAppend);
        toAppend.clear();
        for (unsigned int iPath = 0; iPath < pathsPrep.size(); ++iPath) {
          const std::string& thisString = pathsPrep[iPath];
          // skip userText since we want to see actual contents, not metadata
          if (thisString.find("userText") == std::string::npos) {
            // if the line to be added has less than colWidth chars, and is not a new tag ("inputTag"), append to current
            if ((toAppend + thisString).length() < colWidth && thisString.find("inputTag") != 0) {
              toAppend += thisString;
            } else {
              // else if the line exceeds colWidth chars or this is a new tag ("inputTag"), dump in the vector and resume from scratch
              output.push_back(toAppend);
              toAppend.clear();
              toAppend += thisString;
            }
          }
          // if it's the last, dump it
          if (iPath == pathsPrep.size() - 1) {
            output.push_back(toAppend);
          }
        }

        toAppend = "PROD: ";
        output.push_back(toAppend);
        toAppend.clear();
        for (unsigned int iPath = 0; iPath < pathsProd.size(); ++iPath) {
          const std::string& thisString = pathsProd[iPath];

          if (thisString.find("userText") == std::string::npos) {
            // if the line to be added has less than colWidth chars append to current
            if ((toAppend + thisString).length() < colWidth && thisString.find("inputTag") != 0) {
              toAppend += thisString;
            } else {
              // else if the line exceeds colWidth chars or this is a new tag ("inputTag"), dump in the vector and resume from scratch
              output.push_back(toAppend);
              toAppend.clear();
              toAppend += thisString;
            }
          }
          // if it's the last, dump it
          if (iPath == pathsProd.size() - 1)
            output.push_back(toAppend);
        }

        for (unsigned int br = 0; br < output.size(); br++) {
          y_x2.push_back(y);
          // do not use red color since colors get mixed if output[br]
          // contains a right curly brace (I could not find a way to circumvent that)
          s_x2.push_back(output[br]);

          if (br != output.size() - 1)
            y -= pitch;
        }

        y_line.push_back(y - (pitch / 2.));
      }

      TCanvas canvas("DropBoxMetaData", "DropBoxMetaData", 2000, std::max(y_x1.size(), y_x2.size()) * 40);
      TLatex l;

      // Draw the columns titles
      l.SetTextAlign(12);
      float newpitch = 1 / (std::max(y_x1.size(), y_x2.size()) * 1.1);
      float factor = newpitch / pitch;
      l.SetTextSize(newpitch - 0.002);
      canvas.cd();
      for (unsigned int i = 0; i < y_x1.size(); i++) {
        l.DrawLatexNDC(x1, 1 - (1 - y_x1[i]) * factor, s_x1[i].c_str());
      }

      for (unsigned int i = 0; i < y_x2.size(); i++) {
        l.DrawLatexNDC(x2, 1 - (1 - y_x2[i]) * factor, s_x2[i].c_str());
      }
      canvas.cd();
      canvas.Update();

      // Draw horizontal lines separating records
      TLine lines[y_line.size()];
      unsigned int iL = 0;
      for (const auto& line : y_line) {
        lines[iL] = TLine(gPad->GetUxmin(), 1 - (1 - line) * factor, gPad->GetUxmax(), 1 - (1 - line) * factor);
        lines[iL].SetLineWidth(1);
        lines[iL].SetLineStyle(9);
        lines[iL].SetLineColor(2);
        lines[iL].Draw("same");
        iL++;
      }

      std::string fileName("DropBoxMetadata_Display.png");
      if (!m_imageFileName.empty())
        fileName = m_imageFileName;
      canvas.SaveAs(fileName.c_str());
    }

prepareLine()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::prepareLine ( const std::vector< std::string > &  thePaths, std::vector< std::string > &  output, std::string &  tmp, const std::string &  header  )

inlineprivate

Definition at line 605 of file DropBoxMetaDataPayloadInspectorHelper.h.

References RecoTauValidation_cfi::header, AlCaHLTBitMon_QueryRunRegistry::string, createJobs::tmp, and to_string().

Referenced by plotDiffWithMetadata().

                                              {
      const int color = (header.find("tar") == std::string::npos) ? 2 /*kRed*/ : 3 /*kGreen*/;
      const int colWidth = 80;  // maximum width of column

      std::string toAppend = "";
      toAppend = header;
      output.push_back("#color[" + std::to_string(color) + "]{" + toAppend + "}");
      toAppend.clear();
      for (unsigned int iPath = 0; iPath < thePaths.size(); ++iPath) {
        const std::string& thisString = thePaths[iPath];
        // skip userText since we want to compare actual contents, not metadata
        if (thisString.find("userText") == std::string::npos) {
          // if the line to be added has less than colWidth chars, and is not a new tag ("inputTag"), append to current
          if ((toAppend + thisString).length() < colWidth && thisString.find("inputTag") != 0) {
            toAppend += thisString;
          } else {
            // else if the line exceeds colWidth chars or this is a new tag ("inputTag"), dump in the vector and resume from scratch
            output.push_back("#color[" + std::to_string(color) + "]{" + toAppend + "}");
            tmp += toAppend;
            toAppend.clear();
            toAppend += thisString;
          }
        }
        if (iPath == thePaths.size() - 1) {
          output.push_back("#color[" + std::to_string(color) + "]{" + toAppend + "}");
          tmp += toAppend;
        }
      }
    }

replaceAll()

std::string DBoxMetadataHelper::DBMetaDataPlotDisplay::replaceAll ( std::string  str, const std::string &  from, const std::string &  to  )

inlineprivate

Definition at line 524 of file DropBoxMetaDataPayloadInspectorHelper.h.

References str.

Referenced by cleanJson(), cleanPrepString(), and cleanProdString().

                                                                                    {
      size_t start_pos = 0;
      while ((start_pos = str.find(from, start_pos)) != std::string::npos) {
        str.replace(start_pos, from.length(), to);
        start_pos += to.length();  // Handles case where 'to' is a substring of 'from'
      }
      return str;
    }

setImageFileName()

void DBoxMetadataHelper::DBMetaDataPlotDisplay::setImageFileName ( const std::string &  theFileName )

inline

Definition at line 187 of file DropBoxMetaDataPayloadInspectorHelper.h.

References m_imageFileName.

                                                        {
      m_imageFileName = theFileName;
      return;
    }

Member Data Documentation

m_imageFileName

std::string DBoxMetadataHelper::DBMetaDataPlotDisplay::m_imageFileName

private

image file name

Definition at line 521 of file DropBoxMetaDataPayloadInspectorHelper.h.

Referenced by plotDiffWithMetadata(), plotMetaDatas(), and setImageFileName().

m_IOVsinceDisplay

std::string DBoxMetadataHelper::DBMetaDataPlotDisplay::m_IOVsinceDisplay

private

iov since

Definition at line 520 of file DropBoxMetaDataPayloadInspectorHelper.h.

Referenced by plotDiffWithMetadata(), and plotMetaDatas().

m_Map

DBoxMetadataHelper::recordMap DBoxMetadataHelper::DBMetaDataPlotDisplay::m_Map

private

map of the record / metadata associations

Definition at line 518 of file DropBoxMetaDataPayloadInspectorHelper.h.

Referenced by plotDiffWithMetadata(), and plotMetaDatas().

m_tagName

std::string DBoxMetadataHelper::DBMetaDataPlotDisplay::m_tagName

private

tag name

Definition at line 519 of file DropBoxMetaDataPayloadInspectorHelper.h.

Referenced by plotDiffWithMetadata(), and plotMetaDatas().