visad
Class FloatSet

java.lang.Object
  visad.ThingImpl
      visad.DataImpl
          visad.Set
              visad.SimpleSet
                  visad.FloatSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Data, SetIface, SimpleSetIface, Thing

public class FloatSet
extends SimpleSet

FloatSet represents the finite (but large) set of samples of R^dimension made by vectors of IEEE single precision floating point numbers. FloatSet objects are immutable.

FloatSet cannot be used for the domain sampling of a Field.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class visad.DataImpl

DataImpl.Syncher

Field Summary

Fields inherited from interface visad.Data

ABS, ACOS, ACOS_DEGREES, ADD, ASIN, ASIN_DEGREES, ATAN, ATAN_DEGREES, ATAN2, ATAN2_DEGREES, CEIL, COS, COS_DEGREES, DEGREES_TO_RADIANS, DEPENDENT, DIVIDE, EXP, FLOOR, INDEPENDENT, INV_ATAN2, INV_ATAN2_DEGREES, INV_DIVIDE, INV_POW, INV_REMAINDER, INV_SUBTRACT, LOG, MAX, MIN, MULTIPLY, NEAREST_NEIGHBOR, NEGATE, NO_ERRORS, NOP, POW, RADIANS_TO_DEGREES, REMAINDER, RINT, ROUND, SIN, SIN_DEGREES, SQRT, SUBTRACT, TAN, TAN_DEGREES, WEIGHTED_AVERAGE

Constructor Summary

FloatSet(MathType type)
construct a FloatSet object with null CoordinateSystem and Units

FloatSet(MathType type, CoordinateSystem coord_sys, Unit[] units)
the set of values representable by N floats; type must be a RealType, a RealTupleType or a SetType; coordinate_system and units must be compatible with defaults for type, or may be null; a FloatSet may not be used as a Field domain

Method Summary

java.lang.Object	clone() Clones this instance.
java.lang.Object	cloneButType(MathType type) copy this Set, but give it a new MathType; this is safe, since constructor checks consistency of DomainCoordinateSystem and SetUnits with Type
boolean	equals(java.lang.Object set) test for equality
int	getLength() get the number of samples
float[][]	indexToValue(int[] index) convert an array of indices to an array of sample values; the return array is organized as float[domain_dimension][indices.length]
boolean	isMissing() a method to tell whether data object has a missing value
java.lang.String	longString(java.lang.String pre) generates a longer string than generated by toString, indented by pre (a string of blanks)
int[]	valueToIndex(float[][] value) convert an array of values to an array of indices of the nearest samples; the values array is organized as float[domain_dimension][number_of_values]
void	valueToInterp(float[][] value, int[][] indices, float[][] weights) convert an array of values to arrays of indices and weights for those indices, appropriate for interpolation; the values array is organized as float[domain_dimension][number_of_values]; indices and weights must be passed in as int[number_of_values][] and float[number_of_values][]; on return, quantity( values[.][i] ) can be estimated as the sum over j of weights[i][j] * quantity (sample at indices[i][j]); no estimate possible if indices[i] and weights[i] are null

Methods inherited from class visad.SimpleSet

getManifoldDimension

Methods inherited from class visad.Set

__getitem__, __len__, addEqualsCache, addNotEqualsCache, computeRanges, computeRanges, copyDoubles, copyFloats, cram_missing, doubleToFloat, doubleToIndex, equalUnitAndCS, floatToDouble, getCoordinateSystem, getDimension, getDoubles, getDoubles, getNeighbors, getNeighbors, getNeighbors, getSamples, getSamples, getSetErrors, getSetUnits, getWedge, indexToDouble, longString, main, make1DGeometry, make2DGeometry, make3DGeometry, makeIsoLines, makeIsoSurface, makePointGeometry, makeSpatial, merge1DSets, testEqualsCache, testNotEqualsCache, unitAndCSHashCode

Methods inherited from class visad.DataImpl

__add__, __add__, __div__, __div__, __mod__, __mod__, __mul__, __mul__, __neg__, __pow__, __pow__, __sub__, __sub__, abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, adjustSamplingError, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, local, log, log, max, max, min, min, multiply, multiply, negate, negate, notifyReferences, pow, pow, remainder, remainder, rint, rint, round, round, sin, sin, sinDegrees, sinDegrees, sqrt, sqrt, subtract, subtract, tan, tan, tanDegrees, tanDegrees, toString, unary, unary

Methods inherited from class visad.ThingImpl

addReference, removeReference

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface visad.SetIface

