the internal class used to keep parsed Filler properties More...

#include <HistogramDef.h>

Collaboration diagram for Monitored::HistogramDef:

Public Types
enum class	RunMode { Online , Offline , Invalid }
enum class	RunPeriod { Run , LowStat , Lumiblock , Invalid }

Static Public Member Functions
static const HistogramDef	parse (const std::string &histogramDefinition)
	Parses histogram defintion from json data.

Public Attributes
std::vector< std::string >	name
	names of monitored variables
std::string	alias
	unique alias for THistSvc
std::string	type
	class name
std::string	path
	booking path
std::string	title
	title of the histogram
std::string	opt
	options
std::string	tld
	top level directory (below THistSvc stream)
std::string	weight
	name of weight variable
std::string	cutMask
	variable that defines whether event is accepted
std::string	convention
	path naming convention (e.g.
RunMode	runmode = RunMode::Invalid
	online or offline
RunPeriod	runperiod = RunPeriod::Invalid
	rebook period in offline monitoring
bool	Sumw2 {false}
	store sum of squares of weights
int	kLBNHistoryDepth {0}
	length of lb history
bool	kAddBinsDynamically {false}
	add new bins outside the existing range
bool	kRebinAxes {false}
	increase the axis range without adding new bins
bool	kCanRebin {false}
	allow all axes to be rebinned
bool	kVec {false}
	add content to each bin from each element of a vector
bool	kVecUO {false}
	add content to each bin from vector, including overflow/underflow
bool	kCumulative {false}
	fill bin of monitored object's value, and every bin below it
int	kLive {0}
	fill only the last N lumiblocks in y_vs_lb plots
bool	kAlwaysCreate {false}
	always create this histogram, even if never filled
std::string	xvar
	name of x variable
int	xbins {0}
	number of y bins
float	xmin {0}
	x axis minimum
float	xmax {0}
	x axis maximum
std::vector< std::string >	xlabels
	labels for x axis
std::vector< double >	xarray
	array of x bin edges
std::string	yvar
	name of y variable
int	ybins {0}
	number of y bins
float	ymin {0}
	y axis minimum
float	ymax {0}
	y axis maximum
std::vector< std::string >	ylabels
	labels for y axis
std::vector< double >	yarray
	array of y bin edges
std::string	zvar
	name of z variable
int	zbins {0}
	number of z bins
float	zmin {0}
	z axis minimum
float	zmax {0}
	z axis maximum
std::vector< std::string >	zlabels
	labels for z axis
std::string	treeDef
	defines output TTree of monitored quantities
std::string	merge
bool	ok {false}
	good declaration: parsing or copying successful

Detailed Description

the internal class used to keep parsed Filler properties

Definition at line 15 of file HistogramDef.h.

Member Enumeration Documentation

◆ RunMode

enum class Monitored::HistogramDef::RunMode

strong

Enumerator
Online	monitoring data online
Offline	monitoring data offline
Invalid	monitoring mode not specified

Definition at line 27 of file HistogramDef.h.

                       {
      Online, 
      Offline, 
      Invalid, 
    };

◆ RunPeriod

enum class Monitored::HistogramDef::RunPeriod

strong

Enumerator
Run	rebook histogram after each run
LowStat	rebook histogram after every 20 lumiblocks
Lumiblock	rebook histogram after every 1 lumiblock
Invalid	rebook period not specified

Definition at line 33 of file HistogramDef.h.

                         {
      Run, 
      LowStat, 
      Lumiblock, 
      Invalid, 
    };

Member Function Documentation

◆ parse()

const HistogramDef HistogramDef::parse ( const std::string & histogramDefinition )

static

Parses histogram defintion from json data.

Parameters

histogramDefinition A string contains histogram definition to parse

Returns: HistogramDef Object that contains the parsed histogram definition

Definition at line 11 of file HistogramDef.cxx.

                                                                           {
  const json& setting = json::parse(histogramDefinition);
  HistogramDef result;
 
  result.name = setting["allvars"].get<std::vector<std::string>>();
  result.alias = static_cast<std::string>(setting["alias"]);
  result.type = static_cast<std::string>(setting["type"]);
  result.path = static_cast<std::string>(setting["path"]);
  result.title = static_cast<std::string>(setting["title"]);
  result.weight = static_cast<std::string>(setting["weight"]);
  result.cutMask = static_cast<std::string>(setting["cutMask"]);
 
  result.convention = static_cast<std::string>(setting["convention"]);
  size_t offline = result.convention.find("OFFLINE");
  if (offline != std::string::npos) {
    result.runmode = RunMode::Offline;
    std::string durationString = result.convention.substr(offline);
    if (durationString.find("run") != std::string::npos) {
      result.runperiod = RunPeriod::Run;
    } else if (durationString.find("lowStat") != std::string::npos) {
      result.runperiod = RunPeriod::LowStat;
    } else {
      result.runperiod = RunPeriod::Lumiblock;
    }
  } else {
    result.runmode = RunMode::Online;
  }
 
  // all histogram options arising from 'opt'
  result.Sumw2 = setting["Sumw2"];
  result.kLBNHistoryDepth = setting["kLBNHistoryDepth"];
  result.kAddBinsDynamically = setting["kAddBinsDynamically"];
  result.kRebinAxes = setting["kRebinAxes"];
  result.kCanRebin = setting["kCanRebin"];
  result.kVec = setting["kVec"];
  result.kVecUO = setting["kVecUO"];
  result.kCumulative = setting["kCumulative"];
  result.kLive = setting["kLive"];
  result.kAlwaysCreate = setting["kAlwaysCreate"];
 
  result.xvar = static_cast<std::string>(setting["xvar"]);
  result.xbins = setting["xbins"];
  result.xmin = setting["xmin"];
  result.xmax = setting["xmax"];
  result.xlabels = setting["xlabels"].get<std::vector<std::string>>();
  result.xarray = setting["xarray"].get<std::vector<double>>();
 
  result.yvar = static_cast<std::string>(setting["yvar"]);
  result.ybins = setting["ybins"];
  result.ymin = setting["ymin"];
  result.ymax = setting["ymax"];
  result.ylabels = setting["ylabels"].get<std::vector<std::string>>();
  result.yarray = setting["yarray"].get<std::vector<double>>();
 
  result.zvar = static_cast<std::string>(setting["zvar"]);
  result.zbins = setting["zbins"];
  result.zmin = setting["zmin"];
  result.zmax = setting["zmax"];
  result.zlabels = setting["zlabels"].get<std::vector<std::string>>();
 
  result.merge = static_cast<std::string>(setting["merge"]);
 
  result.treeDef = static_cast<std::string>(setting["treeDef"]);
 
  result.ok = true;
  return result;
}

Member Data Documentation

◆ alias

std::string Monitored::HistogramDef::alias

unique alias for THistSvc

Definition at line 17 of file HistogramDef.h.

◆ convention

std::string Monitored::HistogramDef::convention

path naming convention (e.g.

OFFLINE:LowStat)

Definition at line 39 of file HistogramDef.h.

◆ cutMask

std::string Monitored::HistogramDef::cutMask

variable that defines whether event is accepted

Definition at line 24 of file HistogramDef.h.

◆ kAddBinsDynamically

bool Monitored::HistogramDef::kAddBinsDynamically {false}

add new bins outside the existing range

Definition at line 45 of file HistogramDef.h.

45{false};

◆ kAlwaysCreate

bool Monitored::HistogramDef::kAlwaysCreate {false}

always create this histogram, even if never filled

Definition at line 52 of file HistogramDef.h.

52{false};

◆ kCanRebin

bool Monitored::HistogramDef::kCanRebin {false}

allow all axes to be rebinned

Definition at line 47 of file HistogramDef.h.

47{false};

◆ kCumulative

bool Monitored::HistogramDef::kCumulative {false}

fill bin of monitored object's value, and every bin below it

Definition at line 50 of file HistogramDef.h.

50{false};

◆ kLBNHistoryDepth

int Monitored::HistogramDef::kLBNHistoryDepth {0}

length of lb history

Definition at line 44 of file HistogramDef.h.

44{0};

◆ kLive

int Monitored::HistogramDef::kLive {0}

fill only the last N lumiblocks in y_vs_lb plots

Definition at line 51 of file HistogramDef.h.

51{0};

◆ kRebinAxes

bool Monitored::HistogramDef::kRebinAxes {false}

increase the axis range without adding new bins

Definition at line 46 of file HistogramDef.h.

46{false};

◆ kVec

bool Monitored::HistogramDef::kVec {false}

add content to each bin from each element of a vector

Definition at line 48 of file HistogramDef.h.

48{false};

◆ kVecUO

bool Monitored::HistogramDef::kVecUO {false}

add content to each bin from vector, including overflow/underflow

Definition at line 49 of file HistogramDef.h.

49{false};

◆ merge

std::string Monitored::HistogramDef::merge

Definition at line 75 of file HistogramDef.h.

◆ name

std::vector<std::string> Monitored::HistogramDef::name

names of monitored variables

Definition at line 16 of file HistogramDef.h.

◆ ok

bool Monitored::HistogramDef::ok {false}

good declaration: parsing or copying successful

Definition at line 77 of file HistogramDef.h.

77{false};

◆ opt

std::string Monitored::HistogramDef::opt

options

Definition at line 21 of file HistogramDef.h.

◆ path

std::string Monitored::HistogramDef::path

booking path

Definition at line 19 of file HistogramDef.h.

◆ runmode

RunMode Monitored::HistogramDef::runmode = RunMode::Invalid

online or offline

Definition at line 40 of file HistogramDef.h.

◆ runperiod

RunPeriod Monitored::HistogramDef::runperiod = RunPeriod::Invalid

rebook period in offline monitoring

Definition at line 41 of file HistogramDef.h.

◆ Sumw2

bool Monitored::HistogramDef::Sumw2 {false}

store sum of squares of weights

Definition at line 43 of file HistogramDef.h.

43{false};

◆ title

std::string Monitored::HistogramDef::title

title of the histogram

Definition at line 20 of file HistogramDef.h.

◆ tld

std::string Monitored::HistogramDef::tld

top level directory (below THistSvc stream)

Definition at line 22 of file HistogramDef.h.

◆ treeDef

std::string Monitored::HistogramDef::treeDef

defines output TTree of monitored quantities

Definition at line 74 of file HistogramDef.h.

◆ type

std::string Monitored::HistogramDef::type

class name

Definition at line 18 of file HistogramDef.h.

◆ weight

std::string Monitored::HistogramDef::weight

name of weight variable

Definition at line 23 of file HistogramDef.h.

◆ xarray

std::vector<double> Monitored::HistogramDef::xarray

array of x bin edges

Definition at line 59 of file HistogramDef.h.

◆ xbins

int Monitored::HistogramDef::xbins {0}

number of y bins

Definition at line 55 of file HistogramDef.h.

55{0};

◆ xlabels

std::vector<std::string> Monitored::HistogramDef::xlabels

labels for x axis

Definition at line 58 of file HistogramDef.h.

◆ xmax

float Monitored::HistogramDef::xmax {0}

x axis maximum

Definition at line 57 of file HistogramDef.h.

57{0};

◆ xmin

float Monitored::HistogramDef::xmin {0}

x axis minimum

Definition at line 56 of file HistogramDef.h.

56{0};

◆ xvar

std::string Monitored::HistogramDef::xvar

name of x variable

Definition at line 54 of file HistogramDef.h.

◆ yarray

std::vector<double> Monitored::HistogramDef::yarray

array of y bin edges

Definition at line 66 of file HistogramDef.h.

◆ ybins

int Monitored::HistogramDef::ybins {0}

number of y bins

Definition at line 62 of file HistogramDef.h.

62{0};

◆ ylabels

std::vector<std::string> Monitored::HistogramDef::ylabels

labels for y axis

Definition at line 65 of file HistogramDef.h.

◆ ymax

float Monitored::HistogramDef::ymax {0}

y axis maximum

Definition at line 64 of file HistogramDef.h.

64{0};

◆ ymin

float Monitored::HistogramDef::ymin {0}

y axis minimum

Definition at line 63 of file HistogramDef.h.

63{0};

◆ yvar

std::string Monitored::HistogramDef::yvar

name of y variable

Definition at line 61 of file HistogramDef.h.

◆ zbins

int Monitored::HistogramDef::zbins {0}

number of z bins

Definition at line 69 of file HistogramDef.h.

69{0};

◆ zlabels

std::vector<std::string> Monitored::HistogramDef::zlabels

labels for z axis

Definition at line 72 of file HistogramDef.h.

◆ zmax

float Monitored::HistogramDef::zmax {0}

z axis maximum

Definition at line 71 of file HistogramDef.h.

71{0};

◆ zmin

float Monitored::HistogramDef::zmin {0}

z axis minimum

Definition at line 70 of file HistogramDef.h.

70{0};

◆ zvar

std::string Monitored::HistogramDef::zvar

name of z variable

Definition at line 68 of file HistogramDef.h.

The documentation for this struct was generated from the following files:

Public Types

Static Public Member Functions

Public Attributes