This class is used for creating TH1F and TH2F objects. More...

#include <HistogramFactory.h>

Public Member Functions
	Factory (DQMHistoModuleBase *histoModule)
	Constructor.

Factory &	xAxis (const Axis &axis)
	Temporarily copies parameters for x axis from given Axis.

Factory &	yAxis (const Axis &axis)
	Temporarily copies parameters for y axis from given Axis.

Factory &	xAxisDefault (const Axis &axis)
	Permanently copies parameters for x axis from given Axis.

Factory &	yAxisDefault (const Axis &axis)
	Permanently copies parameters for y axis from given Axis.

TH1F *	CreateTH1F (std::string name, std::string title)
	Create TH1F with given name and title.

TH2F *	CreateTH2F (std::string name, std::string title)
	Create TH2F with given name and title.

TH1F **	CreateLayersTH1F (boost::format nameTemplate, boost::format titleTemplate)
	Create TH1F array for layers from given name template and title template.

TH2F **	CreateLayersTH2F (boost::format nameTemplate, boost::format titleTemplate)
	Create TH2F array for layers from given name template and title template.

TH1F **	CreateSensorsTH1F (boost::format nameTemplate, boost::format titleTemplate)
	Create TH1F array for sensors from given name template and title template.

TH2F **	CreateSensorsTH2F (boost::format nameTemplate, boost::format titleTemplate)
	Create TH2F array for sensors from given name template and title template.

-Default functions
All the following functions permanently set the value of given parameter. They also return this instance so they can be chained.
Factory &	nbinsxDefault (int nbinsx)
	Sets nbinsx permanently.

Factory &	xlowDefault (double xlow)
	Sets xlow permanently.

Factory &	xupDefault (double xup)
	Sets xup permanently.

Factory &	nbinsyDefault (int nbinsy)
	Sets nbinsy permanently.

Factory &	ylowDefault (double ylow)
	Sets ylow permanently.

Factory &	yupDefault (double yup)
	Sets yup permanently.

Factory &	xTitleDefault (std::string xTitle)
	Sets xTitle permanently.

Factory &	yTitleDefault (std::string yTitle)
	Sets yTitle permanently.

Factory &	zTitleDefault (std::string zTitle)
	Sets zTitle permanently.

Named parameters
All the following functions temporarily set the value of given parameter. This means that its value is invalidated after its first use in the Create- functions. They also return this instance so they can be chained.
Factory &	nbinsx (int nbinsx)
	Sets nbinsx temporarily.

Factory &	xlow (double xlow)
	Sets xlow temporarily.

Factory &	xup (double xup)
	Sets xup temporarily.

Factory &	nbinsy (int nbinsy)
	Sets nbinsy temporarily.

Factory &	ylow (double ylow)
	Sets ylow temporarily.

Factory &	yup (double yup)
	Sets yup temporarily.

Factory &	xTitle (std::string xTitle)
	Sets xTitle temporarily.

Factory &	yTitle (std::string yTitle)
	Sets yTitle temporarily.

Factory &	zTitle (std::string zTitle)
	Sets zTitle temporarily.

Private Attributes
DQMHistoModuleBase *	m_histoModule
	DQM histogram module on which the Create- functions are called to create histograms.

Parameter< int >	m_nbinsx = Parameter(0)
	number of bins along the x axis

Parameter< double >	m_xlow = Parameter(.0)
	lower boundary of x axis range

Parameter< double >	m_xup = Parameter(.0)
	upper boundary of x axis range

Parameter< std::string >	m_xTitle = Parameter(std::string())
	title of the x axis

Parameter< std::string >	m_yTitle = Parameter(std::string())
	title of the y axis

Parameter< int >	m_nbinsy = Parameter(0)
	number of bins along the y axis

Parameter< double >	m_ylow = Parameter(.0)
	lower boundary of y axis range

Parameter< double >	m_yup = Parameter(.0)
	upper boundary of y axis range

Parameter< std::string >	m_zTitle = Parameter(std::string())
	title of the z axis

Detailed Description

This class is used for creating TH1F and TH2F objects.

Its main advantage is that parameters can be set individually and also permanently so they can be reused again.

This class uses named parameters idiom via temporarily set values.

Most of the methods return this object so they can be chained consecutively.

Definition at line 151 of file HistogramFactory.h.

Constructor & Destructor Documentation

◆ Factory()

Factory ( DQMHistoModuleBase * histoModule )

inlineexplicit

Constructor.

Parameters

histoModule - pointer on histogram module is needed because this class actually doesn't create histograms by itself, but it calls functions on the module instead.

Definition at line 155 of file HistogramFactory.h.

    {
      m_histoModule = histoModule;
    }

Member Function Documentation

◆ CreateLayersTH1F()

TH1F ** CreateLayersTH1F	(	boost::format	nameTemplate,
		boost::format	titleTemplate
	)

Create TH1F array for layers from given name template and title template.

Definition at line 24 of file HistogramFactory.cc.

{
  return m_histoModule->CreateLayers(nameTemplate, titleTemplate, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_xTitle.Get(),
                                     m_yTitle.Get());
}

◆ CreateLayersTH2F()

TH2F ** CreateLayersTH2F	(	boost::format	nameTemplate,
		boost::format	titleTemplate
	)

Create TH2F array for layers from given name template and title template.

Definition at line 30 of file HistogramFactory.cc.

{
  return m_histoModule->CreateLayers(nameTemplate, titleTemplate, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_nbinsy.Get(),
                                     m_ylow.Get(), m_yup.Get(), m_xTitle.Get(), m_yTitle.Get(), m_zTitle.Get());
}

◆ CreateSensorsTH1F()

TH1F ** CreateSensorsTH1F	(	boost::format	nameTemplate,
		boost::format	titleTemplate
	)

Create TH1F array for sensors from given name template and title template.

Definition at line 36 of file HistogramFactory.cc.

{
  return m_histoModule->CreateSensors(nameTemplate, titleTemplate, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_xTitle.Get(),
                                      m_yTitle.Get());
}

◆ CreateSensorsTH2F()

TH2F ** CreateSensorsTH2F	(	boost::format	nameTemplate,
		boost::format	titleTemplate
	)

Create TH2F array for sensors from given name template and title template.

Definition at line 42 of file HistogramFactory.cc.

{
  return m_histoModule->CreateSensors(nameTemplate, titleTemplate, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_nbinsy.Get(),
                                      m_ylow.Get(), m_yup.Get(), m_xTitle.Get(), m_yTitle.Get(), m_zTitle.Get());
}

◆ CreateTH1F()

TH1F * CreateTH1F	(	std::string	name,
		std::string	title
	)

Create TH1F with given name and title.

All temporarily set parameters needed to create the TH1F become invalidated. This is common for all following Create- functions.

Definition at line 13 of file HistogramFactory.cc.

{
  return m_histoModule->Create(name, title, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_xTitle.Get(), m_yTitle.Get());
}

◆ CreateTH2F()

TH2F * CreateTH2F	(	std::string	name,
		std::string	title
	)

Create TH2F with given name and title.

Definition at line 18 of file HistogramFactory.cc.

{
  return m_histoModule->Create(name, title, m_nbinsx.Get(), m_xlow.Get(), m_xup.Get(), m_nbinsy.Get(), m_ylow.Get(), m_yup.Get(),
                               m_xTitle.Get(), m_yTitle.Get(), m_zTitle.Get());
}

◆ nbinsx()

Factory & nbinsx ( int nbinsx )

inline

Sets nbinsx temporarily.

Definition at line 238 of file HistogramFactory.h.

◆ nbinsxDefault()

Factory & nbinsxDefault ( int nbinsx )

inline

Sets nbinsx permanently.

Definition at line 223 of file HistogramFactory.h.

◆ nbinsy()

Factory & nbinsy ( int nbinsy )

inline

Sets nbinsy temporarily.

Definition at line 241 of file HistogramFactory.h.

◆ nbinsyDefault()

Factory & nbinsyDefault ( int nbinsy )

inline

Sets nbinsy permanently.

Definition at line 226 of file HistogramFactory.h.

◆ xAxis()

Factory & xAxis ( const Axis & axis )

inline

Temporarily copies parameters for x axis from given Axis.

Definition at line 161 of file HistogramFactory.h.

    {
      m_nbinsx.SetTemporarily(axis.m_nbins);
      m_xlow.SetTemporarily(axis.m_low);
      m_xup.SetTemporarily(axis.m_up);
      m_xTitle.SetTemporarily(axis.m_title);
 
      return *this;
    }

◆ xAxisDefault()

Factory & xAxisDefault ( const Axis & axis )

inline

Permanently copies parameters for x axis from given Axis.

Definition at line 183 of file HistogramFactory.h.

    {
      m_nbinsx.Set(axis.m_nbins);
      m_xlow.Set(axis.m_low);
      m_xup.Set(axis.m_up);
      m_xTitle.Set(axis.m_title);
 
      return *this;
    }

◆ xlow()

Factory & xlow ( double xlow )

inline

Sets xlow temporarily.

Definition at line 239 of file HistogramFactory.h.

◆ xlowDefault()

Factory & xlowDefault ( double xlow )

inline

Sets xlow permanently.

Definition at line 224 of file HistogramFactory.h.

◆ xTitle()

Factory & xTitle ( std::string xTitle )

inline

Sets xTitle temporarily.

Definition at line 244 of file HistogramFactory.h.

◆ xTitleDefault()

Factory & xTitleDefault ( std::string xTitle )

inline

Sets xTitle permanently.

Definition at line 229 of file HistogramFactory.h.

◆ xup()

Factory & xup ( double xup )

inline

Sets xup temporarily.

Definition at line 240 of file HistogramFactory.h.

◆ xupDefault()

Factory & xupDefault ( double xup )

inline

Sets xup permanently.

Definition at line 225 of file HistogramFactory.h.

◆ yAxis()

Factory & yAxis ( const Axis & axis )

inline

Temporarily copies parameters for y axis from given Axis.

Definition at line 172 of file HistogramFactory.h.

    {
      m_nbinsy.SetTemporarily(axis.m_nbins);
      m_ylow.SetTemporarily(axis.m_low);
      m_yup.SetTemporarily(axis.m_up);
      m_yTitle.SetTemporarily(axis.m_title);
 
      return *this;
    }

◆ yAxisDefault()

Factory & yAxisDefault ( const Axis & axis )

inline

Permanently copies parameters for y axis from given Axis.

Definition at line 194 of file HistogramFactory.h.

    {
      m_nbinsy.Set(axis.m_nbins);
      m_ylow.Set(axis.m_low);
      m_yup.Set(axis.m_up);
      m_yTitle.Set(axis.m_title);
 
      return *this;
    }

◆ ylow()

Factory & ylow ( double ylow )

inline

Sets ylow temporarily.

Definition at line 242 of file HistogramFactory.h.

◆ ylowDefault()

Factory & ylowDefault ( double ylow )

inline

Sets ylow permanently.

Definition at line 227 of file HistogramFactory.h.

◆ yTitle()

Factory & yTitle ( std::string yTitle )

inline

Sets yTitle temporarily.

Definition at line 245 of file HistogramFactory.h.

◆ yTitleDefault()

Factory & yTitleDefault ( std::string yTitle )

inline

Sets yTitle permanently.

Definition at line 230 of file HistogramFactory.h.

◆ yup()

Factory & yup ( double yup )

inline

Sets yup temporarily.

Definition at line 243 of file HistogramFactory.h.

◆ yupDefault()

Factory & yupDefault ( double yup )

inline

Sets yup permanently.

Definition at line 228 of file HistogramFactory.h.

◆ zTitle()

Factory & zTitle ( std::string zTitle )

inline

Sets zTitle temporarily.

Definition at line 246 of file HistogramFactory.h.

◆ zTitleDefault()

Factory & zTitleDefault ( std::string zTitle )

inline

Sets zTitle permanently.

Definition at line 231 of file HistogramFactory.h.

Member Data Documentation

◆ m_histoModule

DQMHistoModuleBase* m_histoModule

private

DQM histogram module on which the Create- functions are called to create histograms.

Definition at line 251 of file HistogramFactory.h.

◆ m_nbinsx

Parameter<int> m_nbinsx = Parameter(0)

private

number of bins along the x axis

Definition at line 253 of file HistogramFactory.h.

◆ m_nbinsy

Parameter<int> m_nbinsy = Parameter(0)

private

number of bins along the y axis

Definition at line 258 of file HistogramFactory.h.

◆ m_xlow

Parameter<double> m_xlow = Parameter(.0)

private

lower boundary of x axis range

Definition at line 254 of file HistogramFactory.h.

◆ m_xTitle

Parameter<std::string> m_xTitle = Parameter(std::string())

private

title of the x axis

Definition at line 256 of file HistogramFactory.h.

◆ m_xup

Parameter<double> m_xup = Parameter(.0)

private

upper boundary of x axis range

Definition at line 255 of file HistogramFactory.h.

◆ m_ylow

Parameter<double> m_ylow = Parameter(.0)

private

lower boundary of y axis range

Definition at line 259 of file HistogramFactory.h.

◆ m_yTitle

Parameter<std::string> m_yTitle = Parameter(std::string())

private

title of the y axis

Definition at line 257 of file HistogramFactory.h.

◆ m_yup

Parameter<double> m_yup = Parameter(.0)

private

upper boundary of y axis range

Definition at line 260 of file HistogramFactory.h.

◆ m_zTitle

Parameter<std::string> m_zTitle = Parameter(std::string())

private

title of the z axis

Definition at line 261 of file HistogramFactory.h.

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

tracking/dqmUtils/include/HistogramFactory.h
tracking/dqmUtils/src/HistogramFactory.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Factory()

Member Function Documentation

◆ CreateLayersTH1F()

◆ CreateLayersTH2F()

◆ CreateSensorsTH1F()

◆ CreateSensorsTH2F()

◆ CreateTH1F()

◆ CreateTH2F()

◆ nbinsx()

◆ nbinsxDefault()

◆ nbinsy()

◆ nbinsyDefault()

◆ xAxis()

◆ xAxisDefault()

◆ xlow()

◆ xlowDefault()

◆ xTitle()

◆ xTitleDefault()

◆ xup()

◆ xupDefault()

◆ yAxis()

◆ yAxisDefault()

◆ ylow()

◆ ylowDefault()

◆ yTitle()

◆ yTitleDefault()

◆ yup()

◆ yupDefault()

◆ zTitle()

◆ zTitleDefault()

Member Data Documentation

◆ m_histoModule

◆ m_nbinsx

◆ m_nbinsy

◆ m_xlow

◆ m_xTitle

◆ m_xup

◆ m_ylow

◆ m_yTitle

◆ m_yup

◆ m_zTitle