Histogram1D Class Reference

One dimensional histogram. More...

Inheritance diagram for Histogram1D:

Collaboration diagram for Histogram1D:

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

Public Member Functions
	Histogram1D (const IAxis &axis)
	Constructor for 1D histogram with custom axis. More...
	Histogram1D (const OutputData< double > &data)
	Constructor for 1D histograms from basic OutputData object. More...
	Histogram1D (int nbinsx, const std::vector< double > &xbins)
	Constructor for variable bin size histograms. More...
	Histogram1D (int nbinsx, double xlow, double xup)
	Constructor for fix bin size histograms. More...
void	addBinContent (size_t i, double value)
	Add the value to the bin. More...
PyObject *	array (DataType dataType=DataType::INTEGRAL) const
	Returns numpy array with bin content (accumulated values). More...
double	binAverage (size_t binx, size_t biny) const
	Returns average value of the bin with given indices (for 2D histograms). More...
double	binAverage (size_t i) const
	Returns average value in the bin with given index. More...
std::vector< double >	binCenters () const
	returns vector of histogram bin centers More...
PyObject *	binCentersNumpy () const
double	binContent (size_t binx, size_t biny) const
	Returns content (accumulated value) of the 2D histogram bin. More...
double	binContent (size_t i) const
	Returns content (accumulated value) of bin i. More...
double	binError (size_t binx, size_t biny) const
	Returns error of the bin with given indices (for 2D histograms). More...
double	binError (size_t i) const
	Returns error of the bin with given index. More...
std::vector< double >	binErrors () const
	returns vector of bin errors More...
PyObject *	binErrorsNumpy () const
int	binNumberOfEntries (size_t binx, size_t biny) const
	Returns number of entries in the bin with given indices (for 2D histograms). More...
int	binNumberOfEntries (size_t i) const
	Returns number of entries in the bin with given index. More...
std::vector< double >	binValues () const
	returns vector of bin content (the value accumulated by bins) More...
PyObject *	binValuesNumpy () const
Histogram1D *	clone () const
	Returns clone of other histogram. More...
OutputData< double > *	createOutputData (DataType dataType=DataType::INTEGRAL) const
	creates new OutputData with histogram's shape and values corresponding to DataType More...
Histogram1D *	crop (double xmin, double xmax)
	Creates new histogram by applying crop on axis. More...
int	fill (double x, double weight=1.0)
	Increment bin with abscissa x with a weight. More...
size_t	findGlobalBin (double x, double y) const
	Returns closest global bin index for given axes coordinates. More...
PyObject *	getArray (DataType dataType=DataType::INTEGRAL) const
OutputData< CumulativeValue > &	getData ()
const OutputData< CumulativeValue > &	getData () const
size_t	getGlobalBin (size_t binx, size_t biny=0) const
	Returns global bin index for given axes indices. For 1D, just returns binx. More...
double	getMaximum () const
	Returns histogram maximum value (maximum of binContent() over all bins) More...
size_t	getMaximumBinIndex () const
	Returns globalbin index with maximum content. More...
double	getMinimum () const
	Returns histogram minimum value (minimum of binContent() over all bins) More...
size_t	getMinimumBinIndex () const
	Returns globalbin index with minimum content. More...
size_t	getNbinsX () const
	Returns number of bins on x-axis. More...
size_t	getNbinsY () const
	Returns number of bins on y-axis. More...
size_t	getTotalNumberOfBins () const
	Returns total number of histogram bins. More...
double	getXmax () const
	Returns x-axis max (upper edge of last bin). More...
double	getXmin () const
	Returns x-axis min (lower edge of first bin). More...
double	getYmax () const
	Returns y-axis max (upper edge of last bin) for 2D histograms. More...
double	getYmin () const
	Returns y-axis min (lower edge of first bin) for 2D histograms. More...
bool	hasSameDimensions (const IHistogram &other) const
	Returns true if object have same rank and number of axes bins. More...
bool	hasSameShape (const IHistogram &other) const
	Returns true if objects a) have same dimensions b) bin boundaries of axes coincide. More...
double	integral () const
	Returns integral of bins content (computed as a sum of all bin content). More...
void	load (const std::string &filename)
	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. More...
const IHistogram &	operator+= (const IHistogram &right)
	addition-assignment operator for two histograms More...
