Histogram2D Class Reference

Inheritance diagram for Histogram2D:

Collaboration diagram for Histogram2D:

Public Types
enum	DataType { INTEGRAL , AVERAGE , STANDARD_ERROR , NENTRIES }

Public Member Functions
	Histogram2D (int nbinsx, double xlow, double xup, int nbinsy, double ylow, double yup)
	Histogram2D (int nbinsx, const std::vector< double > &xbins, int nbinsy, const std::vector< double > &ybins)
	Histogram2D (const IAxis &axis_x, const IAxis &axis_y)
	Histogram2D (const OutputData< double > &data)
	Histogram2D (std::vector< std::vector< double >> data)
Histogram2D *	clone () const
size_t	getRank () const
int	fill (double x, double y, double weight=1.0)
Histogram1D *	projectionX ()
Histogram1D *	projectionX (double yvalue)
Histogram1D *	projectionX (double ylow, double yup)
Histogram1D *	projectionY ()
Histogram1D *	projectionY (double xvalue)
Histogram1D *	projectionY (double xlow, double xup)
Histogram2D *	crop (double xmin, double ymin, double xmax, double ymax)
void	setContent (const std::vector< std::vector< double >> &data)
void	addContent (const std::vector< std::vector< double >> &data)
size_t	getTotalNumberOfBins () const
const IAxis &	getXaxis () const
const IAxis &	getYaxis () const
double	getXmin () const
double	getXmax () const
size_t	getNbinsX () const
double	getYmin () const
double	getYmax () const
size_t	getNbinsY () const
size_t	getGlobalBin (size_t binx, size_t biny=0) const
size_t	findGlobalBin (double x, double y) const
size_t	getXaxisIndex (size_t i) const
size_t	getYaxisIndex (size_t i) const
double	getXaxisValue (size_t i)
double	getYaxisValue (size_t i)
double	getBinContent (size_t i) const
double	getBinContent (size_t binx, size_t biny) const
const OutputData< CumulativeValue > &	getData () const
OutputData< CumulativeValue > &	getData ()
void	setBinContent (size_t i, double value)
void	addBinContent (size_t i, double value)
double	getBinError (size_t i) const
double	getBinError (size_t binx, size_t biny) const
double	getBinAverage (size_t i) const
double	getBinAverage (size_t binx, size_t biny) const
int	getBinNumberOfEntries (size_t i) const
int	getBinNumberOfEntries (size_t binx, size_t biny) const
double	getMaximum () const
size_t	getMaximumBinIndex () const
double	getMinimum () const
size_t	getMinimumBinIndex () const
void	scale (double value)
double	integral () const
PyObject *	array (DataType dataType=DataType::INTEGRAL) const
PyObject *	getArray (DataType dataType=DataType::INTEGRAL) const
void	reset ()
OutputData< double > *	createOutputData (DataType dataType=DataType::INTEGRAL) const
bool	hasSameShape (const IHistogram &other) const
bool	hasSameDimensions (const IHistogram &other) const
const IHistogram &	operator+= (const IHistogram &right)
IHistogram *	relativeDifferenceHistogram (const IHistogram &rhs)
void	save (const std::string &filename)
void	load (const std::string &filename)

Static Public Member Functions
static IHistogram *	createHistogram (const OutputData< double > &source)
static IHistogram *	createFrom (const std::string &filename)
static IHistogram *	createFrom (const std::vector< std::vector< double >> &data)

Protected Member Functions
template<typename T >
void	initFromShape (const T &data)
Histogram1D *	create_projectionX (int ybinlow, int ybinup)
Histogram1D *	create_projectionY (int xbinlow, int xbinup)
void	check_x_axis () const
void	check_y_axis () const
void	init_from_data (const OutputData< double > &source)
double	getBinData (size_t i, DataType dataType) const
std::vector< double >	getDataVector (DataType dataType) const
void	copyContentFrom (const IHistogram &other)

Protected Attributes
OutputData< CumulativeValue >	m_data

Detailed Description

Two dimensional histogram.

Definition at line 24 of file Histogram2D.h.

Member Enumeration Documentation

DataType

enum IHistogram::DataType

inherited

Enumerator
INTEGRAL
AVERAGE
STANDARD_ERROR
NENTRIES

Definition at line 29 of file IHistogram.h.

{ INTEGRAL, AVERAGE, STANDARD_ERROR, NENTRIES };

Constructor & Destructor Documentation

Histogram2D() [1/5]

Histogram2D::Histogram2D	(	int	nbinsx,
		double	xlow,
		double	xup,
		int	nbinsy,
		double	ylow,
		double	yup
	)

Constructor for fix bin size histograms.

Parameters

nbinsx	number of bins on X-axis
xlow	low edge of the first bin of X-axis
xup	upper edge of the last bin of X-axis
nbinsy	number of bins on Y axis
ylow	low edge of the first bin of Y-axis
yup	upper edge of the last bin of Y-axis

Definition at line 20 of file Histogram2D.cpp.

{
    m_data.addAxis(FixedBinAxis("x-axis", nbinsx, xlow, xup));
    m_data.addAxis(FixedBinAxis("y-axis", nbinsy, ylow, yup));
}

References OutputData< T >::addAxis(), and IHistogram::m_data.

Referenced by clone(), and crop().

Here is the call graph for this function:

Histogram2D() [2/5]

Histogram2D::Histogram2D	(	int	nbinsx,
		const std::vector< double > &	xbins,
		int	nbinsy,
		const std::vector< double > &	ybins
	)

Constructor for variable bin size histograms.

