Trend Struct Reference

#include <Trend.h>

Public Member Functions
void	operator() (TObject *obj, TString drawOpt, TString lgdOpt, bool fullRange=true)
	Trend (const char *name, const char *dir, const char *title, const char *ytitle, float ymin, float ymax, boost::property_tree::ptree &json, const Run2Lumi &GetLumiFunctor, const char *lumiAxisType)
	< constructor, prepares canvas and frame More...
	~Trend ()

Public Attributes
TCanvas	c
TString	CMS = "#scale[1.1]{#bf{CMS}} #it{Internal}"
	top left label More...
float	fontsize = 0.04
const Run2Lumi &	GetLumi
	functor to get luminosity for given subrange More...
const boost::property_tree::ptree	JSON
	contains coordinate for vertical lines More...
TLegend	lgd
TString	lumi
	top right label (not necessarily the lumi, just following the convention from CMS_lumi.h) More...
const char *	lumiType
const char *	outputDir
std::string	plotUnit = "fb"

Detailed Description

Standard canvas for TkAl trends as a function of delivered lumi.

The constructor and the destructor take care of the style, The operator() is overloaded and should be given a trend as a function of the run number (either TGraphErrors or TH1). The verticles lines (e.g. pixel templates) are given via a JSON file.

Definition at line 78 of file Trend.h.

Constructor & Destructor Documentation

Trend()

Trend::Trend	(	const char *	name,
		const char *	dir,
		const char *	title,
		const char *	ytitle,
		float	ymin,
		float	ymax,
		boost::property_tree::ptree &	json,
		const Run2Lumi &	GetLumiFunctor,
		const char *	lumiAxisType
	)

< constructor, prepares canvas and frame

Parameters

name	TCanvas name, also used for output PDF
title	TCanvas title, also used for output PDF (but not shown on the canvas)
ytitle	y-axis title
ymin	y-axis minimum
ymax	y-axis maximum
json	vertical lines from JSON
GetLumiFunctor	functor

Definition at line 130 of file Trend.cc.

References cms::cuda::assert(), c, data, fontsize, GetLumi, JSON, MainPageGenerator::l, lgd, mps_splice::line, groupFilesInBlocks::lines, lumiType, plotUnit, writedatasetfile::run, writedatasetfile::runs, runGCPTkAlMap::title, findQualityFiles::v, ApeEstimator_cff::width, TrackerOfflineValidation_Dqm_cff::xmax, L1TOccupancyClient_cfi::ymax, L1TOccupancyClient_cfi::ymin, and compareTotals::ytitle.

    : c(name, title, 2000, 800),
      outputDir(Form("%s", dir)),
      lgd(0.7, 0.65, 0.97, 0.89, "", "NDC"),
      JSON(json),
      GetLumi(GetLumiFunctor),
      lumiType(lumiAxisType) {
  if (JSON.count("CMSlabel"))
    CMS = Form("#scale[1.1]{#bf{CMS}} #it{%s}", JSON.get<string>("CMSlabel").data());

  if (JSON.get_child("trends").count("TitleCanvas"))
    lumi = Form("#scale[0.8]{%s}", JSON.get_child("trends").get<string>("TitleCanvas").data());

  assert(ymin < ymax);
  float xmax = GetLumi(GetLumi.firstRun, GetLumi.lastRun);
  if (JSON.get_child("trends").count("plotUnit"))
    plotUnit = JSON.get_child("trends").get<string>("plotUnit");
  const char* axistitles = Form(";%s luminosity  [%s^{-1} ];%s", lumiType, plotUnit.c_str(), ytitle);
  auto frame = c.DrawFrame(0., ymin, xmax, ymax, axistitles);
  frame->GetYaxis()->SetTitleOffset(0.8);
  frame->GetYaxis()->SetTickLength(0.01);
  frame->GetXaxis()->SetLabelSize(fontsize);
  frame->GetXaxis()->SetTitleSize(fontsize);
  frame->GetYaxis()->SetLabelSize(fontsize);
  frame->GetYaxis()->SetTitleSize(fontsize);
  lgd.SetTextSize(fontsize);

  if (ymax > 0 && ymin < 0) {
    TLine l;
    l.SetLineColor(kBlack);
    l.SetLineStyle(kDashed);
    l.DrawLine(0., 0., xmax, 0.);
  }

  c.SetTicks(1, 1);
  c.SetRightMargin(0.015);
  c.SetLeftMargin(0.07);
  c.SetTopMargin(0.07);

  // plot vertical lines (typically pixel template transitions)
  pt::ptree lines = JSON.get_child("trends.lines");
  for (auto& type : lines) {
    auto line = type.second.get_child_optional("line");
    auto runs = type.second.get_child_optional("runs");
    if (!line || !runs)
      continue;

    auto v = new TLine;

    auto style = line->get_optional<string>("style");
    if (style)
      v->SetLineStyle(StyleParser(*style));

    auto color = line->get_optional<string>("color");
    if (color)
      v->SetLineColor(ColorParser(*color));

    auto width = line->get_optional<int>("width");
    if (width)
      v->SetLineWidth(*width);

    auto title = line->get_optional<string>("title");
    if (title)
      lgd.AddEntry(v, title->c_str(), "l");

    for (auto& run : *runs) {
      auto currentRun = run.second.get_value<int>();

      auto lumi = GetLumi(GetLumi.firstRun, currentRun);

      if (lumi > 0)
        v->DrawLine(lumi, ymin, lumi, ymax);
    }
  }
}

