Gaudi::Histo1DDef Class Reference

Simple helper class for description of 1D-histogram The class is targeted to act as the primary "histogram property", but clearly have significantly wider application range. More...

#include <GaudiKernel/HistoDef.h>

Collaboration diagram for Gaudi::Histo1DDef:

Public Member Functions
	Histo1DDef (double low, double high, int bins=100, std::string title="")
	full constructor from edges, bins and the title More...
	Histo1DDef (std::string title="", double low=0.0, double high=1.0, int bins=100)
	full constructor from edges, bins and the title More...
double	lowEdge () const
	get the low edge More...
double	highEdge () const
	get the high edge More...
int	bins () const
	get the number of bins More...
const std::string &	title () const
	get the title More...
void	setLowEdge (double value)
	set low edge More...
void	setHighEdge (double value)
	set high edge More...
void	setBins (int value)
	set number of bis More...
void	setTitle (std::string value)
	set the title More...
std::ostream &	fillStream (std::ostream &o) const
	printout of the histogram definition More...
bool	ok () const
	check if all fields are "reasonable" More...

Private Attributes
std::string	m_title
	Histogram title. More...
double	m_low
	Low Edge. More...
double	m_high
	High Edge. More...
int	m_bins
	Number of bins. More...

Friends
bool	operator< (const Histo1DDef &left, const Histo1DDef &right)
	ordering operator (to please BoundedVerifier) More...
bool	operator== (const Histo1DDef &left, const Histo1DDef &right)
	equality operator More...
bool	operator!= (const Histo1DDef &left, const Histo1DDef &right)
	non-equality More...
std::ostream &	operator<< (std::ostream &o, const Gaudi::Histo1DDef &histo)
	the streamer operator for class Gaudi::Histo1DDef More...

Detailed Description

Simple helper class for description of 1D-histogram The class is targeted to act as the primary "histogram property", but clearly have significantly wider application range.

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-17

Definition at line 33 of file HistoDef.h.

Constructor & Destructor Documentation

Gaudi::Histo1DDef::Histo1DDef	(	double	low,
		double	high,
		int	bins = 100,
		std::string	title = ""
	)

full constructor from edges, bins and the title

Parameters

low	the low edge of the histogram
high	the high edge of the histogram
bins	number of bins
title	the historgam title

Definition at line 27 of file HistoDef.cpp.

    : m_title( std::move( title ) ), m_low( low ), m_high( high ), m_bins( bins )
{
}

Gaudi::Histo1DDef::Histo1DDef	(	std::string	title = "",
		double	low = 0.0,
		double	high = 1.0,
		int	bins = 100
	)

full constructor from edges, bins and the title

Parameters

title	the historgam title
low	the low edge of the histogram
high	the high edge of the histogram
bins	number of bins

Definition at line 39 of file HistoDef.cpp.

    : m_title( std::move( title ) ), m_low( low ), m_high( high ), m_bins( bins )
{
}

Member Function Documentation

int Gaudi::Histo1DDef::bins ( ) const

inline

get the number of bins

Definition at line 60 of file HistoDef.h.

{ return m_bins; }

std::ostream & Gaudi::Histo1DDef::fillStream

(

std::ostream &

o

)

const

printout of the histogram definition

Definition at line 46 of file HistoDef.cpp.

{
  return o << "(" << Gaudi::Utils::toString( title() ) << "," << lowEdge() << "," << highEdge() << "," << bins() << ")";
}

double Gaudi::Histo1DDef::highEdge ( ) const

inline

get the high edge

Definition at line 58 of file HistoDef.h.

{ return m_high; }

double Gaudi::Histo1DDef::lowEdge ( ) const

inline

get the low edge

Definition at line 56 of file HistoDef.h.

{ return m_low; }

bool Gaudi::Histo1DDef::ok ( ) const

inline

check if all fields are "reasonable"

Definition at line 95 of file HistoDef.h.

{ return 0 < bins() && lowEdge() < highEdge(); }

void Gaudi::Histo1DDef::setBins ( int  value )

inline

set number of bis

Definition at line 71 of file HistoDef.h.

{ m_bins = value; }

void Gaudi::Histo1DDef::setHighEdge ( double  value )

inline

set high edge

Definition at line 69 of file HistoDef.h.

{ m_high = value; }

void Gaudi::Histo1DDef::setLowEdge ( double  value )

inline

set low edge

Definition at line 67 of file HistoDef.h.

{ m_low = value; }

void Gaudi::Histo1DDef::setTitle ( std::string  value )

inline

set the title

Definition at line 73 of file HistoDef.h.

{ m_title = std::move( value ); }

const std::string& Gaudi::Histo1DDef::title ( ) const

inline

get the title

Definition at line 62 of file HistoDef.h.

{ return m_title; }

Friends And Related Function Documentation

bool operator!= ( const Histo1DDef &  left, const Histo1DDef &  right  )

friend

non-equality

Definition at line 80 of file HistoDef.cpp.

{ return !( left == right ); }

bool operator< ( const Histo1DDef &  left, const Histo1DDef &  right  )

friend

ordering operator (to please BoundedVerifier)

Definition at line 55 of file HistoDef.cpp.

  {
    return std::tie( left.m_title, left.m_low, left.m_high, left.m_bins ) <
           std::tie( right.m_title, right.m_low, right.m_high, right.m_bins );
  }

std::ostream& operator<< ( std::ostream &  o, const Gaudi::Histo1DDef &  histo  )

friend

the streamer operator for class Gaudi::Histo1DDef

Definition at line 84 of file HistoDef.cpp.

{ return histo.fillStream( o ); }

bool operator== ( const Histo1DDef &  left, const Histo1DDef &  right  )

friend

equality operator

Definition at line 68 of file HistoDef.cpp.

  {
    return std::tie( left.m_title, left.m_low, left.m_high, left.m_bins ) ==
           std::tie( right.m_title, right.m_low, right.m_high, right.m_bins );
  }

Member Data Documentation

int Gaudi::Histo1DDef::m_bins

private

Number of bins.

Definition at line 106 of file HistoDef.h.

double Gaudi::Histo1DDef::m_high

private

High Edge.

Definition at line 104 of file HistoDef.h.

double Gaudi::Histo1DDef::m_low

private

Low Edge.

Definition at line 102 of file HistoDef.h.

std::string Gaudi::Histo1DDef::m_title

private

Histogram title.

Definition at line 100 of file HistoDef.h.

---

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

• GaudiKernel/GaudiKernel/HistoDef.h
• GaudiKernel/src/Lib/HistoDef.cpp