com.highqsoft.calculator

Class Histogram

java.lang.Object

com.highqsoft.calculator.Histogram

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EventCount, HistogramCount, JunctionCount, LevelCrossingCount, MaxMinCount, Rainflow, RangeCount, RangeMeanCount, RangePairCount, RangePairMeanCount, TimeAtLevelCount, ZeroCrossingPeakCount, ZeroPeakCount

public abstract class Histogram
extends java.lang.Object
implements java.io.Serializable

This is the abstract base implementaion for all histogram calculators.

Since:

$Date: 2017/04/06 13:28:40 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

ImplementationIF, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Histogram.Extrema

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INCREASE
protected boolean	isClassMaximumValid
protected boolean	isClassMinimumValid
protected java.util.Map<java.lang.String,java.lang.Object>	parameters

Constructor Summary

Constructors

Constructor and Description
Histogram() Initialize the histogram.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	calculate() Calculate the histogram.
protected short[]	getClasses(int numberOfBins, double filterWidth, double[] arr, double min, double max) Classify data into a class array.
protected short[]	getClasses(int numberOfBins, double filterWidth, float[] arr, double min, double max) Classify data into a class array.
protected short[]	getClasses(int numberOfBins, double filterWidth, int[] arr, double min, double max) Classify data into a class array.
protected short[]	getClasses(int numberOfBins, double filterWidth, long[] arr, double min, double max) Classify data into a class array.
protected short[]	getClasses(int numberOfBins, double filterWidth, short[] arr, double min, double max) Classify data into a class array.
double	getClassMaximum() Gets the maximum of the class range.
double	getClassMinimum() Gets the minimum of the class range.
double	getFilterWidthRelative() Get the filter width.
double	getMaximum() Gets the maximum of the value range.
double	getMinimum() Gets the minimum of the value range.
int	getNumberOfBins() Gets the total number of classes.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Get the paraemters.
java.lang.String	getUnit() Retrieves the unit string.
void	setClassMaximum(double max) Sets the maximum of the class range.
void	setClassMinimum(double min) Sets the minimum of the class range.
void	setFilterWidthRelative(double filterWidth) Set the width of the hysterese filter.
void	setMaximum(double max) Sets the maximum of the value range.
void	setMinimum(double min) Sets the minimum of the value range.
void	setNumberOfBins(int numberOfBins) Sets the total number of of classes.
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> map) Set the paraemters.
void	setUnit(java.lang.String unit) Sets the unit string.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected java.util.Map<java.lang.String,java.lang.Object> parameters

isClassMinimumValid

protected boolean isClassMinimumValid

isClassMaximumValid

protected boolean isClassMaximumValid

INCREASE

protected static final int INCREASE

See Also:

Constant Field Values

Constructor Detail

Histogram

public Histogram()

Initialize the histogram.

Method Detail

calculate

public abstract void calculate()
                        throws java.lang.Exception

Calculate the histogram.

Throws:

java.lang.Exception

setNumberOfBins

public void setNumberOfBins(int numberOfBins)

Sets the total number of of classes. The default value is 64.

Parameters:

numberOfBins - the total number of classes.

getNumberOfBins

public int getNumberOfBins()

Gets the total number of classes.

Returns:

the total number of classes.

See Also:

setNumberOfBins(int)

setClassMinimum

public void setClassMinimum(double min)

Sets the minimum of the class range. The default value is dataMin - (dataMax-dataMin)/2/(numberOfBins-1).

Parameters:

numberOfBins - the total number of classes.

getClassMinimum

public double getClassMinimum()

Gets the minimum of the class range.

Returns:

the minimum of the class range.

See Also:

setClassMinimum(double)

setClassMaximum

public void setClassMaximum(double max)

Sets the maximum of the class range. The default value is dataMax + (dataMax-dataMin)/2/(numberOfBins-1).

Parameters:

numberOfBins - the total number of classes.

getClassMaximum

public double getClassMaximum()

Gets the maximum of the class range.

Returns:

the maximum of the class range.

See Also:

setClassMaximum(double)

setMinimum

public void setMinimum(double min)

Sets the minimum of the value range.

Parameters:

min - the minimum of the value range.

getMinimum

public double getMinimum()

Gets the minimum of the value range.

Returns:

the minimum of the value range.

See Also:

setClassMinimum(double)

setMaximum

public void setMaximum(double max)

Sets the maximum of the value range.

Parameters:

max - the maximum of the value range.

getMaximum

public double getMaximum()

Gets the maximum of the value range.

Returns:

the maximum of the class range.

See Also:

setClassMaximum(double)

setUnit

public void setUnit(java.lang.String unit)

Sets the unit string.

Parameters:

unit - the unit string.

getUnit

public java.lang.String getUnit()

Retrieves the unit string.

Returns:

the unit string.

See Also:

setUnit(String)

setFilterWidthRelative

public void setFilterWidthRelative(double filterWidth)

Set the width of the hysterese filter. The default is 0.

Parameters:

filterWidth - the width of the hysterese filter. This value must be specified reltative to the class width. e.g. if this vlaue is 10 it means that the filter width is 0.1*classwdith.

getFilterWidthRelative

public double getFilterWidthRelative()

Get the filter width.

Returns:

the class width

See Also:

setFilterWidth(double)

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Get the paraemters.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> map)

Set the paraemters. Keywords will be changed to upper case letters.

getClasses

protected short[] getClasses(int numberOfBins,
                 double filterWidth,
                 float[] arr,
                 double min,
                 double max)

Classify data into a class array.

Parameters:

numberOfBins - the total number of classes.

fitlerWidth - the width in percent of the class width.

arr - the data array.

min - the minimum of data value.

max - the maximum of data value.

Returns:

the classified data.

getClasses

protected short[] getClasses(int numberOfBins,
                 double filterWidth,
                 double[] arr,
                 double min,
                 double max)

Classify data into a class array.

Parameters:

numberOfBins - the total number of classes.

fitlerWidth - the width in percent of the class width.

arr - the data array.

min - the minimum of data value.

max - the maximum of data value.

Returns:

the classified data.

getClasses

protected short[] getClasses(int numberOfBins,
                 double filterWidth,
                 short[] arr,
                 double min,
                 double max)

Classify data into a class array.

Parameters:

numberOfBins - the total number of classes.

fitlerWidth - the width in percent of the class width.

arr - the data array.

min - the minimum of data value.

max - the maximum of data value.

Returns:

the classified data.

getClasses

protected short[] getClasses(int numberOfBins,
                 double filterWidth,
                 int[] arr,
                 double min,
                 double max)

Classify data into a class array.

Parameters:

numberOfBins - the total number of classes.

fitlerWidth - the width in percent of the class width.

arr - the data array.

min - the minimum of data value.

max - the maximum of data value.

Returns:

the classified data.

getClasses

protected short[] getClasses(int numberOfBins,
                 double filterWidth,
                 long[] arr,
                 double min,
                 double max)

Classify data into a class array.

Parameters:

numberOfBins - the total number of classes.

fitlerWidth - the width in percent of the class width.

arr - the data array.

min - the minimum of data value.

max - the maximum of data value.

Returns:

the classified data.