~Trend()

Trend::~Trend

(

)

Destructor applies fine tuning of the plots, e.g. legend, labels, etc. and finally prints to PDF.

Definition at line 248 of file Trend.cc.

References cms::cuda::assert(), c, GetLumi, JSON, MainPageGenerator::l, label, SummaryClient_cfi::labels, lgd, groupFilesInBlocks::lines, lumiTextOffset, SiStripPI::max, outputDir, RecoTauValidation_cfi::posX, RecoTauValidation_cfi::posY, alignCSCRings::r, writedatasetfile::runs, and submitPVValidationJobs::t.

              {
  c.cd();
  lgd.Draw();

  float l = c.GetLeftMargin(), t = c.GetTopMargin(), r = c.GetRightMargin(), lumiTextOffset = 0.2;

  TLatex latex;
  latex.SetNDC();
  latex.SetTextFont(42);

  latex.SetTextAlign(11);
  latex.DrawLatex(l, 1 - t + lumiTextOffset * t, CMS);

  latex.SetTextAlign(31);
  latex.DrawLatex(1 - r, 1 - t + lumiTextOffset * t, lumi);

  // plot labels
  latex.SetTextAlign(13);
  auto totLumi = GetLumi();
  assert(totLumi > 0);
  auto posY = 0.88;
  pt::ptree lines = JSON.get_child("trends.lines");
  for (auto& type : lines) {
    auto labels = type.second.get_child_optional("labels");
    auto runs = type.second.get_child_optional("runs");
    if (!labels || !runs)
      continue;

    auto runIt = runs->begin();
    auto labelIt = labels->begin();
    while (runIt != runs->end() && labelIt != labels->end()) {
      auto currentRun = runIt->second.get_value<int>();
      auto label = labelIt->second.get_value<string>();

      auto lumi = max(GetLumi(currentRun), (float)0.01);
      auto posX = l + (lumi / totLumi) / (l + 1 + r) + 0.02;

      label = "#scale[0.8]{" + label + "}";
      latex.DrawLatex(posX, posY, label.c_str());

      ++runIt;
      ++labelIt;
    }
    posY -= 0.06;
  }

  c.RedrawAxis();
  c.SaveAs(Form("%s/%s.pdf", outputDir, c.GetName()), Form("Title:%s", c.GetTitle()));
  c.SaveAs(Form("%s/%s.png", outputDir, c.GetName()), Form("Title:%s", c.GetTitle()));
}