Parameters

nbinsx	number of bins on X-axis
xbins	Array of size nbins+1 containing low-edges for each bin and upper edge of last bin.
nbinsy	number of bins on Y-axis
ybins	Array of size nbins+1 containing low-edges for each bin and upper edge of last bin.

Definition at line 26 of file Histogram2D.cpp.

{
    m_data.addAxis(VariableBinAxis("x-axis", nbinsx, xbins));
    m_data.addAxis(VariableBinAxis("y-axis", nbinsy, ybins));
}

References OutputData< T >::addAxis(), and IHistogram::m_data.

Here is the call graph for this function:

Histogram2D() [3/5]

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

Constructor for 2D histogram with custom axes.

Definition at line 33 of file Histogram2D.cpp.

: IHistogram(axis_x, axis_y) {}

Histogram2D() [4/5]

Histogram2D::Histogram2D

(

const OutputData< double > &

data

)

Constructor for 2D histograms from basic OutputData object.

Definition at line 35 of file Histogram2D.cpp.

{
    init_from_data(data);
}

References IHistogram::init_from_data().

Here is the call graph for this function:

Histogram2D() [5/5]

Histogram2D::Histogram2D

(

std::vector< std::vector< double >>

data

)

Constructor for 2D histograms from numpy array (thanks to swig)

Definition at line 41 of file Histogram2D.cpp.

{
    initFromShape(data);
    this->setContent(data);
}

References initFromShape(), and setContent().

Here is the call graph for this function:

Member Function Documentation

clone()

Histogram2D * Histogram2D::clone ( ) const

virtual

Returns clone of other histogram.

Implements IHistogram.

Definition at line 47 of file Histogram2D.cpp.

{
    return new Histogram2D(*this);
}

References Histogram2D().

Here is the call graph for this function:

getRank()

size_t Histogram2D::getRank ( ) const

inlinevirtual

Returns the number of histogram dimensions.

Implements IHistogram.

Definition at line 59 of file Histogram2D.h.

{ return 2; }

fill()

int Histogram2D::fill	(	double	x,
		double	y,
		double	weight = 1.0
	)

Increment bin with abscissa x and ordinate y with a weight.

Definition at line 52 of file Histogram2D.cpp.

{
    if (x < getXaxis().getMin() || x >= getXaxis().getMax())
        return -1;
    if (y < getYaxis().getMin() || y >= getYaxis().getMax())
        return -1;
    size_t index = m_data.findGlobalIndex({x, y});
    m_data[index].add(weight);
    return (int)index;
}

References OutputData< T >::findGlobalIndex(), IHistogram::getXaxis(), IHistogram::getYaxis(), and IHistogram::m_data.

Here is the call graph for this function:

projectionX() [1/3]

Histogram1D * Histogram2D::projectionX

(

)

Project a 2D histogram into 1D histogram along X.

The projection is made from all bins along y-axis.

Definition at line 63 of file Histogram2D.cpp.

{
    return create_projectionX(0, static_cast<int>(getXaxis().size()) - 1);
}

References create_projectionX(), and IHistogram::getXaxis().

Here is the call graph for this function:

projectionX() [2/3]

Histogram1D * Histogram2D::projectionX

(

double

yvalue

)

Project a 2D histogram into 1D histogram along X.

The projection is made from the y-bin closest to given ordinate yvalue.

Parameters

yvalue

the value on y-axis at which projection is taken

Definition at line 68 of file Histogram2D.cpp.

{
    int ybin_selected = static_cast<int>(getYaxis().findClosestIndex(yvalue));
    return create_projectionX(ybin_selected, ybin_selected);
}

References create_projectionX(), IAxis::findClosestIndex(), and IHistogram::getYaxis().

Here is the call graph for this function:

projectionX() [3/3]

Histogram1D * Histogram2D::projectionX	(	double	ylow,
		double	yup
	)

Project a 2D histogram into 1D histogram along X.

The projection is made from all y-bins corresponding to ordinate between ylow and yup.

Parameters

ylow	lower edje on y-axis
yup	upper edje on y-axis

Definition at line 74 of file Histogram2D.cpp.

{
    int ybinlow = static_cast<int>(getYaxis().findClosestIndex(ylow));
    int ybinup = static_cast<int>(getYaxis().findClosestIndex(yup));
    return create_projectionX(ybinlow, ybinup);
}

References create_projectionX(), IAxis::findClosestIndex(), and IHistogram::getYaxis().

Here is the call graph for this function:

projectionY() [1/3]

Histogram1D * Histogram2D::projectionY

(

)

Project a 2D histogram into 1D histogram along Y.

The projection is made from all bins along x-axis.

Definition at line 81 of file Histogram2D.cpp.

{
    return create_projectionY(0, static_cast<int>(getXaxis().size()) - 1);
}

References create_projectionY(), and IHistogram::getXaxis().

Here is the call graph for this function:

projectionY() [2/3]

Histogram1D * Histogram2D::projectionY

(

double

xvalue

)

Project a 2D histogram into 1D histogram along Y.

The projection is made from the x-bin closest to given abscissa xvalue.

Parameters

xvalue

the value on x-axis at which projection is taken

Definition at line 86 of file Histogram2D.cpp.

{
    int xbin_selected = static_cast<int>(getXaxis().findClosestIndex(xvalue));
    return create_projectionY(xbin_selected, xbin_selected);
}

References create_projectionY(), IAxis::findClosestIndex(), and IHistogram::getXaxis().

Here is the call graph for this function:

projectionY() [3/3]

