IHistogram Class Reference

Description

Base class for 1D and 2D histograms holding values of double type.

Inheritance diagram for IHistogram:

Public Member Functions
	IHistogram (const IAxis &axis_x)
	IHistogram (const IAxis &axis_x, const IAxis &axis_y)
	IHistogram (const IHistogram &other)
	IHistogram (std::vector< IAxis * > axes, const std::vector< CumulativeValue > &data)
	IHistogram (std::vector< IAxis * > axes, std::vector< double > data)
virtual	~IHistogram ()
Powerfield *	avgPowerfield () const
	Returns new Powerfield with histogram's shape and averaged content. More...
double	binContent (size_t i) const
	Returns content (accumulated value) of bin i. More...
virtual IHistogram *	clone () const =0
const Frame &	frame () const
	Returns Frame, which holds all axes. More...
bool	hasSameShape (const IHistogram &other) const
	Returns true if objects a) have same dimensions b) bin boundaries of axes coincide. More...
bool	hasSameSizes (const IHistogram &other) const
	Returns true if object have same rank and number of axes bins. More...
PyObject *	npArray () const
	Returns numpy array with bin content (normalized values). More...
size_t	rank () const
	Returns number of histogram dimensions. More...
size_t	size () const
	Returns total number of histogram bins. For 2D histograms the result will be the product of bin numbers along X and Y axes. More...
const IAxis &	xAxis () const
	Returns x-axis. More...
const IAxis &	yAxis () const
	Returns y-axis for 2D histograms. More...

Protected Member Functions
std::vector< double >	flatVector () const
std::vector< double >	rawVector () const
std::vector< double >	stdvVector () const

Protected Attributes
const std::unique_ptr< const Frame >	m_frame
std::vector< CumulativeValue >	m_vec

Constructor & Destructor Documentation

IHistogram() [1/5]

IHistogram::IHistogram	(	std::vector< IAxis * >	axes,
		std::vector< double >	data
	)

IHistogram() [2/5]

IHistogram::IHistogram

(

const IAxis &

axis_x

)

IHistogram() [3/5]

IHistogram::IHistogram	(	const IAxis &	axis_x,
		const IAxis &	axis_y
	)

IHistogram() [4/5]

IHistogram::IHistogram	(	std::vector< IAxis * >	axes,
		const std::vector< CumulativeValue > &	data
	)

IHistogram() [5/5]

IHistogram::IHistogram

(

const IHistogram &

other

)

~IHistogram()

virtual IHistogram::~IHistogram ( )

virtual

Member Function Documentation

avgPowerfield()

Powerfield* IHistogram::avgPowerfield

(

)

const

Returns new Powerfield with histogram's shape and averaged content.

binContent()

double IHistogram::binContent

(

size_t

i

)

const

Returns content (accumulated value) of bin i.

clone()

virtual IHistogram* IHistogram::clone ( ) const

pure virtual

Implemented in Histogram2D, and Histogram1D.

flatVector()

std::vector<double> IHistogram::flatVector ( ) const

protected

frame()

const Frame& IHistogram::frame

(

)

const

Returns Frame, which holds all axes.

hasSameShape()

bool IHistogram::hasSameShape

(

const IHistogram &

other

)

const

Returns true if objects a) have same dimensions b) bin boundaries of axes coincide.

hasSameSizes()

bool IHistogram::hasSameSizes

(

const IHistogram &

other

)

const

Returns true if object have same rank and number of axes bins.

npArray()

PyObject* IHistogram::npArray

(

)

const

Returns numpy array with bin content (normalized values).

rank()

size_t IHistogram::rank

(

)

const

Returns number of histogram dimensions.

rawVector()

std::vector<double> IHistogram::rawVector ( ) const

protected

size()

size_t IHistogram::size

(

)

const

Returns total number of histogram bins. For 2D histograms the result will be the product of bin numbers along X and Y axes.

stdvVector()

std::vector<double> IHistogram::stdvVector ( ) const

protected

xAxis()

const IAxis& IHistogram::xAxis

(

)

const

Returns x-axis.

yAxis()

const IAxis& IHistogram::yAxis

(

)

const

Returns y-axis for 2D histograms.

Member Data Documentation

m_frame

const std::unique_ptr<const Frame> IHistogram::m_frame

protected

m_vec

std::vector<CumulativeValue> IHistogram::m_vec

protected