pixeljelly.features

Class MinMax

java.lang.Object

pixeljelly.features.MinMax

public class MinMax
extends java.lang.Object

The MinMax class presents a convenient method for obtaining and using the minimum and maximum values within a BufferedImage. All sample values must be explicitly included and the MinMax class will retain the maximum and minimum included samples.

Constructor Summary

Constructors

Constructor and Description
MinMax(int numberOfBands) Constructs a MinMax object having the specified number of bands.

Method Summary

Methods

Modifier and Type	Method and Description
double	getMax() Returns the maximum of all included values over all bands.
double	getMax(int band) Returns the maximum of all included values in the specified band.
double	getMin() Returns the minimum of all included values over all bands.
double	getMin(int band) Returns the minimum of all included values in the specified band.
void	include(double val, int band) A value is included in the specified band.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinMax

public MinMax(int numberOfBands)

Constructs a MinMax object having the specified number of bands.

Parameters:

numberOfBands - The number of bands in the data source.

Method Detail

include

public void include(double val,
           int band)

A value is included in the specified band. If value is less than the previous minimum in the band, then the minimum is set to value. If value is greater than the previous maximum in the band then the maximum is set to value.

Parameters:

val - A value that exists in the specified band

band - A band index in the range 0 to numberOfBands-1.

getMax

public double getMax(int band)

Returns the maximum of all included values in the specified band.

Parameters:

band - A band index in the range 0 to numberOfBands-1.

Returns:

the maximum of all included values for the specified band. If no values have been included this will return Double.NEGATIVE_INFINITY.

getMin

public double getMin(int band)

Returns the minimum of all included values in the specified band.

Parameters:

band - A band index in the range 0 to numberOfBands-1.

Returns:

the maximum of all included values for the specified band. If no values have been included this will return Double.NEGATIVE_INFINITY.

getMax

public double getMax()

Returns the maximum of all included values over all bands.

Returns:

the maximum of all included values over all bands. If no values have been included this will return Double.NEGATIVE_INFINITY.

getMin

public double getMin()

Returns the minimum of all included values over all bands.

Returns:

the minimum of all included values over all bands. If no values have been included this will return Double.POSITIVE_INFINITY.