Histogram1D * Histogram2D::projectionY	(	double	xlow,
		double	xup
	)

Project a 2D histogram into 1D histogram along Y.

The projection is made from all x-bins corresponding to abscissa between xlow and xup.

Parameters

xlow	lower edje on x-axis
xup	upper edje on x-axis

Definition at line 92 of file Histogram2D.cpp.

{
    int xbinlow = static_cast<int>(getXaxis().findClosestIndex(xlow));
    int xbinup = static_cast<int>(getXaxis().findClosestIndex(xup));
    return create_projectionY(xbinlow, xbinup);
}

References create_projectionY(), IAxis::findClosestIndex(), and IHistogram::getXaxis().

Here is the call graph for this function:

crop()

Histogram2D * Histogram2D::crop	(	double	xmin,
		double	ymin,
		double	xmax,
		double	ymax
	)

Creates new histogram by applying rectangular clip.

Definition at line 99 of file Histogram2D.cpp.

{
    const std::unique_ptr<IAxis> xaxis(getXaxis().createClippedAxis(xmin, xmax));
    const std::unique_ptr<IAxis> yaxis(getYaxis().createClippedAxis(ymin, ymax));
 
    Histogram2D* result = new Histogram2D(*xaxis, *yaxis);
    OutputData<CumulativeValue>::const_iterator it_origin = m_data.begin();
    OutputData<CumulativeValue>::iterator it_result = result->m_data.begin();
    while (it_origin != m_data.end()) {
        double x = m_data.getAxisValue(it_origin.getIndex(), 0);
        double y = m_data.getAxisValue(it_origin.getIndex(), 1);
        if (result->getXaxis().contains(x) && result->getYaxis().contains(y)) {
            *it_result = *it_origin;
            ++it_result;
        }
        ++it_origin;
    }
    return result;
}

References OutputData< T >::begin(), IAxis::contains(), OutputData< T >::end(), OutputData< T >::getAxisValue(), IHistogram::getXaxis(), IHistogram::getYaxis(), Histogram2D(), and IHistogram::m_data.

Here is the call graph for this function:

setContent()

void Histogram2D::setContent

(

const std::vector< std::vector< double >> &

data

)

Sets the values in histograms channels from numpy array,.

Definition at line 119 of file Histogram2D.cpp.

{
    reset();
    addContent(data);
}

References addContent(), and IHistogram::reset().

Referenced by Histogram2D().

Here is the call graph for this function:

addContent()

void Histogram2D::addContent

(

const std::vector< std::vector< double >> &

data

)

Add to values in histograms channels from numpy array,.

Definition at line 125 of file Histogram2D.cpp.

{
    auto shape = ArrayUtils::getShape(data);
    const size_t nrows = shape.first;
    const size_t ncols = shape.second;
 
    if (nrows != m_data.getAxis(1).size() || ncols != m_data.getAxis(0).size()) {
        std::ostringstream ostr;
        ostr << "Histogram2D::addContent() -> Shape of input array [" << nrows << ", " << ncols
             << "] doesn't mach histogram axes. "
             << "X-axis size: " << m_data.getAxis(0).size()
             << "Y-axis size: " << m_data.getAxis(1).size();
        throw Exceptions::LogicErrorException(ostr.str());
    }
 
    for (size_t row = 0; row < nrows; ++row) {
        for (size_t col = 0; col < ncols; ++col) {
            size_t globalbin = nrows - row - 1 + col * nrows;
            m_data[globalbin].add(data[row][col]);
        }
    }
}

References OutputData< T >::getAxis(), ArrayUtils::getShape(), IHistogram::m_data, and IAxis::size().

Referenced by setContent().

Here is the call graph for this function:

initFromShape()

template<typename T >

void Histogram2D::initFromShape ( const T &  data )

protected

Definition at line 115 of file Histogram2D.h.

{
    auto shape = ArrayUtils::getShape(data);
    const size_t nrows = shape.first;
    const size_t ncols = shape.second;
 
    if (nrows == 0 || ncols == 0)
        throw Exceptions::LogicErrorException("Histogram2D::Histogram2D() -> Error. "
                                              "Not a two-dimensional numpy array");
 
    m_data.addAxis(FixedBinAxis("x-axis", ncols, 0.0, static_cast<double>(ncols)));
    m_data.addAxis(FixedBinAxis("y-axis", nrows, 0.0, static_cast<double>(nrows)));
}

References OutputData< T >::addAxis(), ArrayUtils::getShape(), and IHistogram::m_data.

Referenced by Histogram2D().

Here is the call graph for this function:

create_projectionX()

Histogram1D * Histogram2D::create_projectionX ( int  ybinlow, int  ybinup  )

protected

Creates projection along X.

The projections is made by collecting the data in the range between [ybinlow, ybinup].

Definition at line 148 of file Histogram2D.cpp.

{
    Histogram1D* result = new Histogram1D(this->getXaxis());
 
    for (size_t index = 0; index < getTotalNumberOfBins(); ++index) {
 
        int ybin = static_cast<int>(getYaxisIndex(index));
 
        if (ybin >= ybinlow && ybin <= ybinup) {
            result->fill(getXaxisValue(index), getBinContent(index));
        }
    }
    return result;
}

References Histogram1D::fill(), IHistogram::getBinContent(), IHistogram::getTotalNumberOfBins(), IHistogram::getXaxis(), IHistogram::getXaxisValue(), and IHistogram::getYaxisIndex().

Referenced by projectionX().

Here is the call graph for this function:

create_projectionY()

Histogram1D * Histogram2D::create_projectionY ( int  xbinlow, int  xbinup  )

protected

Creates projection along Y.

The projections is made by collecting the data in the range between [xbinlow, xbinup].

Definition at line 163 of file Histogram2D.cpp.

{
    Histogram1D* result = new Histogram1D(this->getYaxis());
 
    for (size_t index = 0; index < getTotalNumberOfBins(); ++index) {
 
        int xbin = static_cast<int>(getXaxisIndex(index));
 
        if (xbin >= xbinlow && xbin <= xbinup) {
            result->fill(getYaxisValue(index), getBinContent(index));
        }
    }
    return result;
}

References Histogram1D::fill(), IHistogram::getBinContent(), IHistogram::getTotalNumberOfBins(), IHistogram::getXaxisIndex(), IHistogram::getYaxis(), and IHistogram::getYaxisValue().

Referenced by projectionY().

Here is the call graph for this function:

getTotalNumberOfBins()

size_t IHistogram::getTotalNumberOfBins ( ) const

inherited

Returns total number of histogram bins.

For 2D histograms the result will be the product of bin numbers along X and Y axes.

Definition at line 39 of file IHistogram.cpp.

{
    return m_data.getAllocatedSize();
}

References OutputData< T >::getAllocatedSize(), and IHistogram::m_data.

Referenced by IHistogram::copyContentFrom(), create_projectionX(), create_projectionY(), IHistogram::createOutputData(), IHistogram::getDataVector(), IHistogram::integral(), IHistogram::operator+=(), IHistogram::relativeDifferenceHistogram(), and IHistogram::scale().

Here is the call graph for this function:

getXaxis()

const IAxis & IHistogram::getXaxis ( ) const

inherited

returns x-axis

Definition at line 44 of file IHistogram.cpp.

{
    check_x_axis();
    return m_data.getAxis(0);
}

References IHistogram::check_x_axis(), OutputData< T >::getAxis(), and IHistogram::m_data.

Referenced by create_projectionX(), Histogram1D::crop(), crop(), Histogram1D::fill(), fill(), SpectrumUtils::FindPeaks(), Histogram1D::getBinCenters(), IHistogram::getNbinsX(), IHistogram::getXmax(), IHistogram::getXmin(), projectionX(), and projectionY().

Here is the call graph for this function:

getYaxis()

const IAxis & IHistogram::getYaxis ( ) const

inherited

returns y-axis for 2D histograms

Definition at line 50 of file IHistogram.cpp.

{
    check_y_axis();
    return m_data.getAxis(1);
}

References IHistogram::check_y_axis(), OutputData< T >::getAxis(), and IHistogram::m_data.

Referenced by create_projectionY(), crop(), fill(), SpectrumUtils::FindPeaks(), IHistogram::getNbinsY(), IHistogram::getYmax(), IHistogram::getYmin(), and projectionX().

Here is the call graph for this function:

getXmin()

double IHistogram::getXmin ( ) const

inherited

Returns x-axis min (lower edge of first bin).

Definition at line 56 of file IHistogram.cpp.

{
    return getXaxis().getMin();
}

References IAxis::getMin(), and IHistogram::getXaxis().

Here is the call graph for this function:

getXmax()

double IHistogram::getXmax ( ) const

inherited

Returns x-axis max (upper edge of last bin).

Definition at line 61 of file IHistogram.cpp.

{
    return getXaxis().getMax();
}

References IAxis::getMax(), and IHistogram::getXaxis().

Here is the call graph for this function:

getNbinsX()

size_t IHistogram::getNbinsX ( ) const

inherited

Returns number of bins on x-axis.

Definition at line 66 of file IHistogram.cpp.

{
    return getXaxis().size();
}

References IHistogram::getXaxis(), and IAxis::size().

Here is the call graph for this function:

getYmin()

double IHistogram::getYmin ( ) const

inherited

Returns y-axis min (lower edge of first bin) for 2D histograms.

Definition at line 71 of file IHistogram.cpp.

{
    return getYaxis().getMin();
}

References IAxis::getMin(), and IHistogram::getYaxis().

Here is the call graph for this function:

getYmax()

double IHistogram::getYmax ( ) const

inherited

Returns y-axis max (upper edge of last bin) for 2D histograms.

Definition at line 76 of file IHistogram.cpp.

{
    return getYaxis().getMax();
}

References IAxis::getMax(), and IHistogram::getYaxis().

Here is the call graph for this function:

getNbinsY()

size_t IHistogram::getNbinsY ( ) const

inherited

Returns number of bins on y-axis.

Definition at line 81 of file IHistogram.cpp.

{
    return getYaxis().size();
}

References IHistogram::getYaxis(), and IAxis::size().

Here is the call graph for this function:

getGlobalBin()

size_t IHistogram::getGlobalBin ( size_t  binx, size_t  biny = 0  ) const

inherited

Returns global bin index for given axes indices. For 1D, just returns binx.

Definition at line 86 of file IHistogram.cpp.

{
    std::vector<unsigned> axes_indices;
    axes_indices.push_back(static_cast<unsigned>(binx));
    if (getRank() == 2)
        axes_indices.push_back(static_cast<unsigned>(biny));
    return m_data.toGlobalIndex(axes_indices);
}

References IHistogram::getRank(), IHistogram::m_data, and OutputData< T >::toGlobalIndex().

Referenced by IHistogram::getBinAverage(), IHistogram::getBinContent(), IHistogram::getBinError(), and IHistogram::getBinNumberOfEntries().

Here is the call graph for this function:

findGlobalBin()

size_t IHistogram::findGlobalBin ( double  x, double  y  ) const

inherited

Returns closest global bin index for given axes coordinates.

Definition at line 95 of file IHistogram.cpp.

{
    std::vector<double> coordinates;
    coordinates.push_back(x);
    if (getRank() == 2)
        coordinates.push_back(y);
    return m_data.findGlobalIndex(coordinates);
}

References OutputData< T >::findGlobalIndex(), IHistogram::getRank(), and IHistogram::m_data.

Here is the call graph for this function:

getXaxisIndex()

size_t IHistogram::getXaxisIndex ( size_t  i ) const

inherited

Returns x-axis index for global bin index i.

Definition at line 104 of file IHistogram.cpp.

{
    return m_data.getAxisBinIndex(i, 0);
}

References OutputData< T >::getAxisBinIndex(), and IHistogram::m_data.

Referenced by create_projectionY().

Here is the call graph for this function:

getYaxisIndex()

size_t IHistogram::getYaxisIndex ( size_t  i ) const

inherited

Returns y-axis index for global bin index i.

Definition at line 109 of file IHistogram.cpp.

{
    return m_data.getAxisBinIndex(i, 1);
}

References OutputData< T >::getAxisBinIndex(), and IHistogram::m_data.

Referenced by create_projectionX().

Here is the call graph for this function:

getXaxisValue()

double IHistogram::getXaxisValue ( size_t  i )

inherited

Returns the center of bin i of the x axis.

Definition at line 114 of file IHistogram.cpp.

{
    check_x_axis();
    return m_data.getAxisValue(i, 0);
}

References IHistogram::check_x_axis(), OutputData< T >::getAxisValue(), and IHistogram::m_data.

Referenced by create_projectionX().

Here is the call graph for this function:

getYaxisValue()

double IHistogram::getYaxisValue ( size_t  i )

inherited

Returns the center of bin i of the y axis.

Definition at line 120 of file IHistogram.cpp.

{
    check_y_axis();
    return m_data.getAxisValue(i, 1);
}

References IHistogram::check_y_axis(), OutputData< T >::getAxisValue(), and IHistogram::m_data.

Referenced by create_projectionY().

Here is the call graph for this function:

getBinContent() [1/2]

double IHistogram::getBinContent ( size_t  i ) const

inherited

Returns content (accumulated value) of bin i.

Definition at line 126 of file IHistogram.cpp.

{
    return m_data[i].getContent();
}

References IHistogram::m_data.

Referenced by create_projectionX(), create_projectionY(), IHistogram::getBinContent(), IHistogram::getBinData(), IHistogram::operator+=(), and IHistogram::relativeDifferenceHistogram().

getBinContent() [2/2]

double IHistogram::getBinContent ( size_t  binx, size_t  biny  ) const

inherited

Returns content (accumulated value) of the 2D histogram bin.

Definition at line 131 of file IHistogram.cpp.

{
    return getBinContent(getGlobalBin(binx, biny));
}

References IHistogram::getBinContent(), and IHistogram::getGlobalBin().

Here is the call graph for this function:

getData() [1/2]

const OutputData<CumulativeValue>& IHistogram::getData ( ) const

inlineinherited

Definition at line 92 of file IHistogram.h.

{ return m_data; }

References IHistogram::m_data.

Referenced by IntensityDataFunctions::getRelativeDifference().

getData() [2/2]

OutputData<CumulativeValue>& IHistogram::getData ( )

inlineinherited

Definition at line 93 of file IHistogram.h.

{ return m_data; }

References IHistogram::m_data.

setBinContent()

void IHistogram::setBinContent ( size_t  i, double  value  )

inherited

Sets content of the bin corresponding to the globalbin number.

Definition at line 136 of file IHistogram.cpp.

{
    m_data[i].setContent(value);
}

References IHistogram::m_data.

Referenced by IHistogram::relativeDifferenceHistogram().

addBinContent()

void IHistogram::addBinContent ( size_t  i, double  value  )

inherited

Add the value to the bin.

Definition at line 141 of file IHistogram.cpp.

{
    m_data[i].add(value);
}

References IHistogram::m_data.

Referenced by IHistogram::operator+=().

getBinError() [1/2]

double IHistogram::getBinError ( size_t  i ) const

inherited

Returns error of the bin with given index.

Definition at line 146 of file IHistogram.cpp.

{
    return m_data[i].getRMS();
}

References IHistogram::m_data.

Referenced by IHistogram::getBinData(), and IHistogram::getBinError().

getBinError() [2/2]

double IHistogram::getBinError ( size_t  binx, size_t  biny  ) const

inherited

Returns error of the bin with given indices (for 2D histograms).

Definition at line 151 of file IHistogram.cpp.

{
    return getBinError(getGlobalBin(binx, biny));
}

References IHistogram::getBinError(), and IHistogram::getGlobalBin().

Here is the call graph for this function:

getBinAverage() [1/2]

double IHistogram::getBinAverage ( size_t  i ) const

inherited

Returns average value in the bin with given index.

Definition at line 156 of file IHistogram.cpp.

{
    return m_data[i].getAverage();
}

References IHistogram::m_data.

Referenced by IHistogram::getBinAverage(), and IHistogram::getBinData().

getBinAverage() [2/2]

double IHistogram::getBinAverage ( size_t  binx, size_t  biny  ) const

inherited

Returns average value of the bin with given indices (for 2D histograms).

Definition at line 161 of file IHistogram.cpp.

{
    return getBinAverage(getGlobalBin(binx, biny));
}

References IHistogram::getBinAverage(), and IHistogram::getGlobalBin().

Here is the call graph for this function:

getBinNumberOfEntries() [1/2]

int IHistogram::getBinNumberOfEntries ( size_t  i ) const

inherited

Returns number of entries in the bin with given index.

Definition at line 166 of file IHistogram.cpp.

{
    return m_data[i].getNumberOfEntries();
}

References IHistogram::m_data.

Referenced by IHistogram::getBinData(), and IHistogram::getBinNumberOfEntries().

getBinNumberOfEntries() [2/2]

int IHistogram::getBinNumberOfEntries ( size_t  binx, size_t  biny  ) const

inherited

Returns number of entries in the bin with given indices (for 2D histograms).

Definition at line 171 of file IHistogram.cpp.

{
    return getBinNumberOfEntries(getGlobalBin(binx, biny));
}

References IHistogram::getBinNumberOfEntries(), and IHistogram::getGlobalBin().

Here is the call graph for this function:

getMaximum()

double IHistogram::getMaximum ( ) const

inherited

Returns histogram maximum value (maximum of getBinContent() over all bins)

Definition at line 176 of file IHistogram.cpp.

{
    OutputData<CumulativeValue>::const_iterator it = std::max_element(m_data.begin(), m_data.end());
    return it->getContent();
}

References OutputData< T >::begin(), OutputData< T >::end(), and IHistogram::m_data.

Here is the call graph for this function:

getMaximumBinIndex()

size_t IHistogram::getMaximumBinIndex ( ) const

inherited

Returns globalbin index with maximum content.

Definition at line 182 of file IHistogram.cpp.

{
    OutputData<CumulativeValue>::const_iterator it = std::max_element(m_data.begin(), m_data.end());
    return std::distance(m_data.begin(), it);
}

References OutputData< T >::begin(), OutputData< T >::end(), and IHistogram::m_data.

Here is the call graph for this function:

getMinimum()

double IHistogram::getMinimum ( ) const

inherited

Returns histogram minimum value (minimum of getBinContent() over all bins)

Definition at line 188 of file IHistogram.cpp.

{
    OutputData<CumulativeValue>::const_iterator it = std::min_element(m_data.begin(), m_data.end());
    return it->getContent();
}

References OutputData< T >::begin(), OutputData< T >::end(), and IHistogram::m_data.

Here is the call graph for this function:

getMinimumBinIndex()

size_t IHistogram::getMinimumBinIndex ( ) const

inherited

Returns globalbin index with minimum content.

Definition at line 194 of file IHistogram.cpp.

{
    return std::distance(m_data.begin(), std::min_element(m_data.begin(), m_data.end()));
}

References OutputData< T >::begin(), OutputData< T >::end(), and IHistogram::m_data.

Here is the call graph for this function:

scale()

void IHistogram::scale ( double  value )

inherited

Multiply this histogram (every bin content value) by a constant.

Definition at line 199 of file IHistogram.cpp.

{
    for (size_t index = 0; index < getTotalNumberOfBins(); ++index) {
        m_data[index].setContent(value * m_data[index].getContent());
    }
}

References IHistogram::getTotalNumberOfBins(), and IHistogram::m_data.

Here is the call graph for this function:

integral()

double IHistogram::integral ( ) const

inherited

Returns integral of bins content (computed as a sum of all bin content).

Definition at line 206 of file IHistogram.cpp.

{
    double result(0.0);
    for (size_t index = 0; index < getTotalNumberOfBins(); ++index) {
        result += m_data[index].getContent();
    }
    return result;
}

References IHistogram::getTotalNumberOfBins(), and IHistogram::m_data.

Here is the call graph for this function:

array()

PyObject * IHistogram::array ( DataType  dataType = DataType::INTEGRAL ) const

inherited

Returns numpy array with bin content (accumulated values).

Definition at line 216 of file IHistogram.cpp.

{
    const std::unique_ptr<OutputData<double>> data(createOutputData(dataType));
    return data->getArray();
}

References IHistogram::createOutputData().

Referenced by IHistogram::getArray().

Here is the call graph for this function:

getArray()

PyObject * IHistogram::getArray ( DataType  dataType = DataType::INTEGRAL ) const

inherited

Deprecated:

Use array() instead.

Definition at line 222 of file IHistogram.cpp.

{
    return array(dataType);
}

References IHistogram::array().

Here is the call graph for this function:

reset()

void IHistogram::reset ( )

inherited

Reset histogram content (axes remains)

Definition at line 228 of file IHistogram.cpp.

{
    m_data.setAllTo(CumulativeValue());
}

References IHistogram::m_data, and OutputData< T >::setAllTo().

Referenced by IHistogram::copyContentFrom(), IHistogram::relativeDifferenceHistogram(), and setContent().

Here is the call graph for this function:

createHistogram()

IHistogram * IHistogram::createHistogram ( const OutputData< double > &  source )

staticinherited

Definition at line 233 of file IHistogram.cpp.

{
    if (source.getRank() == 1) {
        return new Histogram1D(source);
    } else if (source.getRank() == 2) {
        return new Histogram2D(source);
    } else {
        std::ostringstream message;
        message << "IHistogram::createHistogram(const OutputData<double>& source) -> Error. ";
        message << "The rank of source " << source.getRank() << " ";
        message << "is not suitable for creation neither 1-dim nor 2-dim histograms.";
        throw Exceptions::LogicErrorException(message.str());
    }
}

References OutputData< T >::getRank().

Referenced by DetectorMask::createHistogram(), and IntensityDataIOFactory::readIntensityData().