size_t	rank () const
	Returns the number of histogram dimensions. More...
IHistogram *	relativeDifferenceHistogram (const IHistogram &rhs)
	returns histogram representing relative difference of two histograms. More...
void	reset ()
	Reset histogram content (axes remains) More...
void	save (const std::string &filename)
	Saves histogram in file Following formats are available: *.txt, *.tif, *.int (*.txt.gz, *.tif.gz, *.int.gz) More...
void	scale (double value)
	Multiply this histogram (every bin content value) by a constant. More...
void	setBinContent (size_t i, double value)
	Sets content of the bin corresponding to the globalbin number. More...
const IAxis &	xAxis () const
	returns x-axis More...
size_t	xAxisIndex (size_t i) const
	Returns x-axis index for global bin index i. More...
double	xAxisValue (size_t i)
	Returns the center of bin i of the x axis. More...
const IAxis &	yAxis () const
	returns y-axis for 2D histograms More...
size_t	yAxisIndex (size_t i) const
	Returns y-axis index for global bin index i. More...
double	yAxisValue (size_t i)
	Returns the center of bin i of the y axis. More...

Static Public Member Functions
static IHistogram *	createFrom (const std::string &filename)
	create new histogram from file content More...
static IHistogram *	createFrom (const std::vector< std::vector< double >> &data)
	create new histogram from numpy array More...
static IHistogram *	createHistogram (const OutputData< double > &source)

Protected Member Functions
double	binData (size_t i, DataType dataType) const
	returns data of requested type for globalbin number More...
void	check_x_axis () const
void	check_y_axis () const
void	copyContentFrom (const IHistogram &other)
	Copy content (but not the axes) from other histogram. Dimensions should be the same. More...
std::vector< double >	getDataVector (DataType dataType) const
	returns vector of values of requested DataType More...
void	init_from_data (const OutputData< double > &source)

Protected Attributes
OutputData< CumulativeValue >	m_data

Detailed Description

One dimensional histogram.

Definition at line 23 of file Histogram1D.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

Histogram1D() [1/4]

Histogram1D::Histogram1D	(	int	nbinsx,
		double	xlow,
		double	xup
	)

Constructor for fix bin size histograms.

Parameters

nbinsx	number of bins
xlow	low edge of the first bin
xup	upper edge of the last bin

Definition at line 20 of file Histogram1D.cpp.

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

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

Referenced by clone(), and crop().

Here is the call graph for this function:

Histogram1D() [2/4]

Histogram1D::Histogram1D	(	int	nbinsx,
		const std::vector< double > &	xbins
	)

Constructor for variable bin size histograms.

Parameters

nbinsx	number of bins
xbins	Array of size nbins+1 containing low-edges for each bin and upper edge of last bin.

Definition at line 25 of file Histogram1D.cpp.

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

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

Here is the call graph for this function:

Histogram1D() [3/4]

Histogram1D::Histogram1D

(

const IAxis &

axis

)

Constructor for 1D histogram with custom axis.

Definition at line 30 of file Histogram1D.cpp.

: IHistogram(axis) {}

Histogram1D() [4/4]

Histogram1D::Histogram1D

(

const OutputData< double > &

data

)

Constructor for 1D histograms from basic OutputData object.

Definition at line 32 of file Histogram1D.cpp.

{
    init_from_data(data);
}

References IHistogram::init_from_data().

Here is the call graph for this function:

Member Function Documentation

addBinContent()

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

inherited

Add the value to the bin.

Definition at line 151 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::operator+=().

array()

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

inherited

Returns numpy array with bin content (accumulated values).

Definition at line 226 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:

binAverage() [1/2]

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

inherited

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

Definition at line 171 of file IHistogram.cpp.

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

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

Here is the call graph for this function:

binAverage() [2/2]

double IHistogram::binAverage ( size_t  i ) const

inherited

Returns average value in the bin with given index.

Definition at line 166 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::binAverage(), and IHistogram::binData().

binCenters()

std::vector< double > Histogram1D::binCenters

(

)

const

returns vector of histogram bin centers

Definition at line 52 of file Histogram1D.cpp.

{
    return xAxis().binCenters();
}

References IAxis::binCenters(), and IHistogram::xAxis().

Referenced by binCentersNumpy().

