Package ucar.nc2.dataset

Class VariableEnhancer

java.lang.Object

ucar.nc2.dataset.VariableEnhancer

All Implemented Interfaces:

IsMissingEvaluator, EnhanceScaleMissingUnsigned

@Deprecated
public class VariableEnhancer
extends Object
implements EnhanceScaleMissingUnsigned

Deprecated.

Method Summary

Modifier and Type	Method	Description
double	applyScaleOffset(Number value)	Deprecated. Apply scale and offset to the specified value if EnhanceScaleMissingUnsigned.hasScaleOffset().
Array	applyScaleOffset(Array in)	Deprecated. Apply scale and offset to each element of in and return the result as a new Array, but only if EnhanceScaleMissingUnsigned.hasScaleOffset().
Array	convert(Array in, boolean convertUnsigned, boolean applyScaleOffset, boolean convertMissing)	Deprecated. Perform the specified conversions on each element of in and return the result as a new Array.
Number	convertMissing(Number value)	Deprecated. If value is missing, return Double.NaN.
Array	convertMissing(Array in)	Deprecated. Returns a copy of in, except that each missing value is replaced by Double.NaN.
Number	convertUnsigned(Number value)	Deprecated. Convert value to the next largest integral data type by an unsigned conversion.
Array	convertUnsigned(Array in)	Deprecated. Performs an unsigned conversion of each element of in and returns the result as a new Array.
double	getFillValue()	Deprecated. return value of _FillValue attribute
double[]	getMissingValues()	Deprecated. return values of missing_value attributes
double	getOffset()	Deprecated. The number to be added to the data after it is read.
DataType	getScaledOffsetType()	Deprecated. Return the data type for values that have undergone scale/offset conversion.
double	getScaleFactor()	Deprecated. The data are to be multiplied by this value after the data are read.
DataType.Signedness	getSignedness()	Deprecated. Returns the signedness of the decorated variable.
DataType	getUnsignedConversionType()	Deprecated. Return the data type for values that have undergone unsigned conversion.
double	getValidMax()	Deprecated. return the maximum value in the valid range
double	getValidMin()	Deprecated. return the minimum value in the valid range
boolean	hasFillValue()	Deprecated. true if Variable has _FillValue attribute
boolean	hasMissing()	Deprecated. true if Variable has missing data values
boolean	hasMissingValue()	Deprecated. true if Variable has missing_value attribute
boolean	hasScaleOffset()	Deprecated. true if Variable data will be converted using scale and offset
boolean	hasValidData()	Deprecated. true if Variable has valid_range, valid_min or valid_max attributes
boolean	isFillValue(double val)	Deprecated. return true if val equals the _FillValue
boolean	isInvalidData(double val)	Deprecated. return true if val is outside the valid range
boolean	isMissing(double val)	Deprecated. Returns true if the argument is a missing value.
boolean	isMissingValue(double val)	Deprecated. return true if val equals a missing_value (low-level)
static DataType	largestOf(DataType... dataTypes)	Deprecated. Returns the data type that is the largest among the arguments.
static DataType	nextLarger(DataType dataType)	Deprecated. Returns the smallest numeric data type that: can hold a larger integer than dataType can if integral, has the same signedness as dataType The relative sizes of data types are determined in a manner consistent with rank(DataType).
static int	rank(DataType dataType)	Deprecated. Returns a distinct integer for each of the numeric data types that can be used to (roughly) order them by the range of the DataType.
void	setFillValueIsMissing(boolean b)	Deprecated. Set if _FillValue is considered isMissing().
void	setInvalidDataIsMissing(boolean b)	Deprecated. set if valid_range is considered isMissing(); better set in constructor if possible
void	setMissingDataIsMissing(boolean b)	Deprecated. set if missing_data is considered isMissing(); better set in constructor if possible

Methods inherited from class java.lang.Object

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

Method Detail

rank

public static int rank(DataType dataType)

Deprecated.

Returns a distinct integer for each of the numeric data types that can be used to (roughly) order them by the range of the DataType. BYTE < UBYTE < SHORT < USHORT < INT < UINT < LONG < ULONG < FLOAT < DOUBLE. -1 will be returned for all non-numeric data types.

Parameters:

dataType - a numeric data type.

Returns:

a distinct integer for each of the numeric data types that can be used to (roughly) order them by size.

largestOf

public static DataType largestOf(DataType... dataTypes)

Deprecated.

Returns the data type that is the largest among the arguments. Relative sizes of data types are determined via rank(DataType).

Parameters:

dataTypes - an array of numeric data types.

Returns:

the data type that is the largest among the arguments.

nextLarger

public static DataType nextLarger(DataType dataType)

Deprecated.

Returns the smallest numeric data type that:

1. can hold a larger integer than dataType can
2. if integral, has the same signedness as dataType

The relative sizes of data types are determined in a manner consistent with rank(DataType).

Argument	Result
BYTE	SHORT
UBYTE	USHORT
SHORT	INT
USHORT	UINT
INT	LONG
UINT	ULONG
LONG	DOUBLE
ULONG	DOUBLE
Any other data type	Just return argument

The returned type is intended to be just big enough to hold the result of performing an unsigned conversion of a value of the smaller type. For example, the byte value -106 equals 150 when interpreted as unsigned. That won't fit in a (signed) byte, but it will fit in a short.

Parameters:

dataType - an integral data type.

Returns:

the next larger type.

getScaleFactor

public double getScaleFactor()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

The data are to be multiplied by this value after the data are read. By default it is 1.0, i.e. no scaling. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.

Specified by:

getScaleFactor in interface EnhanceScaleMissingUnsigned

Returns:

the multiplier to apply to the data.

getOffset

public double getOffset()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

The number to be added to the data after it is read. If both CDM.SCALE_FACTOR and CDM.ADD_OFFSET attributes are present, the data are first scaled before the offset is added. By default it is 0.0, i.e. no offset. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.

Specified by:

getOffset in interface EnhanceScaleMissingUnsigned

Returns:

the number to add to the data.

getSignedness

public DataType.Signedness getSignedness()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Returns the signedness of the decorated variable.

Specified by:

getSignedness in interface EnhanceScaleMissingUnsigned

Returns:

the signedness of the decorated variable.

getScaledOffsetType

public DataType getScaledOffsetType()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Return the data type for values that have undergone scale/offset conversion. This will be null if the decorated variable lacks scale_factor or add_offset attributes. You can check with EnhanceScaleMissingUnsigned.hasScaleOffset().

Specified by:

getScaledOffsetType in interface EnhanceScaleMissingUnsigned

Returns:

the data type for values that have undergone scale/offset conversion.

getUnsignedConversionType

@Nonnull
public DataType getUnsignedConversionType()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Return the data type for values that have undergone unsigned conversion. This will never be null, even when no unsigned conversion is necessary (because the underlying variable isn't unsigned). In such cases, this data type will be the same as that of the underlying variable.

Specified by:

getUnsignedConversionType in interface EnhanceScaleMissingUnsigned

Returns:

the data type for values that have undergone unsigned conversion.

hasValidData

public boolean hasValidData()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

true if Variable has valid_range, valid_min or valid_max attributes

Specified by:

hasValidData in interface EnhanceScaleMissingUnsigned

getValidMin

public double getValidMin()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return the minimum value in the valid range

Specified by:

getValidMin in interface EnhanceScaleMissingUnsigned

getValidMax

public double getValidMax()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return the maximum value in the valid range

Specified by:

getValidMax in interface EnhanceScaleMissingUnsigned

isInvalidData

public boolean isInvalidData(double val)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return true if val is outside the valid range

Specified by:

isInvalidData in interface EnhanceScaleMissingUnsigned

hasFillValue

public boolean hasFillValue()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

true if Variable has _FillValue attribute

Specified by:

hasFillValue in interface EnhanceScaleMissingUnsigned

isFillValue

public boolean isFillValue(double val)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return true if val equals the _FillValue

Specified by:

isFillValue in interface EnhanceScaleMissingUnsigned

getFillValue

public double getFillValue()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return value of _FillValue attribute

Specified by:

getFillValue in interface EnhanceScaleMissingUnsigned

hasScaleOffset

public boolean hasScaleOffset()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

true if Variable data will be converted using scale and offset

Specified by:

hasScaleOffset in interface EnhanceScaleMissingUnsigned

hasMissingValue

public boolean hasMissingValue()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

true if Variable has missing_value attribute

Specified by:

hasMissingValue in interface EnhanceScaleMissingUnsigned

isMissingValue

public boolean isMissingValue(double val)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return true if val equals a missing_value (low-level)

Specified by:

isMissingValue in interface EnhanceScaleMissingUnsigned

getMissingValues

public double[] getMissingValues()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

return values of missing_value attributes

Specified by:

getMissingValues in interface EnhanceScaleMissingUnsigned

setFillValueIsMissing

public void setFillValueIsMissing(boolean b)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Set if _FillValue is considered isMissing().

Specified by:

setFillValueIsMissing in interface EnhanceScaleMissingUnsigned

setInvalidDataIsMissing

public void setInvalidDataIsMissing(boolean b)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

set if valid_range is considered isMissing(); better set in constructor if possible

Specified by:

setInvalidDataIsMissing in interface EnhanceScaleMissingUnsigned

setMissingDataIsMissing

public void setMissingDataIsMissing(boolean b)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

set if missing_data is considered isMissing(); better set in constructor if possible

Specified by:

setMissingDataIsMissing in interface EnhanceScaleMissingUnsigned

hasMissing

public boolean hasMissing()

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

true if Variable has missing data values

Specified by:

hasMissing in interface EnhanceScaleMissingUnsigned

Specified by:

hasMissing in interface IsMissingEvaluator

Returns:

true if Variable has missing data values

isMissing

public boolean isMissing(double val)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Returns true if the argument is a missing value. Note that Float.NaN and Double.NaN are considered missing data.

Specified by:

isMissing in interface EnhanceScaleMissingUnsigned

Specified by:

isMissing in interface IsMissingEvaluator

Parameters:

val - an unpacked value.

Returns:

true if the argument is a missing value.

convertUnsigned

public Number convertUnsigned(Number value)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Convert value to the next largest integral data type by an unsigned conversion. The conversion only happens if the decorated variable is unsigned and value is a negative integer. Otherwise, simply return value.

Specified by:

convertUnsigned in interface EnhanceScaleMissingUnsigned

Parameters:

value - an integral number to convert.

Returns:

the result of an unsigned conversion of value.

convertUnsigned

public Array convertUnsigned(Array in)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Performs an unsigned conversion of each element of in and returns the result as a new Array. The data type of the returned array will be EnhanceScaleMissingUnsigned.getUnsignedConversionType().

Specified by:

convertUnsigned in interface EnhanceScaleMissingUnsigned

Parameters:

in - an Array containing integral Numbers to convert.

Returns:

the result of an unsigned conversion of each element of in.

applyScaleOffset

public double applyScaleOffset(Number value)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Apply scale and offset to the specified value if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value.

Specified by:

applyScaleOffset in interface EnhanceScaleMissingUnsigned

applyScaleOffset

public Array applyScaleOffset(Array in)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Apply scale and offset to each element of in and return the result as a new Array, but only if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value. Otherwise, just return data.

Specified by:

applyScaleOffset in interface EnhanceScaleMissingUnsigned

Parameters:

in - convert this

Returns:

converted data.

convertMissing

public Number convertMissing(Number value)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

If value is missing, return Double.NaN. Otherwise, simply return value

Specified by:

convertMissing in interface EnhanceScaleMissingUnsigned

convertMissing

public Array convertMissing(Array in)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Returns a copy of in, except that each missing value is replaced by Double.NaN.

Specified by:

convertMissing in interface EnhanceScaleMissingUnsigned

Parameters:

in - an array containing floating-point numbers to convert.

Returns:

the result of a missing conversion of each element of in.

convert

public Array convert(Array in,
                     boolean convertUnsigned,
                     boolean applyScaleOffset,
                     boolean convertMissing)

Deprecated.

Description copied from interface: EnhanceScaleMissingUnsigned

Perform the specified conversions on each element of in and return the result as a new Array. Note that this method is more efficient than calling EnhanceScaleMissingUnsigned.convertUnsigned(Array), followed by EnhanceScaleMissingUnsigned.applyScaleOffset(Array), followed by EnhanceScaleMissingUnsigned.convertMissing(Array), as only one copy of in is made.

Specified by:

convert in interface EnhanceScaleMissingUnsigned

Parameters:

in - a numeric array.

convertUnsigned - true if we should convert unsigned.

applyScaleOffset - true if we should apply scale/offset.

convertMissing - true if we should convert missing.

Returns:

a new array, with the specified conversions performed.