Here is the call graph for this function:

createFrom() [1/2]

IHistogram * IHistogram::createFrom ( const std::string &  filename )

staticinherited

create new histogram from file content

Definition at line 248 of file IHistogram.cpp.

{
    return IntensityDataIOFactory::readIntensityData(filename);
}

References FileSystemUtils::filename(), and IntensityDataIOFactory::readIntensityData().

Here is the call graph for this function:

createFrom() [2/2]

IHistogram * IHistogram::createFrom ( const std::vector< std::vector< double >> &  data )

staticinherited

create new histogram from numpy array

Definition at line 253 of file IHistogram.cpp.

{
    return new Histogram2D(data);
}

createOutputData()

OutputData< double > * IHistogram::createOutputData ( IHistogram::DataType  dataType = DataType::INTEGRAL ) const

inherited

creates new OutputData with histogram's shape and values corresponding to DataType

creates new OutputData with histogram's shape and put there values corresponding to DataType

Definition at line 334 of file IHistogram.cpp.

{
    OutputData<double>* result = new OutputData<double>;
    result->copyShapeFrom(m_data);
    for (size_t i = 0; i < getTotalNumberOfBins(); ++i) {
        (*result)[i] = getBinData(i, dataType);
    }
    return result;
}

References OutputData< T >::copyShapeFrom(), IHistogram::getBinData(), IHistogram::getTotalNumberOfBins(), and IHistogram::m_data.

Referenced by IHistogram::array(), SpectrumUtils::FindPeaks(), and IntensityDataIOFactory::writeIntensityData().

Here is the call graph for this function:

hasSameShape()

bool IHistogram::hasSameShape ( const IHistogram &  other ) const

inherited

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

Definition at line 344 of file IHistogram.cpp.

{
    return m_data.hasSameShape(other.m_data);
}

References OutputData< T >::hasSameShape(), and IHistogram::m_data.

Here is the call graph for this function:

hasSameDimensions()

bool IHistogram::hasSameDimensions ( const IHistogram &  other ) const

inherited

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

Definition at line 349 of file IHistogram.cpp.

{
    return m_data.hasSameDimensions(other.m_data);
}

References OutputData< T >::hasSameDimensions(), and IHistogram::m_data.

Referenced by IHistogram::copyContentFrom(), IHistogram::operator+=(), and IHistogram::relativeDifferenceHistogram().

Here is the call graph for this function:

operator+=()

const IHistogram & IHistogram::operator+= ( const IHistogram &  right )

inherited

addition-assignment operator for two histograms

Definition at line 354 of file IHistogram.cpp.

{
    if (!hasSameDimensions(right))
        throw Exceptions::LogicErrorException(
            "IHistogram::operator+=() -> Error. Histograms have different dimension");
    for (size_t i = 0; i < getTotalNumberOfBins(); ++i)
        addBinContent(i, right.getBinContent(i));
    return *this;
}

References IHistogram::addBinContent(), IHistogram::getBinContent(), IHistogram::getTotalNumberOfBins(), and IHistogram::hasSameDimensions().

Here is the call graph for this function:

relativeDifferenceHistogram()

IHistogram * IHistogram::relativeDifferenceHistogram ( const IHistogram &  rhs )

inherited

returns histogram representing relative difference of two histograms.

Definition at line 364 of file IHistogram.cpp.

{
    if (!hasSameDimensions(rhs))
        throw Exceptions::LogicErrorException("IHistogram::relativeDifferenceHistogram() -> Error. "
                                              "Histograms have different dimensions");
 
    IHistogram* result = this->clone();
    result->reset();
 
    for (size_t i = 0; i < getTotalNumberOfBins(); ++i) {
        double diff = Numeric::GetRelativeDifference(getBinContent(i), rhs.getBinContent(i));
        result->setBinContent(i, diff);
    }
    return result;
}

References IHistogram::clone(), IHistogram::getBinContent(), Numeric::GetRelativeDifference(), IHistogram::getTotalNumberOfBins(), IHistogram::hasSameDimensions(), IHistogram::reset(), and IHistogram::setBinContent().

Here is the call graph for this function:

save()

void IHistogram::save ( const std::string &  filename )

inherited

Saves histogram in file Following formats are available: *.txt, *.tif, *.int (*.txt.gz, *.tif.gz, *.int.gz)

Definition at line 380 of file IHistogram.cpp.

{
    IntensityDataIOFactory::writeIntensityData(*this, filename);
}

References FileSystemUtils::filename(), and IntensityDataIOFactory::writeIntensityData().

Here is the call graph for this function:

load()

void IHistogram::load ( const std::string &  filename )

inherited

Loads histogram from file, the shape of array in file should match Following formats are available: *.txt, *.tif, *.int (*.txt.gz, *.tif.gz, *.int.gz) Only bin content will be loaded, histogram axes remain the same.

Definition at line 385 of file IHistogram.cpp.

{
    const std::unique_ptr<IHistogram> hist(IntensityDataIOFactory::readIntensityData(filename));
    copyContentFrom(*hist);
}

References IHistogram::copyContentFrom(), FileSystemUtils::filename(), and IntensityDataIOFactory::readIntensityData().

Here is the call graph for this function:

check_x_axis()

void IHistogram::check_x_axis ( ) const

protectedinherited

Definition at line 258 of file IHistogram.cpp.

{
    if (getRank() < 1) {
        std::ostringstream message;
        message << "IHistogram::check_x_axis() -> Error. X-xis does not exist. ";
        message << "Rank of histogram " << getRank() << "." << std::endl;
        throw Exceptions::LogicErrorException(message.str());
    }
}

References IHistogram::getRank().

Referenced by IHistogram::getXaxis(), and IHistogram::getXaxisValue().

Here is the call graph for this function:

check_y_axis()

void IHistogram::check_y_axis ( ) const

protectedinherited

Definition at line 268 of file IHistogram.cpp.

{
    if (getRank() < 2) {
        std::ostringstream message;
        message << "IHistogram::check_y_axis() -> Error. Y-axis does not exist. ";
        message << "Rank of histogram " << getRank() << "." << std::endl;
        throw Exceptions::LogicErrorException(message.str());
    }
}

References IHistogram::getRank().

Referenced by IHistogram::getYaxis(), and IHistogram::getYaxisValue().

Here is the call graph for this function:

init_from_data()

void IHistogram::init_from_data ( const OutputData< double > &  source )

protectedinherited

Definition at line 278 of file IHistogram.cpp.

{
    if (getRank() != source.getRank()) {
        std::ostringstream message;
        message << "IHistogram::IHistogram(const OutputData<double>& data) -> Error. ";
        message << "The dimension of this histogram " << getRank() << " ";
        message << "is differ from the dimension of source " << m_data.getRank() << std::endl;
        throw Exceptions::LogicErrorException(message.str());
    }
 
    m_data.copyShapeFrom(source);
    for (size_t i = 0; i < source.getAllocatedSize(); ++i) {
        m_data[i].add(source[i]);
    }
}

References OutputData< T >::copyShapeFrom(), OutputData< T >::getAllocatedSize(), OutputData< T >::getRank(), IHistogram::getRank(), and IHistogram::m_data.

Referenced by Histogram1D::Histogram1D(), and Histogram2D().

Here is the call graph for this function:

getBinData()

double IHistogram::getBinData ( size_t  i, IHistogram::DataType  dataType  ) const

protectedinherited

returns data of requested type for globalbin number

Definition at line 295 of file IHistogram.cpp.

{
    if (dataType == DataType::INTEGRAL) {
        return getBinContent(i);
    } else if (dataType == DataType::AVERAGE) {
        return getBinAverage(i);
    } else if (dataType == DataType::STANDARD_ERROR) {
        return getBinError(i);
    } else if (dataType == DataType::NENTRIES) {
        return getBinNumberOfEntries(i);
    } else
        throw Exceptions::LogicErrorException(
            "IHistogram::getBinData() -> Error. Unknown data type.");
}

References IHistogram::getBinAverage(), IHistogram::getBinContent(), IHistogram::getBinError(), and IHistogram::getBinNumberOfEntries().

Referenced by IHistogram::createOutputData(), and IHistogram::getDataVector().

Here is the call graph for this function:

getDataVector()

std::vector< double > IHistogram::getDataVector ( IHistogram::DataType  dataType ) const

protectedinherited

returns vector of values of requested DataType

Definition at line 311 of file IHistogram.cpp.

{
    std::vector<double> result;
    result.resize(getTotalNumberOfBins(), 0.0);
    for (size_t index = 0; index < getTotalNumberOfBins(); ++index) {
        result[index] = getBinData(index, dataType);
    }
    return result;
}

References IHistogram::getBinData(), and IHistogram::getTotalNumberOfBins().

Referenced by Histogram1D::getBinErrors(), and Histogram1D::getBinValues().

Here is the call graph for this function:

copyContentFrom()

void IHistogram::copyContentFrom ( const IHistogram &  other )

protectedinherited

Copy content (but not the axes) from other histogram. Dimensions should be the same.

Definition at line 322 of file IHistogram.cpp.

{
    if (!hasSameDimensions(other))
        throw Exceptions::LogicErrorException(
            "IHistogram::copyContentFrom() -> Error. Can't copy the data of different shape.");
    reset();
    for (size_t i = 0; i < getTotalNumberOfBins(); ++i) {
        m_data[i] = other.m_data[i];
    }
}

References IHistogram::getTotalNumberOfBins(), IHistogram::hasSameDimensions(), IHistogram::m_data, and IHistogram::reset().

Referenced by IHistogram::load().

Here is the call graph for this function:

Member Data Documentation

m_data

OutputData<CumulativeValue> IHistogram::m_data

protectedinherited

Definition at line 193 of file IHistogram.h.

Referenced by IHistogram::addBinContent(), addContent(), IHistogram::copyContentFrom(), IHistogram::createOutputData(), Histogram1D::crop(), crop(), Histogram1D::fill(), fill(), IHistogram::findGlobalBin(), IHistogram::getBinAverage(), IHistogram::getBinContent(), IHistogram::getBinError(), IHistogram::getBinNumberOfEntries(), IHistogram::getData(), IHistogram::getGlobalBin(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), IHistogram::getTotalNumberOfBins(), IHistogram::getXaxis(), IHistogram::getXaxisIndex(), IHistogram::getXaxisValue(), IHistogram::getYaxis(), IHistogram::getYaxisIndex(), IHistogram::getYaxisValue(), IHistogram::hasSameDimensions(), IHistogram::hasSameShape(), Histogram1D::Histogram1D(), Histogram2D(), IHistogram::IHistogram(), IHistogram::init_from_data(), initFromShape(), IHistogram::integral(), IHistogram::reset(), IHistogram::scale(), and IHistogram::setBinContent().

---

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

• /home/www/ba/Device/Histo/Histogram2D.h
• /home/www/ba/Device/Histo/Histogram2D.cpp