Here is the call graph for this function:

binCentersNumpy()

PyObject * Histogram1D::binCentersNumpy

(

)

const

Definition at line 69 of file Histogram1D.cpp.

{
    return PyUtils::createNumpyArray(binCenters());
}

References binCenters(), and PyUtils::createNumpyArray().

Here is the call graph for this function:

binContent() [1/2]

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

inherited

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

Definition at line 141 of file IHistogram.cpp.

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

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

Here is the call graph for this function:

binContent() [2/2]

double IHistogram::binContent ( size_t  i ) const

inherited

Returns content (accumulated value) of bin i.

Definition at line 136 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::binContent(), IHistogram::binData(), Histogram2D::create_projectionX(), Histogram2D::create_projectionY(), IHistogram::operator+=(), and IHistogram::relativeDifferenceHistogram().

binData()

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

protectedinherited

returns data of requested type for globalbin number

Definition at line 305 of file IHistogram.cpp.

{
    if (dataType == DataType::INTEGRAL) {
        return binContent(i);
    } else if (dataType == DataType::AVERAGE) {
        return binAverage(i);
    } else if (dataType == DataType::STANDARD_ERROR) {
        return binError(i);
    } else if (dataType == DataType::NENTRIES) {
        return binNumberOfEntries(i);
    } else
        throw std::runtime_error("IHistogram::binData() -> Error. Unknown data type.");
}

References IHistogram::binAverage(), IHistogram::binContent(), IHistogram::binError(), and IHistogram::binNumberOfEntries().

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

Here is the call graph for this function:

binError() [1/2]

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

inherited

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

Definition at line 161 of file IHistogram.cpp.

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

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

Here is the call graph for this function:

binError() [2/2]

double IHistogram::binError ( size_t  i ) const

inherited

Returns error of the bin with given index.

Definition at line 156 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::binData(), and IHistogram::binError().

binErrors()

std::vector< double > Histogram1D::binErrors

(

)

const

returns vector of bin errors

Definition at line 62 of file Histogram1D.cpp.

{
    return IHistogram::getDataVector(IHistogram::DataType::STANDARD_ERROR);
}

References IHistogram::getDataVector().

Referenced by binErrorsNumpy().

Here is the call graph for this function:

binErrorsNumpy()

PyObject * Histogram1D::binErrorsNumpy

(

)

const

Definition at line 79 of file Histogram1D.cpp.

{
    return PyUtils::createNumpyArray(binErrors());
}

References binErrors(), and PyUtils::createNumpyArray().

Here is the call graph for this function:

binNumberOfEntries() [1/2]

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

inherited

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

Definition at line 181 of file IHistogram.cpp.

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

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

Here is the call graph for this function:

binNumberOfEntries() [2/2]

int IHistogram::binNumberOfEntries ( size_t  i ) const

inherited

Returns number of entries in the bin with given index.

Definition at line 176 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::binData(), and IHistogram::binNumberOfEntries().

binValues()

std::vector< double > Histogram1D::binValues

(

)

const

returns vector of bin content (the value accumulated by bins)

Definition at line 57 of file Histogram1D.cpp.

{
    return IHistogram::getDataVector(IHistogram::DataType::INTEGRAL);
}

References IHistogram::getDataVector().

Referenced by binValuesNumpy().

Here is the call graph for this function:

binValuesNumpy()

PyObject * Histogram1D::binValuesNumpy

(

)

const

Definition at line 74 of file Histogram1D.cpp.

{
    return PyUtils::createNumpyArray(binValues());
}

References binValues(), and PyUtils::createNumpyArray().

Here is the call graph for this function:

check_x_axis()

void IHistogram::check_x_axis ( ) const

protectedinherited

Definition at line 268 of file IHistogram.cpp.

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

References IHistogram::rank().

Referenced by IHistogram::xAxis(), and IHistogram::xAxisValue().

Here is the call graph for this function:

check_y_axis()

void IHistogram::check_y_axis ( ) const

protectedinherited

Definition at line 278 of file IHistogram.cpp.

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

References IHistogram::rank().

Referenced by IHistogram::yAxis(), and IHistogram::yAxisValue().

Here is the call graph for this function:

clone()

Histogram1D * Histogram1D::clone ( ) const

virtual

Returns clone of other histogram.

Implements IHistogram.

Definition at line 37 of file Histogram1D.cpp.

{
    return new Histogram1D(*this);
}

References Histogram1D().

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 331 of file IHistogram.cpp.

{
    if (!hasSameDimensions(other))
        throw std::runtime_error(
            "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:

createFrom() [1/2]

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

staticinherited

create new histogram from file content

Definition at line 258 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 263 of file IHistogram.cpp.

{
    return new Histogram2D(data);
}

createHistogram()

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

staticinherited

Definition at line 243 of file IHistogram.cpp.

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

References OutputData< T >::rank().

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

Here is the call graph for this function:

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 343 of file IHistogram.cpp.

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

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

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

Here is the call graph for this function:

crop()

Histogram1D * Histogram1D::crop	(	double	xmin,
		double	xmax
	)

Creates new histogram by applying crop on axis.

Definition at line 86 of file Histogram1D.cpp.

{
    const std::unique_ptr<IAxis> xaxis(xAxis().createClippedAxis(xmin, xmax));
    Histogram1D* result = new Histogram1D(*xaxis);
    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);
        if (result->xAxis().contains(x)) {
            *it_result = *it_origin;
            ++it_result;
        }
        ++it_origin;
    }
    return result;
}

References Histogram1D(), OutputData< T >::begin(), IAxis::contains(), OutputData< T >::end(), OutputData< T >::getAxisValue(), IHistogram::m_data, and IHistogram::xAxis().

Here is the call graph for this function:

fill()

int Histogram1D::fill	(	double	x,
		double	weight = 1.0
	)

Increment bin with abscissa x with a weight.

Definition at line 42 of file Histogram1D.cpp.

{
    const IAxis& axis = xAxis();
    if (!axis.contains(x))
        return -1;
    size_t index = axis.findClosestIndex(x);
    m_data[index].add(weight);
    return (int)index;
}

References IAxis::contains(), IAxis::findClosestIndex(), IHistogram::m_data, and IHistogram::xAxis().

Referenced by Histogram2D::create_projectionX(), and Histogram2D::create_projectionY().

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 (rank() == 2)
        coordinates.push_back(y);
    return m_data.findGlobalIndex(coordinates);
}

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

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 232 of file IHistogram.cpp.

{
    return array(dataType);
}

References IHistogram::array().

Here is the call graph for this function:

getData() [1/2]

OutputData< CumulativeValue > & IHistogram::getData ( )

inherited

Definition at line 131 of file IHistogram.cpp.

{
    return m_data;
}

References IHistogram::m_data.

getData() [2/2]

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

inherited

Definition at line 126 of file IHistogram.cpp.

{
    return m_data;
}

References IHistogram::m_data.

Referenced by HistoUtils::getRelativeDifference().

getDataVector()

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

protectedinherited

returns vector of values of requested DataType

Definition at line 320 of file IHistogram.cpp.

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

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

Referenced by binErrors(), and binValues().

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 (rank() == 2)
        axes_indices.push_back(static_cast<unsigned>(biny));
    return m_data.toGlobalIndex(axes_indices);
}

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

Referenced by IHistogram::binAverage(), IHistogram::binContent(), IHistogram::binError(), and IHistogram::binNumberOfEntries().

Here is the call graph for this function:

getMaximum()

double IHistogram::getMaximum ( ) const

inherited

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

Definition at line 186 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 192 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 binContent() over all bins)

Definition at line 198 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 204 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:

getNbinsX()

size_t IHistogram::getNbinsX ( ) const

inherited

Returns number of bins on x-axis.

Definition at line 66 of file IHistogram.cpp.

{
    return xAxis().size();
}

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

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 yAxis().size();
}

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

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(), Histogram2D::create_projectionX(), Histogram2D::create_projectionY(), IHistogram::createOutputData(), IHistogram::getDataVector(), IHistogram::integral(), IHistogram::operator+=(), IHistogram::relativeDifferenceHistogram(), and IHistogram::scale().

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 xAxis().upperBound();
}

References IAxis::upperBound(), and IHistogram::xAxis().

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 xAxis().lowerBound();
}

References IAxis::lowerBound(), and IHistogram::xAxis().

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 yAxis().upperBound();
}

References IAxis::upperBound(), and IHistogram::yAxis().

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 yAxis().lowerBound();
}

