icy.math

Class Histogram

java.lang.Object

icy.math.Histogram

public class Histogram
extends java.lang.Object

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
Histogram(double minValue, double maxValue, int nbBin, boolean integer) Create a histogram for the specified value range and the desired number of bins.

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(double value) Add the value to the histogram
void	addValues(byte[] array, boolean signed) Add the specified byte array to the histogram
void	addValues(double[] array) Add the specified double array to the histogram
void	addValues(float[] array) Add the specified float array to the histogram
void	addValues(int[] array, boolean signed) Add the specified int array to the histogram
void	addValues(long[] array, boolean signed) Add the specified long array to the histogram
void	addValues(java.lang.Object array, boolean signed) Add the specified array of values to the histogram
void	addValues(short[] array, boolean signed) Add the specified short array to the histogram
void	doXLSExport() Do the XLS export (display the save dialog)
void	exportToXLS(java.lang.String path) Export the content of the histogram data inside an excel file (XLS format if file path extension is XLS, CSV otherwise)
int	getBinNumber() Returns the number of bins of the histogram.
int[]	getBins() Returns bins of histogram
int	getBinSize(int index) Returns the size of the specified bin (number of element in the bin)
double	getBinWidth() Return the width of a bin
java.lang.String	getCSVFormattedData() Returns histogram data in CSV format (tab separated).
double	getMaxValue() Returns the maximum allowed value of the histogram.
double	getMinValue() Returns the minimum allowed value of the histogram.
boolean	isIntegerType() Returns true if the input value are integer values only.
void	reset() Reset histogram

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Histogram

public Histogram(double minValue,
         double maxValue,
         int nbBin,
         boolean integer)

Create a histogram for the specified value range and the desired number of bins.

Parameters:

minValue - minimum value

maxValue - maximum value

nbBin - number of desired bins (should be > 0).

integer - If true the input value are considered as integer values.
Bins number is then clamped to values range to not bias the histogram.
In this case the effective number of bins can differ from the desired one.

Method Detail

getCSVFormattedData

public java.lang.String getCSVFormattedData()

Returns histogram data in CSV format (tab separated).

doXLSExport

public void doXLSExport()
                 throws java.io.IOException,
                        jxl.write.WriteException

Do the XLS export (display the save dialog)

Throws:

java.io.IOException

jxl.write.WriteException

exportToXLS

public void exportToXLS(java.lang.String path)
                 throws java.io.IOException,
                        jxl.write.WriteException

Export the content of the histogram data inside an excel file (XLS format if file path extension is XLS, CSV otherwise)

Throws:

java.io.IOException

jxl.write.WriteException

reset

public void reset()

Reset histogram

addValue

public void addValue(double value)

Add the value to the histogram

addValues

public void addValues(java.lang.Object array,
             boolean signed)

Add the specified array of values to the histogram

Parameters:

signed - false if the input array should be interpreted as unsigned values
(integer type only)

addValues

public void addValues(byte[] array,
             boolean signed)

Add the specified byte array to the histogram

addValues

public void addValues(short[] array,
             boolean signed)

Add the specified short array to the histogram

addValues

public void addValues(int[] array,
             boolean signed)

Add the specified int array to the histogram

addValues

public void addValues(long[] array,
             boolean signed)

Add the specified long array to the histogram

addValues

public void addValues(float[] array)

Add the specified float array to the histogram

addValues

public void addValues(double[] array)

Add the specified double array to the histogram

getMinValue

public double getMinValue()

Returns the minimum allowed value of the histogram.

getMaxValue

public double getMaxValue()

Returns the maximum allowed value of the histogram.

isIntegerType

public boolean isIntegerType()

Returns true if the input value are integer values only.
This is used to adapt the bin number.

getBinNumber

public int getBinNumber()

Returns the number of bins of the histogram.

getBinWidth

public double getBinWidth()

Return the width of a bin

getBinSize

public int getBinSize(int index)

Returns the size of the specified bin (number of element in the bin)

getBins

public int[] getBins()

Returns bins of histogram