org.gridfour.lsop

Class LsOptimalPredictorResult

java.lang.Object

org.gridfour.lsop.LsOptimalPredictorResult

public class LsOptimalPredictorResult
extends Object

Provides a simple class for holding the results from an LSOP predictor analysis operation.

Constructor Summary

Constructors

Constructor and Description
LsOptimalPredictorResult(int seed, int nCoefficients, float[] coefficients, int nInitializerCodes, byte[] initializerCodes, int nInteriorCodes, byte[] interiorCodes)

Method Summary

Modifier and Type	Method and Description
int	getCoefficientCount() Gets the number of coefficients stored for the predictor that produced these results.
float[]	getCoefficients() Get the computed coefficients for the optimal predictors.
int	getInitializerCodeCount() Gets the number of unique symbols that comprise the initialization portion of the encoded data.
byte[]	getInitializerCodes() Get the sequence of symbols for the initialization sequence.
int	getInteriorCodeCount() Gets the number of unique symbols that comprise the interior portion of the encoded data.
byte[]	getInteriorCodes() Get an array of the M32 codes computed by the encoder.
int	getSeed() Gets the initial "seed" value for the encoding sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

LsOptimalPredictorResult

public LsOptimalPredictorResult(int seed,
                                int nCoefficients,
                                float[] coefficients,
                                int nInitializerCodes,
                                byte[] initializerCodes,
                                int nInteriorCodes,
                                byte[] interiorCodes)

Method Detail

getInteriorCodes

public byte[] getInteriorCodes()

Get an array of the M32 codes computed by the encoder.

Returns:

a valid array of bytes giving Gridfour M32 codes.

getInteriorCodeCount

public int getInteriorCodeCount()

Gets the number of unique symbols that comprise the interior portion of the encoded data.

Returns:

a positive value greater than zero.

getSeed

public int getSeed()

Gets the initial "seed" value for the encoding sequence. The seed a literal copy of initial value from the original raster.

Returns:

the initial value in the original raster data.

getCoefficientCount

public int getCoefficientCount()

Gets the number of coefficients stored for the predictor that produced these results.

Returns:

a positive integer.

getCoefficients

public float[] getCoefficients()

Get the computed coefficients for the optimal predictors. Note: the length of the coefficient array may exceed the coefficient count.

Returns:

an array of a length as large or larger than the number of coefficients produced by the predictor.

getInitializerCodeCount

public int getInitializerCodeCount()

Gets the number of unique symbols that comprise the initialization portion of the encoded data.

Returns:

a positive value greater than zero.

getInitializerCodes

public byte[] getInitializerCodes()

Get the sequence of symbols for the initialization sequence.

Returns:

a valid array of bytes giving Gridfour M32 codes.