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:

[legend]

Public Member Functions
	Histo1DDef (const double low, const double high, const int bins=100, const std::string &title="")
	full constructor from edges, #bins and the title

	Histo1DDef (const std::string &title="", const double low=0.0, const double high=1.0, const int bins=100)
	full constructor from edges, #bins and the title

virtual	~Histo1DDef ()
	destructor

double	lowEdge () const
	get the low edge

double	highEdge () const
	get the high edge

int	bins () const
	get the number of bins

const std::string &	title () const
	get the title

void	setLowEdge (const double value)
	set low edge

void	setHighEdge (const double value)
	set high edge

void	setBins (const int value)
	set number of bis

void	setTitle (const std::string &value)
	set the title

std::ostream &	fillStream (std::ostream &o) const
	printout of the histogram definition

bool	operator< (const Histo1DDef &right) const
	ordering operator (to please BoundedVerifier)

bool	operator== (const Histo1DDef &right) const
	equality operator

bool	operator!= (const Histo1DDef &right) const
	non-equality

bool	ok () const
	check if all fields are "reasonable"

	Histo1DDef (const double low, const double high, const int bins=100, const std::string &title="")
	full constructor from edges, #bins and the title

	Histo1DDef (const std::string &title="", const double low=0.0, const double high=1.0, const int bins=100)
	full constructor from edges, #bins and the title

virtual	~Histo1DDef ()
	destructor

double	lowEdge () const
	get the low edge

double	highEdge () const
	get the high edge

int	bins () const
	get the number of bins

const std::string &	title () const
	get the title

void	setLowEdge (const double value)
	set low edge

void	setHighEdge (const double value)
	set high edge

void	setBins (const int value)
	set number of bis

void	setTitle (const std::string &value)
	set the title

std::ostream &	fillStream (std::ostream &o) const
	printout of the histogram definition

bool	operator< (const Histo1DDef &right) const
	ordering operator (to please BoundedVerifier)

bool	operator== (const Histo1DDef &right) const
	equality operator

bool	operator!= (const Histo1DDef &right) const
	non-equality

bool	ok () const
	check if all fields are "reasonable"

Private Attributes
std::string	m_title
	Histogram title.

double	m_low
	Low Edge.

double	m_high
	High Edge.

int	m_bins
	Number of bins.

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 32 of file HistoDef.h.

Constructor & Destructor Documentation

Gaudi::Histo1DDef::Histo1DDef	(	const double	low,
		const double	high,
		const int	bins = `100`,
		const 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 29 of file HistoDef.cpp.

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

Gaudi::Histo1DDef::Histo1DDef	(	const std::string &	title = `""`,
		const double	low = `0.0`,
		const double	high = `1.0`,
		const 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 47 of file HistoDef.cpp.

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

Gaudi::Histo1DDef::~Histo1DDef ( )

virtual

destructor

virtual destructor

Definition at line 59 of file HistoDef.cpp.

{}

Gaudi::Histo1DDef::Histo1DDef	(	const double	low,
		const double	high,
		const int	bins = `100`,
		const 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

Gaudi::Histo1DDef::Histo1DDef	(	const std::string &	title = `""`,
		const double	low = `0.0`,
		const double	high = `1.0`,
		const 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

virtual Gaudi::Histo1DDef::~Histo1DDef ( )

virtual

destructor

virtual destructor

Member Function Documentation

int Gaudi::Histo1DDef::bins ( ) const

inline

get the number of bins

Definition at line 70 of file HistoDef.h.

{ return m_bins ; }

int Gaudi::Histo1DDef::bins ( ) const

inline

get the number of bins

Definition at line 70 of file HistoDef.h.

{ return m_bins ; }

std::ostream & Gaudi::Histo1DDef::fillStream ( std::ostream & o ) const

printout of the histogram definition

Definition at line 63 of file HistoDef.cpp.

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

std::ostream& Gaudi::Histo1DDef::fillStream ( std::ostream & o ) const

printout of the histogram definition

double Gaudi::Histo1DDef::highEdge ( ) const

inline

get the high edge

Definition at line 68 of file HistoDef.h.

{ return m_high ; }

double Gaudi::Histo1DDef::highEdge ( ) const

inline

get the high edge

Definition at line 68 of file HistoDef.h.

{ return m_high ; }

double Gaudi::Histo1DDef::lowEdge ( ) const

inline

get the low edge

Definition at line 66 of file HistoDef.h.

{ return m_low ; }

double Gaudi::Histo1DDef::lowEdge ( ) const

inline

get the low edge

Definition at line 66 of file HistoDef.h.

{ return m_low ; }

bool Gaudi::Histo1DDef::ok ( ) const

inline

check if all fields are "reasonable"

Definition at line 102 of file HistoDef.h.

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

bool Gaudi::Histo1DDef::ok ( ) const

inline

check if all fields are "reasonable"

Definition at line 102 of file HistoDef.h.

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

bool Gaudi::Histo1DDef::operator!= ( const Histo1DDef & right ) const

non-equality

Definition at line 107 of file HistoDef.cpp.

{ return !( *this == right ) ; }

bool Gaudi::Histo1DDef::operator!= ( const Histo1DDef & right ) const

non-equality

bool Gaudi::Histo1DDef::operator< ( const Histo1DDef & right ) const

ordering operator (to please BoundedVerifier)

Definition at line 73 of file HistoDef.cpp.

{
  return
    this      ==  &right             ? false :
    title    () <  right.title    () ? true  :
    title    () >  right.title    () ? false :
    lowEdge  () <  right.lowEdge  () ? true  :
    lowEdge  () >  right.lowEdge  () ? false :
    highEdge () <  right.highEdge () ? true  :
    highEdge () >  right.highEdge () ? false : bins () < right.bins () ;
}

bool Gaudi::Histo1DDef::operator< ( const Histo1DDef & right ) const

ordering operator (to please BoundedVerifier)

bool Gaudi::Histo1DDef::operator== ( const Histo1DDef & right ) const

equality operator

Definition at line 92 of file HistoDef.cpp.

{
  return ( this == &right ) ||
    ( title    () == right.title    () &&
      lowEdge  () == right.lowEdge  () &&
      highEdge () == right.highEdge () &&
      bins     () == right.bins     () );
}

bool Gaudi::Histo1DDef::operator== ( const Histo1DDef & right ) const

equality operator

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

inline

set number of bis

Definition at line 81 of file HistoDef.h.

{ m_bins = value ; }

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

inline

set number of bis

Definition at line 81 of file HistoDef.h.

{ m_bins = value ; }

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

inline

set high edge

Definition at line 79 of file HistoDef.h.

{ m_high = value ; }

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

inline

set high edge

Definition at line 79 of file HistoDef.h.

{ m_high = value ; }

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

inline

set low edge

Definition at line 77 of file HistoDef.h.

{ m_low = value ; }

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

inline

set low edge

Definition at line 77 of file HistoDef.h.

{ m_low = value ; }

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

inline

set the title

Definition at line 83 of file HistoDef.h.

{ m_title = value ; }

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

inline

set the title

Definition at line 83 of file HistoDef.h.

{ m_title = value ; }

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

inline

get the title

Definition at line 72 of file HistoDef.h.

{ return m_title ; }

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

inline

get the title

Definition at line 72 of file HistoDef.h.

{ return m_title ; }

Member Data Documentation

int Gaudi::Histo1DDef::m_bins

private

Number of bins.

Definition at line 113 of file HistoDef.h.

double Gaudi::Histo1DDef::m_high

private

High Edge.

Definition at line 111 of file HistoDef.h.

double Gaudi::Histo1DDef::m_low

private

Low Edge.

Definition at line 109 of file HistoDef.h.

std::string Gaudi::Histo1DDef::m_title

private

Histogram title.

Definition at line 107 of file HistoDef.h.

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

InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/HistoDef.h
InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/HistoDef.h
GaudiKernel/src/Lib/HistoDef.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation