de.lmu.ifi.dbs.jfeaturelib.utils

Class Interpolated1DHistogram

java.lang.Object

de.lmu.ifi.dbs.jfeaturelib.utils.Interpolated1DHistogram

public class Interpolated1DHistogram
extends Object

The Interpolated1DHistogram class is used to create interpolates histograms for a certain range of values ([min,max[) with a defined range of bins. Values that are added to the histogram are interpolated to ne nearest neighboring bin according to the distance of the value to the center of the bin. If the according neighbor is out of the range of the histogram, then the according interpolated value is skipped silently and the value of one bin is raised only:

 Interpolated1DHistogram ih = new Interpolated1DHistogram(0,3,3);
 ih.add(0);    // histogram: 0.5, 0, 0
 ih.add(1.5);  // histogram: 0.5, 1, 0
 

Since:

11/4/2011

Author:

graf

Constructor Summary

Constructors

Constructor and Description
Interpolated1DHistogram(double min, double max, int binCount) Initializes the histogram with user defined min, max and count values

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double pos) Raises the histogram at the specivied key position by 1 (might decrease due to interpolation).
void	add(double pos, double value) Raises the histogram at the specivied key position by value (might decrease due to interpolation).
void	clear() Resets the data array by filling it with zero.
double[]	getData() Returns a reference(!)
String	toString() Returns a string representation of the histogram.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Interpolated1DHistogram

public Interpolated1DHistogram(double min,
                       double max,
                       int binCount)

Initializes the histogram with user defined min, max and count values

Parameters:

min - inclusive lower bound

max - exclusive upper bound

binCount - amount of bins between min and max

Method Detail

add

public void add(double pos)

Raises the histogram at the specivied key position by 1 (might decrease due to interpolation).

Parameters:

pos - in the range of [min, max[

add

public void add(double pos,
       double value)

Raises the histogram at the specivied key position by value (might decrease due to interpolation).

Parameters:

pos - in the range of [min, max[

value -

getData

public double[] getData()

Returns a reference(!) to the data array.

Returns:

the data array

clear

public void clear()

Resets the data array by filling it with zero.

toString

public String toString()

Returns a string representation of the histogram. The string is a comma separated concatenation of the values

Overrides:

toString in class Object

Returns:

string representation of the ata array