cram_missing, doubleToIndex, equalUnitAndCS, getCoordinateSystem, getDimension, getDoubles, getDoubles, getNeighbors, getNeighbors, getNeighbors, getSamples, getSamples, getSetErrors, getSetUnits, getWedge, indexToDouble, make1DGeometry, make2DGeometry, make3DGeometry, makeIsoLines, makeIsoSurface, makePointGeometry, makeSpatial, merge1DSets

Methods inherited from interface visad.Data

abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, adjustSamplingError, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, local, log, log, longString, max, max, min, min, multiply, multiply, negate, negate, pow, pow, remainder, remainder, rint, rint, round, round, sin, sin, sinDegrees, sinDegrees, sqrt, sqrt, subtract, subtract, tan, tan, tanDegrees, tanDegrees, unary, unary

Methods inherited from interface visad.Thing

addReference, removeReference

Constructor Detail

FloatSet

public FloatSet(MathType type)
         throws VisADException

construct a FloatSet object with null CoordinateSystem and Units

Throws:

VisADException

FloatSet

public FloatSet(MathType type,
                CoordinateSystem coord_sys,
                Unit[] units)
         throws VisADException

the set of values representable by N floats; type must be a RealType, a RealTupleType or a SetType; coordinate_system and units must be compatible with defaults for type, or may be null; a FloatSet may not be used as a Field domain

Throws:

VisADException

Method Detail

indexToValue

public float[][] indexToValue(int[] index)
                       throws VisADException

Description copied from class: Set

convert an array of indices to an array of sample values; the return array is organized as float[domain_dimension][indices.length]

Specified by:

indexToValue in interface SetIface

Specified by:

indexToValue in class Set

Parameters:

index - The array of 1-D indices.

Returns:

The values of the set corresponding to the input indices. Element [i][j] is the i-th coordinate of the sample at index index[j].

Throws:

VisADException - VisAD failure.

valueToIndex

public int[] valueToIndex(float[][] value)
                   throws VisADException

Description copied from class: Set

convert an array of values to an array of indices of the nearest samples; the values array is organized as float[domain_dimension][number_of_values]

Specified by:

valueToIndex in interface SetIface

Specified by:

valueToIndex in class Set

Parameters:

value - An array of points. value[i][j] is the i-th coordinate of the j-th point.

Returns:

Indices of the nearest samples in the set. If the j-th point lies within the set, then element [i] is the index of the closest sample; otherwise, element [i] is -1.

Throws:

VisADException - VisAD failure.

valueToInterp

public void valueToInterp(float[][] value,
                          int[][] indices,
                          float[][] weights)
                   throws VisADException

Description copied from class: SimpleSet

convert an array of values to arrays of indices and weights for those indices, appropriate for interpolation; the values array is organized as float[domain_dimension][number_of_values]; indices and weights must be passed in as int[number_of_values][] and float[number_of_values][]; on return, quantity( values[.][i] ) can be estimated as the sum over j of weights[i][j] * quantity (sample at indices[i][j]); no estimate possible if indices[i] and weights[i] are null

Specified by:

valueToInterp in interface SimpleSetIface

Specified by:

valueToInterp in class SimpleSet

Parameters:

value - An array of points. value[i][j] is the i-th coordinate of the j-th points.

Throws:

VisADException - VisAD failure.

getLength

public int getLength()
              throws VisADException

Description copied from class: Set

get the number of samples

Specified by:

getLength in interface SetIface

Overrides:

getLength in class Set

Returns:

The number of samples in the set.

Throws:

VisADException

equals

public boolean equals(java.lang.Object set)

Description copied from class: Set

test for equality

Specified by:

equals in interface SetIface

Specified by:

equals in class Set

isMissing

public boolean isMissing()

Description copied from interface: Data

a method to tell whether data object has a missing value

clone

public final java.lang.Object clone()

Clones this instance.

Overrides:

clone in class Set

Returns:

A clone of this instance.

cloneButType

public java.lang.Object cloneButType(MathType type)
                              throws VisADException

Description copied from class: Set

copy this Set, but give it a new MathType; this is safe, since constructor checks consistency of DomainCoordinateSystem and SetUnits with Type

Specified by:

cloneButType in interface SetIface

Specified by:

cloneButType in class Set

Parameters:

type - The MathType for the clone.

Returns:

A clone of this set with the new MathType.

Throws:

VisADException - VisAD failure.

longString

public java.lang.String longString(java.lang.String pre)
                            throws VisADException

Description copied from class: DataImpl

generates a longer string than generated by toString, indented by pre (a string of blanks)

Specified by:

longString in interface Data

Overrides:

longString in class Set

Throws:

VisADException