References IAxis::lowerBound(), and IHistogram::yAxis().

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 358 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:

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 353 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:

init_from_data()

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

protectedinherited

Definition at line 288 of file IHistogram.cpp.

{
    if (rank() != source.rank()) {
        std::ostringstream message;
        message << "IHistogram::IHistogram(const OutputData<double>& data) -> Error. ";
        message << "The dimension of this histogram " << rank() << " ";
        message << "is differ from the dimension of source " << m_data.rank() << std::endl;
        throw std::runtime_error(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(), IHistogram::m_data, OutputData< T >::rank(), and IHistogram::rank().

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

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 216 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:

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 394 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:

operator+=()

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

inherited

addition-assignment operator for two histograms

Definition at line 363 of file IHistogram.cpp.

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

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

Here is the call graph for this function:

rank()

size_t Histogram1D::rank ( ) const

inlinevirtual

Returns the number of histogram dimensions.

Implements IHistogram.

Definition at line 47 of file Histogram1D.h.

{ return 1; }

relativeDifferenceHistogram()

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

inherited

returns histogram representing relative difference of two histograms.

Definition at line 373 of file IHistogram.cpp.

{
    if (!hasSameDimensions(rhs))
        throw std::runtime_error("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(binContent(i), rhs.binContent(i));
        result->setBinContent(i, diff);
    }
    return result;
}

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

Here is the call graph for this function:

reset()

void IHistogram::reset ( )

inherited

Reset histogram content (axes remains)

Definition at line 238 of file IHistogram.cpp.

{
    m_data.setAllTo(CumulativeValue());
}

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

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

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 389 of file IHistogram.cpp.

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

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

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 209 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:

setBinContent()

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

inherited

Sets content of the bin corresponding to the globalbin number.

Definition at line 146 of file IHistogram.cpp.

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

References IHistogram::m_data.

Referenced by IHistogram::relativeDifferenceHistogram().

xAxis()

const IAxis & IHistogram::xAxis ( ) const

inherited

returns x-axis

Definition at line 44 of file IHistogram.cpp.

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

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

Referenced by binCenters(), Histogram2D::create_projectionX(), crop(), Histogram2D::crop(), fill(), Histogram2D::fill(), HistoUtils::FindPeaks(), IHistogram::getNbinsX(), IHistogram::getXmax(), IHistogram::getXmin(), Histogram2D::projectionX(), and Histogram2D::projectionY().

Here is the call graph for this function:

xAxisIndex()

size_t IHistogram::xAxisIndex ( 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 Histogram2D::create_projectionY().

Here is the call graph for this function:

xAxisValue()

double IHistogram::xAxisValue ( 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 Histogram2D::create_projectionX().

Here is the call graph for this function:

yAxis()

const IAxis & IHistogram::yAxis ( ) const

inherited

returns y-axis for 2D histograms

Definition at line 50 of file IHistogram.cpp.

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

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

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

Here is the call graph for this function:

yAxisIndex()

size_t IHistogram::yAxisIndex ( 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 Histogram2D::create_projectionX().

Here is the call graph for this function:

yAxisValue()

double IHistogram::yAxisValue ( 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 Histogram2D::create_projectionY().

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 Histogram1D(), Histogram2D::Histogram2D(), IHistogram::IHistogram(), IHistogram::addBinContent(), Histogram2D::addContent(), IHistogram::binAverage(), IHistogram::binContent(), IHistogram::binError(), IHistogram::binNumberOfEntries(), IHistogram::copyContentFrom(), IHistogram::createOutputData(), crop(), Histogram2D::crop(), fill(), Histogram2D::fill(), IHistogram::findGlobalBin(), IHistogram::getData(), IHistogram::getGlobalBin(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), IHistogram::getTotalNumberOfBins(), IHistogram::hasSameDimensions(), IHistogram::hasSameShape(), IHistogram::init_from_data(), Histogram2D::initFromShape(), IHistogram::integral(), IHistogram::reset(), IHistogram::scale(), IHistogram::setBinContent(), IHistogram::xAxis(), IHistogram::xAxisIndex(), IHistogram::xAxisValue(), IHistogram::yAxis(), IHistogram::yAxisIndex(), and IHistogram::yAxisValue().

---

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

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