org.openimaj.math.statistics.distribution

Class Histogram

java.lang.Object

org.openimaj.feature.ArrayFeatureVector<double[]>

org.openimaj.feature.DoubleFV

org.openimaj.math.statistics.distribution.Histogram

All Implemented Interfaces:

Serializable, Cloneable, FeatureVector, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Concatenatable<DoubleFV,DoubleFV>

public class Histogram
extends DoubleFV

Simple Histogram based on a DoubleFV.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openimaj.feature.ArrayFeatureVector

values

Constructor Summary

Constructors

Constructor and Description
Histogram(double[] data) Construct from values array and dimensions
Histogram(DoubleFV... hs) Construct a histogram by concatenating the given histograms
Histogram(int nbins) Construct a histogram with the given number of bins.

Method Summary

Modifier and Type	Method and Description
Histogram	clone()
Histogram	combine(Histogram... hs) Create a new histogram by concatenating this one with the given ones.
double	max() Compute the maximum value in the histogram
void	normalise() Normalise to unit area
void	normaliseL1() l1 norm
void	normaliseL2() l2 norm

Methods inherited from class org.openimaj.feature.DoubleFV

asciiHeader, asDoubleFV, asDoubleVector, binaryHeader, compare, concatenate, concatenate, equals, get, getAsDouble, hashCode, length, newInstance, normaliseFV, normaliseFV, normaliseFV, normaliseFV, readASCII, readBinary, setFromDouble, subvector, subvector, toString, writeASCII, writeBinary

Methods inherited from class org.openimaj.feature.ArrayFeatureVector

getVector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Histogram

public Histogram(int nbins)

Construct a histogram with the given number of bins.

Parameters:

nbins - number of bins

Histogram

public Histogram(DoubleFV... hs)

Construct a histogram by concatenating the given histograms

Parameters:

hs - histograms to concatenate

Histogram

public Histogram(double[] data)

Construct from values array and dimensions

Parameters:

data - the flat array of values

Method Detail

normalise

public void normalise()

Normalise to unit area

normaliseL1

public void normaliseL1()

l1 norm

normaliseL2

public void normaliseL2()

l2 norm

max

public double max()

Compute the maximum value in the histogram

Returns:

the maximum value

clone

public Histogram clone()

Overrides:

clone in class DoubleFV

combine

public Histogram combine(Histogram... hs)

Create a new histogram by concatenating this one with the given ones.

Parameters:

hs - histograms to concatenate

Returns:

new histogram that is the concatenation of the argument histograms