Almost-a-struct for holding the single histogram definition. More...

#include <SingleHistogramDefinition.h>

Collaboration diagram for SingleHistogramDefinition:

Public Types
typedef const std::string &	Titles_t

typedef const unsigned int	NBins_t

typedef const float	Var_t

Public Member Functions
	SingleHistogramDefinition ()

	SingleHistogramDefinition (Titles_t name, Titles_t histoType, Titles_t title, NBins_t nbinsX, Var_t xLo, Var_t xHi, Titles_t xName, Titles_t yName, Titles_t theFolder="")
	C'tor for 1D histograms (no Y bins or limits) More...

	SingleHistogramDefinition (Titles_t name, Titles_t histoType, Titles_t title, NBins_t nbinsX, NBins_t nbinsY, Var_t xLo, Var_t xHi, Var_t yLo, Var_t yHi, Titles_t xName, Titles_t yName, Titles_t theFolder="")
	C'tor for 2D histograms (Y bins and limits) More...

	SingleHistogramDefinition (Titles_t name, Titles_t histoType, Titles_t title, NBins_t nbinsX, NBins_t nbinsY, NBins_t nbinsZ, Var_t xLo, Var_t xHi, Var_t yLo, Var_t yHi, Var_t zLo, Var_t zHi, Titles_t xName, Titles_t yName, Titles_t zName, Titles_t theFolder="")
	C'tor for 3D histograms (Y,Z bins and limits) More...

bool	empty () const
	Is the histogram definition empty? More...

std::string	str () const
	String representation of the histogram definition. More...

bool	validType () const
	Does the histogram definition have a valid type (TH1, TH2 etc)? More...

bool	isValid () const
	Is the histogram definition valid. More...

std::string	stringIndex () const
	add the folder path to produce the full histogram name e.g. myFolder/myHisto More...

std::string	titleDigest () const
	produce single-line representation of the titles (titles separated by the ';' delimiter) More...

Static Public Member Functions
static std::string	stringIndex (const std::string &thisname, const std::string &thisfolder)
	concatenate a sanitised folderName with the histogram name More...

Public Attributes
std::string	name

std::string	histoType

std::string	title

unsigned int	nBinsX

unsigned int	nBinsY

unsigned int	nBinsZ

IHistogramDefinitionSvc::axesLimits_t	xAxis

IHistogramDefinitionSvc::axesLimits_t	yAxis

IHistogramDefinitionSvc::axesLimits_t	zAxis

std::string	xTitle

std::string	yTitle

std::string	zTitle

std::string	allTitles

std::string	folder

bool	m_empty

Detailed Description

Almost-a-struct for holding the single histogram definition.

Definition at line 17 of file SingleHistogramDefinition.h.

Member Typedef Documentation

◆ NBins_t

typedef const unsigned int SingleHistogramDefinition::NBins_t

Definition at line 20 of file SingleHistogramDefinition.h.

◆ Titles_t

typedef const std::string& SingleHistogramDefinition::Titles_t

Definition at line 19 of file SingleHistogramDefinition.h.

◆ Var_t

typedef const float SingleHistogramDefinition::Var_t

Definition at line 21 of file SingleHistogramDefinition.h.

Constructor & Destructor Documentation

◆ SingleHistogramDefinition() [1/4]

SingleHistogramDefinition::SingleHistogramDefinition ( )

Definition at line 14 of file SingleHistogramDefinition.cxx.

                                                      :
   name{},
   histoType{},
   title{},
   nBinsX{},
   nBinsY{},
   nBinsZ{},
   xAxis(std::make_pair(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN())),
   yAxis(std::make_pair(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN())),
   zAxis(std::make_pair(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN())),
   xTitle{},
   yTitle{},
   zTitle{},
   allTitles{},
   folder{},
   m_empty(true) {
 }

◆ SingleHistogramDefinition() [2/4]

SingleHistogramDefinition::SingleHistogramDefinition	(	Titles_t	name,
		Titles_t	histoType,
		Titles_t	title,
		NBins_t	nbinsX,
		Var_t	xLo,
		Var_t	xHi,
		Titles_t	xName,
		Titles_t	yName,
		Titles_t	theFolder = `""`
	)

C'tor for 1D histograms (no Y bins or limits)

Definition at line 32 of file SingleHistogramDefinition.cxx.

                                                  :
   name(thename), histoType(thehistoType), title(thetitle), 
   nBinsX(nbinsX), nBinsY(0), nBinsZ(0),
   xAxis(xLo, xHi),
   yAxis(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN()),
   zAxis(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN()),
   xTitle(xName), yTitle(yName), zTitle(""), 
   folder(thefolder), m_empty(false) {
   
   allTitles = titleDigest();
 }

◆ SingleHistogramDefinition() [3/4]

SingleHistogramDefinition::SingleHistogramDefinition	(	Titles_t	name,
		Titles_t	histoType,
		Titles_t	title,
		NBins_t	nbinsX,
		NBins_t	nbinsY,
		Var_t	xLo,
		Var_t	xHi,
		Var_t	yLo,
		Var_t	yHi,
		Titles_t	xName,
		Titles_t	yName,
		Titles_t	theFolder = `""`
	)

C'tor for 2D histograms (Y bins and limits)

Definition at line 48 of file SingleHistogramDefinition.cxx.

                                                                                  :
   name(thename), histoType(thehistoType), title(thetitle), 
   nBinsX(nbinsX), nBinsY(nbinsY), nBinsZ(0),
   xAxis(xLo, xHi),
   yAxis(yLo, yHi),
   zAxis(std::numeric_limits<float>::quiet_NaN(), std::numeric_limits<float>::quiet_NaN()),
   xTitle(xName), yTitle(yName), zTitle(""),
   folder(thefolder), m_empty(false) {
   // should do sanity checks here
   
   allTitles = titleDigest();
 }

◆ SingleHistogramDefinition() [4/4]

SingleHistogramDefinition::SingleHistogramDefinition	(	Titles_t	name,
		Titles_t	histoType,
		Titles_t	title,
		NBins_t	nbinsX,
		NBins_t	nbinsY,
		NBins_t	nbinsZ,
		Var_t	xLo,
		Var_t	xHi,
		Var_t	yLo,
		Var_t	yHi,
		Var_t	zLo,
		Var_t	zHi,
		Titles_t	xName,
		Titles_t	yName,
		Titles_t	zName,
		Titles_t	theFolder = `""`
	)

C'tor for 3D histograms (Y,Z bins and limits)

Definition at line 64 of file SingleHistogramDefinition.cxx.

                                                                                                  :
   name(thename), histoType(thehistoType), title(thetitle), 
   nBinsX(nbinsX), nBinsY(nbinsY), nBinsZ(nbinsZ),
   xAxis(xLo, xHi),
   yAxis(yLo, yHi),
   zAxis(zLo, zHi),
   xTitle(xName), yTitle(yName), zTitle(zName), 
   folder(thefolder), m_empty(false) {
   // should do sanity checks here
   
   allTitles = titleDigest();
 }

Member Function Documentation

◆ empty()

bool SingleHistogramDefinition::empty ( ) const

Is the histogram definition empty?

Definition at line 81 of file SingleHistogramDefinition.cxx.

                                        {
   return m_empty;
 }

◆ isValid()

bool SingleHistogramDefinition::isValid ( ) const

Is the histogram definition valid.

Definition at line 104 of file SingleHistogramDefinition.cxx.

                                          {
   if (name.empty() or histoType.empty()) {
     return false;
   }
   bool sane(true);
   // note: if yaxis is left undefined, the limits should be NaN, but (NaN != NaN) is always true
   const bool sensibleLimits = (xAxis.first != xAxis.second)and(yAxis.first != yAxis.second)and(zAxis.first != zAxis.second);
   const bool sensibleXBins = (nBinsX != 0);
   const bool sensibleYBins = (nBinsY != 0);
   const bool sensibleZBins = (nBinsZ != 0);
   const bool sensibleTitles = not (title.empty() or xTitle.empty());
   sane = (sensibleLimits and sensibleXBins and sensibleTitles);
   if (histoType.substr(0, 3) == "TH2") {
     sane = (sane and sensibleYBins);
   }
   if (histoType.substr(0, 3) == "TH3") {
     sane = (sane and sensibleYBins and sensibleZBins);
   }
   return sane;
 }

◆ str()

std::string SingleHistogramDefinition::str ( ) const

String representation of the histogram definition.

Definition at line 86 of file SingleHistogramDefinition.cxx.

                                      {
   const std::string s(" ");
  
   return name + s + histoType + s + title + s + std::to_string(nBinsX) + s + std::to_string(nBinsY) + s + std::to_string(nBinsZ) +
          s + std::to_string(xAxis.first) + s + std::to_string(xAxis.second) + s +
          std::to_string(yAxis.first) + s + std::to_string(yAxis.second) + s +
          std::to_string(zAxis.first) + s + std::to_string(zAxis.second) + s + 
          xTitle + s + yTitle + s + zTitle;
 }

◆ stringIndex() [1/2]

std::string SingleHistogramDefinition::stringIndex ( ) const

add the folder path to produce the full histogram name e.g. myFolder/myHisto

Definition at line 126 of file SingleHistogramDefinition.cxx.

                                              {
   return stringIndex(name, folder);
 }

◆ stringIndex() [2/2]

std::string SingleHistogramDefinition::stringIndex	(	const std::string &	thisname,
		const std::string &	thisfolder
	)

static

concatenate a sanitised folderName with the histogram name

Definition at line 138 of file SingleHistogramDefinition.cxx.

                                                                                              {
   if (thisfolder.empty()) {
     return thisname;
   }
   const std::string delimiter("/");
   std::string result(thisfolder);
   if ((thisfolder.substr(0, 1)) == delimiter) {
     result = thisfolder.substr(1, thisfolder.size() - 2);// reduce "/myfolder" to "myfolder"
   }
   size_t lastChar(result.size() - 1);
   if ((result.substr(lastChar, 1) != delimiter)) {
     result = result + delimiter; // add a slash: "myfolder" => "myfolder/"
   }
   return result + thisname;
 }

◆ titleDigest()

std::string SingleHistogramDefinition::titleDigest ( ) const

produce single-line representation of the titles (titles separated by the ';' delimiter)

Definition at line 131 of file SingleHistogramDefinition.cxx.

                                              {
   const std::string s(";");
  
   return title + s + xTitle + s + yTitle + s + zTitle;
 }

◆ validType()

bool SingleHistogramDefinition::validType ( ) const

Does the histogram definition have a valid type (TH1, TH2 etc)?

Definition at line 97 of file SingleHistogramDefinition.cxx.

                                            {
   const std::string signature((histoType.substr(0, 3)));
  
   return((signature == "TH1")or(signature == "TH2")or(signature == "TH3")or(signature == "TPr") or(signature == "TEf"));
 }