Member Function Documentation

operator()()

void Trend::operator()	(	TObject *	obj,
		TString	drawOpt,
		TString	lgdOpt,
		bool	fullRange = true
	)

Operator overloading to plot a trend (given as a function of run number) as a function of the luminosity.

Parameters

obj	e.g. graph
drawOpt	e.g. option for TGraph::Draw()
lgdOpt	option for TLegend::Draw()
fullRange	flag to force the graph to touch the right edge

Definition at line 214 of file Trend.cc.

References c, DMR_cfg::cerr, data-class-funcs::classname, beamvalidation::exit(), g, GetLumi, h, lgd, dqmiodumpmetadata::n, Skims_PA_cff::name, getGTfromDQMFile::obj, and runGCPTkAlMap::title.

                                                                                    {
  c.cd();

  TString classname = obj->ClassName();
  if (classname.Contains("TGraph")) {
    auto g = dynamic_cast<TGraph*>(obj);
    int n = g->GetN();

    if (fullRange) {
      g->Set(n);
      g->SetPoint(n, GetLumi.lastRun, 0);
    }
    g = GetLumi(g);
    g->Draw("same" + drawOpt);
  } else if (classname.Contains("TH1")) {
    auto h = dynamic_cast<TH1*>(obj);
    // TODO: full range?
    h = GetLumi(h);
    h->Draw("same" + drawOpt);
  } else {
    cerr << "No implementation for `" << classname << "`\n";
    exit(EXIT_FAILURE);
  }

  TString name = c.GetName();
  name.ReplaceAll("vs_run", "vs_lumi");
  c.SetName(name);

  TString title = obj->GetTitle();
  if (title == "")
    return;
  lgd.AddEntry(obj, "", lgdOpt);
}

Member Data Documentation

c

TCanvas Trend::c

Definition at line 86 of file Trend.h.

Referenced by operator()(), Trend(), and ~Trend().

CMS

TString Trend::CMS = "#scale[1.1]{#bf{CMS}} #it{Internal}"

top left label

Definition at line 79 of file Trend.h.

fontsize

float Trend::fontsize = 0.04

Definition at line 84 of file Trend.h.

Referenced by Trend().

GetLumi

const Run2Lumi& Trend::GetLumi

functor to get luminosity for given subrange

Definition at line 91 of file Trend.h.

Referenced by operator()(), Trend(), and ~Trend().

JSON

const boost::property_tree::ptree Trend::JSON

contains coordinate for vertical lines

Definition at line 90 of file Trend.h.

Referenced by Trend(), and ~Trend().

lgd

TLegend Trend::lgd

Definition at line 88 of file Trend.h.

Referenced by main(), operator()(), Trend(), trends(), and ~Trend().

lumi

TString Trend::lumi

Initial value:

=
      "#scale[0.8]{pp collisions (2016+2017+2018)}"

top right label (not necessarily the lumi, just following the convention from CMS_lumi.h)

Definition at line 80 of file Trend.h.

Referenced by generateEDF.LumiInfo::__str__(), and upgradeWorkflowComponents.UpgradeWorkflowAging::setup_().

lumiType

const char* Trend::lumiType

Definition at line 92 of file Trend.h.

Referenced by Trend().

outputDir

const char* Trend::outputDir

Definition at line 87 of file Trend.h.

Referenced by DMRplotter.DMRplotter::__clean__(), DMRplotter.DMRplotter::__cleanSingle__(), DMRplotter.DMRplotter::__createArchitecture__(), DMRplotter.DMRplotter::__createSingleArchitecture__(), DMRplotter.DMRplotter::__finalize__(), DMRplotter.DMRplotter::plot(), DMRplotter.DMRplotter::plotSingle(), postprocessor.PostProcessor::run(), and ~Trend().

plotUnit

std::string Trend::plotUnit = "fb"

Definition at line 82 of file Trend.h.

Referenced by Trend().