IHistogram Class Reference

Inheritance diagram for IHistogram:

Collaboration diagram for IHistogram:

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

Public Member Functions
	IHistogram ()
	IHistogram (const IHistogram &other)
virtual	~IHistogram ()
	IHistogram (const IAxis &axis_x)
	IHistogram (const IAxis &axis_x, const IAxis &axis_y)
virtual IHistogram *	clone () const =0
virtual size_t	getRank () const =0
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
const OutputData< CumulativeValue > &	getData () const
OutputData< CumulativeValue > &	getData ()
double	getBinContent (size_t binx, size_t biny) const
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
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

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

Definition at line 26 of file IHistogram.h.

Member Enumeration Documentation

DataType

enum IHistogram::DataType

Enumerator
INTEGRAL
AVERAGE
STANDARD_ERROR
NENTRIES

Definition at line 29 of file IHistogram.h.

{ INTEGRAL, AVERAGE, STANDARD_ERROR, NENTRIES };

Constructor & Destructor Documentation

IHistogram() [1/4]

IHistogram::IHistogram ( )

default

IHistogram() [2/4]

IHistogram::IHistogram

(

const IHistogram &

other

)

Definition at line 23 of file IHistogram.cpp.

{
    m_data.copyFrom(other.m_data);
}

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

Here is the call graph for this function:

~IHistogram()

virtual IHistogram::~IHistogram ( )

inlinevirtual

Definition at line 33 of file IHistogram.h.

{}

IHistogram() [3/4]

IHistogram::IHistogram

(

const IAxis &

axis_x

)

Definition at line 28 of file IHistogram.cpp.

{
    m_data.addAxis(axis_x);
}

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

Here is the call graph for this function:

IHistogram() [4/4]

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

Definition at line 33 of file IHistogram.cpp.

{
    m_data.addAxis(axis_x);
    m_data.addAxis(axis_y);
}

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

Here is the call graph for this function:

Member Function Documentation

clone()

virtual IHistogram* IHistogram::clone ( ) const

pure virtual

Implemented in Histogram2D, and Histogram1D.

Referenced by relativeDifferenceHistogram().

getRank()

virtual size_t IHistogram::getRank ( ) const

pure virtual

Returns number of histogram dimensions.

Implemented in Histogram2D, and Histogram1D.

Referenced by check_x_axis(), check_y_axis(), findGlobalBin(), getGlobalBin(), and init_from_data().

getTotalNumberOfBins()

size_t IHistogram::getTotalNumberOfBins

(

)

const

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 m_data.

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

Here is the call graph for this function:

getXaxis()

const IAxis & IHistogram::getXaxis

(

)

const

returns x-axis

Definition at line 44 of file IHistogram.cpp.

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

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

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

Here is the call graph for this function:

getYaxis()

const IAxis & IHistogram::getYaxis

(

)

const

returns y-axis for 2D histograms

Definition at line 50 of file IHistogram.cpp.

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

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

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

Here is the call graph for this function:

getXmin()

double IHistogram::getXmin

(

)

const

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

Definition at line 56 of file IHistogram.cpp.

{
    return getXaxis().getMin();
}

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

Here is the call graph for this function:

getXmax()

double IHistogram::getXmax

(

)

const

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

Definition at line 61 of file IHistogram.cpp.

{
    return getXaxis().getMax();
}

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

Here is the call graph for this function:

getNbinsX()

size_t IHistogram::getNbinsX

(

)

const

Returns number of bins on x-axis.

Definition at line 66 of file IHistogram.cpp.

{
    return getXaxis().size();
}

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

Here is the call graph for this function:

getYmin()

double IHistogram::getYmin

(

)

const

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 getYaxis().

Here is the call graph for this function:

getYmax()

double IHistogram::getYmax

(

)

const

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 getYaxis().

Here is the call graph for this function:

getNbinsY()

size_t IHistogram::getNbinsY

(

)

const

Returns number of bins on y-axis.

Definition at line 81 of file IHistogram.cpp.

{
    return getYaxis().size();
}

References 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

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 getRank(), m_data, and OutputData< T >::toGlobalIndex().

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

Here is the call graph for this function:

findGlobalBin()

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

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(), getRank(), and m_data.

Here is the call graph for this function:

getXaxisIndex()

size_t IHistogram::getXaxisIndex

(

size_t

i

)

const

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 m_data.

Referenced by Histogram2D::create_projectionY().

Here is the call graph for this function:

getYaxisIndex()

size_t IHistogram::getYaxisIndex

(

size_t

i

)

const

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 m_data.

Referenced by Histogram2D::create_projectionX().

Here is the call graph for this function:

getXaxisValue()

double IHistogram::getXaxisValue

(

size_t

i

)

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 check_x_axis(), OutputData< T >::getAxisValue(), and m_data.

Referenced by Histogram2D::create_projectionX().

Here is the call graph for this function:

getYaxisValue()

double IHistogram::getYaxisValue

(

size_t

i

)

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 check_y_axis(), OutputData< T >::getAxisValue(), and m_data.

Referenced by Histogram2D::create_projectionY().

Here is the call graph for this function:

getBinContent() [1/2]

double IHistogram::getBinContent

(

size_t

i

)

const

Returns content (accumulated value) of bin i.

Definition at line 126 of file IHistogram.cpp.

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

References m_data.

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

getData() [1/2]

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

inline

Definition at line 92 of file IHistogram.h.

{ return m_data; }

References m_data.

Referenced by IntensityDataFunctions::getRelativeDifference().

getData() [2/2]

OutputData<CumulativeValue>& IHistogram::getData ( )

inline

Definition at line 93 of file IHistogram.h.

{ return m_data; }

References m_data.

getBinContent() [2/2]

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

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

Definition at line 131 of file IHistogram.cpp.

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

References getBinContent(), and getGlobalBin().

Here is the call graph for this function:

setBinContent()

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

Sets content of the bin corresponding to the globalbin number.

Definition at line 136 of file IHistogram.cpp.

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

References m_data.

Referenced by relativeDifferenceHistogram().

addBinContent()

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

Add the value to the bin.

Definition at line 141 of file IHistogram.cpp.

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

References m_data.

Referenced by operator+=().

getBinError() [1/2]

double IHistogram::getBinError

(

size_t

i

)

const

Returns error of the bin with given index.

Definition at line 146 of file IHistogram.cpp.

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

References m_data.

Referenced by getBinData(), and getBinError().

getBinError() [2/2]

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

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 getBinError(), and getGlobalBin().

Here is the call graph for this function:

getBinAverage() [1/2]

double IHistogram::getBinAverage

(

size_t

i

)

const

Returns average value in the bin with given index.

Definition at line 156 of file IHistogram.cpp.

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

References m_data.

Referenced by getBinAverage(), and getBinData().

getBinAverage() [2/2]

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

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 getBinAverage(), and getGlobalBin().

Here is the call graph for this function:

getBinNumberOfEntries() [1/2]

int IHistogram::getBinNumberOfEntries

(

size_t

i

)

const

Returns number of entries in the bin with given index.

Definition at line 166 of file IHistogram.cpp.

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

References m_data.

Referenced by getBinData(), and getBinNumberOfEntries().

getBinNumberOfEntries() [2/2]

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

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 getBinNumberOfEntries(), and getGlobalBin().

Here is the call graph for this function:

getMaximum()

double IHistogram::getMaximum

(

)

const

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 m_data.

Here is the call graph for this function:

getMaximumBinIndex()

size_t IHistogram::getMaximumBinIndex

(

)

const

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 m_data.

Here is the call graph for this function:

getMinimum()

double IHistogram::getMinimum

(

)

const

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 m_data.

Here is the call graph for this function:

getMinimumBinIndex()

size_t IHistogram::getMinimumBinIndex

(

)

const

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 m_data.

Here is the call graph for this function:

scale()

void IHistogram::scale

(

double

value

)

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 getTotalNumberOfBins(), and m_data.

Here is the call graph for this function:

integral()

double IHistogram::integral

(

)

const

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 getTotalNumberOfBins(), and m_data.

Here is the call graph for this function:

array()

PyObject * IHistogram::array

(

DataType

dataType = DataType::INTEGRAL

)

const

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 createOutputData().

Referenced by getArray().

Here is the call graph for this function:

getArray()

PyObject * IHistogram::getArray

(

DataType

dataType = DataType::INTEGRAL

)

const

Deprecated:

Use array() instead.

Definition at line 222 of file IHistogram.cpp.

{
    return array(dataType);
}

References array().

Here is the call graph for this function:

reset()

void IHistogram::reset

(

)

Reset histogram content (axes remains)

Definition at line 228 of file IHistogram.cpp.

{
    m_data.setAllTo(CumulativeValue());
}

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

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

Here is the call graph for this function:

createHistogram()

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

static

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 )

static

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 )

static

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

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(), getBinData(), getTotalNumberOfBins(), and m_data.

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

Here is the call graph for this function:

hasSameShape()

bool IHistogram::hasSameShape

(

const IHistogram &

other

)

const

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 m_data.

Here is the call graph for this function:

hasSameDimensions()

bool IHistogram::hasSameDimensions

(

const IHistogram &

other

)

const

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 m_data.

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

Here is the call graph for this function:

operator+=()

const IHistogram & IHistogram::operator+=

(

const IHistogram &

right

)

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 addBinContent(), getBinContent(), getTotalNumberOfBins(), and hasSameDimensions().

Here is the call graph for this function:

relativeDifferenceHistogram()

IHistogram * IHistogram::relativeDifferenceHistogram

(

const IHistogram &

rhs

)

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 clone(), getBinContent(), Numeric::GetRelativeDifference(), getTotalNumberOfBins(), hasSameDimensions(), reset(), and setBinContent().

Here is the call graph for this function:

save()

void IHistogram::save

(

const std::string &

filename

)

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

)

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 copyContentFrom(), FileSystemUtils::filename(), and IntensityDataIOFactory::readIntensityData().

Here is the call graph for this function:

check_x_axis()

void IHistogram::check_x_axis ( ) const

protected

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 getRank().

Referenced by getXaxis(), and getXaxisValue().

Here is the call graph for this function:

check_y_axis()

void IHistogram::check_y_axis ( ) const

protected

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 getRank().

Referenced by getYaxis(), and getYaxisValue().

Here is the call graph for this function:

init_from_data()

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

protected

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(), getRank(), and m_data.

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

Here is the call graph for this function:

getBinData()

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

protected

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 getBinAverage(), getBinContent(), getBinError(), and getBinNumberOfEntries().

Referenced by createOutputData(), and getDataVector().

Here is the call graph for this function:

getDataVector()

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

protected

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 getBinData(), and getTotalNumberOfBins().

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

Here is the call graph for this function:

copyContentFrom()

void IHistogram::copyContentFrom ( const IHistogram &  other )

protected

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 getTotalNumberOfBins(), hasSameDimensions(), m_data, and reset().

Referenced by load().

Here is the call graph for this function:

Member Data Documentation

m_data

OutputData<CumulativeValue> IHistogram::m_data

protected

Definition at line 193 of file IHistogram.h.

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

---

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

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