IHistogram Class Reference

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

Inheritance diagram for IHistogram:

Collaboration diagram for IHistogram:

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

Public Member Functions
	IHistogram ()
	IHistogram (const IAxis &axis_x)
	IHistogram (const IAxis &axis_x, const IAxis &axis_y)
	IHistogram (const IHistogram &other)
virtual	~IHistogram ()=default
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...
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...
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...
virtual IHistogram *	clone () const =0
OutputData< double > *	createOutputData (DataType dataType=DataType::INTEGRAL) const
	creates new OutputData with histogram's shape and values corresponding to DataType 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...
virtual size_t	rank () const =0
	Returns 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

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

Definition at line 27 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 ( )

virtualdefault

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

addBinContent()

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

Add the value to the bin.

Definition at line 151 of file IHistogram.cpp.

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

References m_data.

Referenced by operator+=().

array()

PyObject * IHistogram::array

(

DataType

dataType = DataType::INTEGRAL

)

const

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

Referenced by getArray().

Here is the call graph for this function:

binAverage() [1/2]

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

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

Here is the call graph for this function:

binAverage() [2/2]

double IHistogram::binAverage

(

size_t

i

)

const

Returns average value in the bin with given index.

Definition at line 166 of file IHistogram.cpp.

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

References m_data.

Referenced by binAverage(), and binData().

binContent() [1/2]

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

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

Definition at line 141 of file IHistogram.cpp.

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

References binContent(), and getGlobalBin().

Here is the call graph for this function:

binContent() [2/2]

double IHistogram::binContent

(

size_t

i

)

const

Returns content (accumulated value) of bin i.

Definition at line 136 of file IHistogram.cpp.

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

References m_data.

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

binData()

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

protected

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 binAverage(), binContent(), binError(), and binNumberOfEntries().

Referenced by createOutputData(), and getDataVector().

Here is the call graph for this function:

binError() [1/2]

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

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

Here is the call graph for this function:

binError() [2/2]

double IHistogram::binError

(

size_t

i

)

const

Returns error of the bin with given index.

Definition at line 156 of file IHistogram.cpp.

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

References m_data.

Referenced by binData(), and binError().

binNumberOfEntries() [1/2]

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

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

Here is the call graph for this function:

binNumberOfEntries() [2/2]

int IHistogram::binNumberOfEntries

(

size_t

i

)

const

Returns number of entries in the bin with given index.

Definition at line 176 of file IHistogram.cpp.

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

References m_data.

Referenced by binData(), and binNumberOfEntries().

check_x_axis()

void IHistogram::check_x_axis ( ) const

protected

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

Referenced by xAxis(), and xAxisValue().

Here is the call graph for this function:

check_y_axis()

void IHistogram::check_y_axis ( ) const

protected

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

Referenced by yAxis(), and yAxisValue().

Here is the call graph for this function:

clone()

virtual IHistogram* IHistogram::clone ( ) const

pure virtual

Implemented in Histogram2D, and Histogram1D.

Referenced by relativeDifferenceHistogram().

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

Referenced by load().

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 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 )

static

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 )

static

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

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 binData(), OutputData< T >::copyShapeFrom(), getTotalNumberOfBins(), and m_data.

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

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

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

Here is the call graph for this function:

getArray()

PyObject * IHistogram::getArray

(

DataType

dataType = DataType::INTEGRAL

)

const

Deprecated:

Use array() instead.

Definition at line 232 of file IHistogram.cpp.

{
    return array(dataType);
}

References array().

Here is the call graph for this function:

getData() [1/2]

OutputData< CumulativeValue > & IHistogram::getData

(

)

Definition at line 131 of file IHistogram.cpp.

{
    return m_data;
}

References m_data.

getData() [2/2]

const OutputData< CumulativeValue > & IHistogram::getData

(

)

const

Definition at line 126 of file IHistogram.cpp.

{
    return m_data;
}

References m_data.

Referenced by HistoUtils::getRelativeDifference().

getDataVector()

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

protected

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

Referenced by Histogram1D::binErrors(), and Histogram1D::binValues().

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

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

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

Here is the call graph for this function:

getMaximum()

double IHistogram::getMaximum

(

)

const

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

Here is the call graph for this function:

getMinimum()

double IHistogram::getMinimum

(

)

const

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

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

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

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

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

Here is the call graph for this function:

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:

getXmax()

double IHistogram::getXmax

(

)

const

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

Definition at line 61 of file IHistogram.cpp.

{
    return xAxis().upperBound();
}

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

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

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

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

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

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

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

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

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

init_from_data()

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

protected

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

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

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

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

operator+=()

const IHistogram & IHistogram::operator+=

(

const IHistogram &

right

)

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

Here is the call graph for this function:

rank()

virtual size_t IHistogram::rank ( ) 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().

relativeDifferenceHistogram()

IHistogram * IHistogram::relativeDifferenceHistogram

(

const IHistogram &

rhs

)

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

Here is the call graph for this function:

reset()

void IHistogram::reset

(

)

Reset histogram content (axes remains)

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

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

)

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

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

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

References m_data.

Referenced by relativeDifferenceHistogram().

xAxis()

const IAxis & IHistogram::xAxis

(

)

const

returns x-axis

Definition at line 44 of file IHistogram.cpp.

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

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

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

Here is the call graph for this function:

xAxisIndex()

size_t IHistogram::xAxisIndex

(

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:

xAxisValue()

double IHistogram::xAxisValue

(

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:

yAxis()

const IAxis & IHistogram::yAxis

(

)

const

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

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

Here is the call graph for this function:

yAxisIndex()

size_t IHistogram::yAxisIndex

(

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:

yAxisValue()

double IHistogram::yAxisValue

(

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:

Member Data Documentation

m_data

OutputData<CumulativeValue> IHistogram::m_data

protected

Definition at line 193 of file IHistogram.h.

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

---

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