MuonCalib::VariableBinwidthHistogramBin Class Reference

A bin of a VariableBinwidthHistogram. More...

#include <VariableBinwidthHistogramBin.h>

Collaboration diagram for MuonCalib::VariableBinwidthHistogramBin:

Public Member Functions
	VariableBinwidthHistogramBin ()
	Default constructor.
	VariableBinwidthHistogramBin (double center, double width, unsigned int content)
	Initializing constructor.
void	Set (double center, double width, unsigned int content)
	Set bin.
void	SetContent (unsigned int n)
	set content
VariableBinwidthHistogramBin	operator+= (unsigned int n)
	add to bin content
VariableBinwidthHistogramBin	operator+ (unsigned int n)
	add to bin content
void	MoveRight (double new_right)
	move right bin boarder
void	MoveLeft (double new_left)
	move left bin boarder
double	Center () const
	Get bin center.
double	Width () const
	Get width of the bin.
double	Left () const
	Get left (lower) bin border.
double	Right () const
	Get right (upper) bin border.
unsigned int	Entries () const
	Get number of entries in the bin.
double	Density () const
	Get density=Entries()/Width()

Private Attributes
double	m_center
double	m_width
unsigned int	m_content

Detailed Description

A bin of a VariableBinwidthHistogram.

Author

Felix.nosp@m..Rau.nosp@m.scher.nosp@m.@Phy.nosp@m.sik.U.nosp@m.ni-M.nosp@m.uench.nosp@m.en.D.nosp@m.e

Date

February 2006

Definition at line 22 of file VariableBinwidthHistogramBin.h.

Constructor & Destructor Documentation

VariableBinwidthHistogramBin() [1/2]

MuonCalib::VariableBinwidthHistogramBin::VariableBinwidthHistogramBin ( )

inline

Default constructor.

Definition at line 27 of file VariableBinwidthHistogramBin.h.

: m_center(0.0), m_width(0.0), m_content(0) {}

VariableBinwidthHistogramBin() [2/2]

MuonCalib::VariableBinwidthHistogramBin::VariableBinwidthHistogramBin ( double center, double width, unsigned int content )

inline

Initializing constructor.

Parameters

center	the center of the bin
width	the width of the bin
content	the number of entries in the bin

Definition at line 35 of file VariableBinwidthHistogramBin.h.

                                                                                               :
            m_center(center), m_width(width), m_content(content) {}

Member Function Documentation

Center()

double MuonCalib::VariableBinwidthHistogramBin::Center ( ) const

inline

Get bin center.

Definition at line 105 of file VariableBinwidthHistogramBin.h.

{ return m_center; }

Density()

double MuonCalib::VariableBinwidthHistogramBin::Density ( ) const

inline

Get density=Entries()/Width()

Definition at line 120 of file VariableBinwidthHistogramBin.h.

{ return static_cast<double>(m_content) / m_width; }

Entries()

unsigned int MuonCalib::VariableBinwidthHistogramBin::Entries ( ) const

inline

Get number of entries in the bin.

Definition at line 117 of file VariableBinwidthHistogramBin.h.

{ return m_content; }

Left()

double MuonCalib::VariableBinwidthHistogramBin::Left ( ) const

inline

Get left (lower) bin border.

Definition at line 111 of file VariableBinwidthHistogramBin.h.

{ return m_center - 0.5 * m_width; }

MoveLeft()

void MuonCalib::VariableBinwidthHistogramBin::MoveLeft ( double new_left )

inline

move left bin boarder

Parameters

new_left

left bin boarder

Definition at line 94 of file VariableBinwidthHistogramBin.h.

                                       {
            double right = Right();
            if (new_left > right) {
                throw std::runtime_error(
                    Form("File: %s, Line: %d\nVariableBinwidthHistogramBin::MoveRight() - new left is too small!", __FILE__, __LINE__));
            }
            m_width = right - new_left;
            m_center = 0.5 * (new_left + right);
        }

MoveRight()

void MuonCalib::VariableBinwidthHistogramBin::MoveRight ( double new_right )

inline

move right bin boarder

Parameters

new_right

right bin boarder

Definition at line 80 of file VariableBinwidthHistogramBin.h.

                                         {
            double left = Left();
            if (new_right < left) {
                throw std::runtime_error(
                    Form("File: %s, Line: %d\nVariableBinwidthHistogramBin::MoveRight() - new right is too small!", __FILE__, __LINE__));
            }
            m_width = new_right - left;
            m_center = 0.5 * (left + new_right);
        }

operator+()

VariableBinwidthHistogramBin MuonCalib::VariableBinwidthHistogramBin::operator+ ( unsigned int n )

inline

add to bin content

Parameters

n

is added

Definition at line 70 of file VariableBinwidthHistogramBin.h.

                                                                      {
            VariableBinwidthHistogramBin ret;
            ret += n;
            return ret;
        }

operator+=()

VariableBinwidthHistogramBin MuonCalib::VariableBinwidthHistogramBin::operator+= ( unsigned int n )

inline

add to bin content

Parameters

n

is added

Definition at line 62 of file VariableBinwidthHistogramBin.h.

                                                                       {
            m_content += n;
            return *this;
        }

Right()

double MuonCalib::VariableBinwidthHistogramBin::Right ( ) const

inline

Get right (upper) bin border.

Definition at line 114 of file VariableBinwidthHistogramBin.h.

{ return m_center + 0.5 * m_width; }

Set()

void MuonCalib::VariableBinwidthHistogramBin::Set ( double center, double width, unsigned int content )

inline

Set bin.

Parameters

center	the center of the bin
width	the width of the bin
content	the number of entries in the bin

Definition at line 46 of file VariableBinwidthHistogramBin.h.

                                                                           {
            m_center = center;
            m_width = width;
            m_content = content;
        }

SetContent()

void MuonCalib::VariableBinwidthHistogramBin::SetContent ( unsigned int n )

inline

set content

Parameters

n	new bin content

Definition at line 56 of file VariableBinwidthHistogramBin.h.

{ m_content = n; }

Width()

double MuonCalib::VariableBinwidthHistogramBin::Width ( ) const

inline

Get width of the bin.

Definition at line 108 of file VariableBinwidthHistogramBin.h.

{ return m_width; }

Member Data Documentation

m_center

double MuonCalib::VariableBinwidthHistogramBin::m_center

private

Definition at line 125 of file VariableBinwidthHistogramBin.h.

m_content

unsigned int MuonCalib::VariableBinwidthHistogramBin::m_content

private

Definition at line 126 of file VariableBinwidthHistogramBin.h.

m_width

double MuonCalib::VariableBinwidthHistogramBin::m_width

private

Definition at line 125 of file VariableBinwidthHistogramBin.h.

---

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

• VariableBinwidthHistogramBin.h