org.expasy.mzjava.stats

Interface Histogram

All Superinterfaces:

Copyable<Histogram>

All Known Implementing Classes:

HistogramImpl

public interface Histogram
extends Copyable<Histogram>

Histogram groups numbers into bins (class intervals) of same width. It can represent standard frequency Histograms where each bin contain the number of occurrence of all values that fall into it or can represent weighed Histograms where each bin contain the sum of weighted values that fall into it.

Version:

1.0

Author:

nikitin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Histogram.Normalization Type of Histogram Normalization

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addData(double value) Add one occurrence of value
void	addData(double[] values) Add one occurrence of each value
void	addData(double[] values, double[] weights)
boolean	addData(double value, double weight) Add value contributing with weight
boolean	addData(double value, double weight, com.google.common.base.Predicate<Double> predicate) Add the data into this histogram if the given predicate is true
boolean	addDataAtBin(double weight, int index) Add data at given bin
void	clear() Empty data
double	getAbsoluteBinFreq(int index) Get the absolute frequency at given bin
double[]	getAbsoluteBinFreqs(double[] dest)
int	getBinIndex(double value) Get the bin index containing the given value (else must return -1)
double	getBinWidth() Get the bin width
double[]	getBreaks(double[] dest) Get the n+1 cells boundaries
double	getCumulFreqs() Get the counts of the cumulative number of observations in all bins
double	getCumulFreqs(int fromIncluded, int toExcluded) Get the counts of the cumulative number of weighed observations in all of the bins in the specifed range
double[]	getMids(double[] dest) Get the n cell midpoints
int	getMostIntenseBinIndex() Get the most intense bin index
String	getName() Get its name
Set<Integer>	getNonEmptyBinIndices() Get the set of non-empty bins
com.google.common.collect.Range<Double>	getRange() Get the range of defined values (first to last bin)
double	getRelativeBinFreq(int index) Get the relative (normalized by the cumulative weights) weighted frequencies at given bin
double	getRelativeBinFreq(int fromIncluded, int toExcluded) Get the relative (normalized by the cumulative weights) weighted frequencies between bins
boolean	isEmpty() Return true if no data
Histogram	normalize(Histogram.Normalization normalization) Normalize histogram (weighted) frequencies
Histogram	shallowCopy() Copy the bin structure only
int	size() Get the number of bins (n)

Methods inherited from interface org.expasy.mzjava.utils.Copyable

copy

Method Detail

getName

String getName()

Get its name

shallowCopy

Histogram shallowCopy()

Copy the bin structure only

clear

void clear()

Empty data

isEmpty

boolean isEmpty()

Return true if no data

getRange

com.google.common.collect.Range<Double> getRange()

Get the range of defined values (first to last bin)

size

int size()

Get the number of bins (n)

getBinWidth

double getBinWidth()

Get the bin width

addData

boolean addData(double value,
              double weight,
              com.google.common.base.Predicate<Double> predicate)

Add the data into this histogram if the given predicate is true

addData

boolean addData(double value,
              double weight)

Add value contributing with weight

addData

boolean addData(double value)

Add one occurrence of value

addData

void addData(double[] values)

Add one occurrence of each value

addData

void addData(double[] values,
           double[] weights)

addDataAtBin

boolean addDataAtBin(double weight,
                   int index)

Add data at given bin

getNonEmptyBinIndices

Set<Integer> getNonEmptyBinIndices()

Get the set of non-empty bins

getBinIndex

int getBinIndex(double value)

Get the bin index containing the given value (else must return -1)

getMostIntenseBinIndex

int getMostIntenseBinIndex()

Get the most intense bin index

getAbsoluteBinFreq

double getAbsoluteBinFreq(int index)

Get the absolute frequency at given bin

getAbsoluteBinFreqs

double[] getAbsoluteBinFreqs(double[] dest)

getRelativeBinFreq

double getRelativeBinFreq(int index)

Get the relative (normalized by the cumulative weights) weighted frequencies at given bin

getRelativeBinFreq

double getRelativeBinFreq(int fromIncluded,
                        int toExcluded)

Get the relative (normalized by the cumulative weights) weighted frequencies between bins

getCumulFreqs

double getCumulFreqs()

Get the counts of the cumulative number of observations in all bins

getCumulFreqs

double getCumulFreqs(int fromIncluded,
                   int toExcluded)

Get the counts of the cumulative number of weighed observations in all of the bins in the specifed range

getBreaks

double[] getBreaks(double[] dest)

Get the n+1 cells boundaries

getMids

double[] getMids(double[] dest)

Get the n cell midpoints

normalize

Histogram normalize(Histogram.Normalization normalization)

Normalize histogram (weighted) frequencies