ucar.nc2.dataset

Enum NetcdfDataset.Enhance

java.lang.Object

java.lang.Enum<NetcdfDataset.Enhance>

ucar.nc2.dataset.NetcdfDataset.Enhance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NetcdfDataset.Enhance>

Enclosing class:

NetcdfDataset

public static enum NetcdfDataset.Enhance
extends java.lang.Enum<NetcdfDataset.Enhance>

Possible enhancements for a NetcdfDataset

Enum Constant Summary

Enum Constants

Enum Constant and Description
ApplyNormalizer Calculate minimum value and range (maximum - minimum) and apply to data: (z - min)/range.
ApplyScaleOffset Apply scale and offset to values, promoting the data type if needed.
ApplyStandardizer Calculate mean and standard deviation and apply to data: (z-mean)/standard_deviation.
ConvertEnums Convert enums to Strings.
ConvertMissing Replace missing data with NaNs, for efficiency.
ConvertUnsigned Convert unsigned values to signed values.
CoordSystems Build coordinate systems.
IncompleteCoordSystems Build coordinate systems allowing for incomplete coordinate systems (i.e.

Method Summary

Modifier and Type	Method and Description
static NetcdfDataset.Enhance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NetcdfDataset.Enhance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ApplyNormalizer

public static final NetcdfDataset.Enhance ApplyNormalizer

Calculate minimum value and range (maximum - minimum) and apply to data: (z - min)/range. If the enhanced data type is not FLOAT or DOUBLE, this has no effect.

ApplyScaleOffset

public static final NetcdfDataset.Enhance ApplyScaleOffset

Apply scale and offset to values, promoting the data type if needed.

ApplyStandardizer

public static final NetcdfDataset.Enhance ApplyStandardizer

Calculate mean and standard deviation and apply to data: (z-mean)/standard_deviation. If the enhanced data type is not FLOAT or DOUBLE, this has no effect.

ConvertEnums

public static final NetcdfDataset.Enhance ConvertEnums

Convert enums to Strings.

ConvertMissing

public static final NetcdfDataset.Enhance ConvertMissing

Replace missing data with NaNs, for efficiency. Note that if the enhanced data type is not FLOAT or DOUBLE, this has no effect.

ConvertUnsigned

public static final NetcdfDataset.Enhance ConvertUnsigned

Convert unsigned values to signed values. For CDM.UNSIGNED variables, reinterpret the bit patterns of any negative values as unsigned. The result will be positive values that must be stored in a larger data type.

CoordSystems

public static final NetcdfDataset.Enhance CoordSystems

Build coordinate systems.

IncompleteCoordSystems

public static final NetcdfDataset.Enhance IncompleteCoordSystems

Build coordinate systems allowing for incomplete coordinate systems (i.e. not every dimension in a variable has a corresponding coordinate variable.

Method Detail

valueOf

public static NetcdfDataset.Enhance valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static NetcdfDataset.Enhance[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NetcdfDataset.Enhance c : NetcdfDataset.Enhance.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared