visad
Class Linear1DSet

java.lang.Object
  visad.ThingImpl
      visad.DataImpl
          visad.Set
              visad.SimpleSet
                  visad.SampledSet
                      visad.GriddedSet
                          visad.Gridded1DSet
                              visad.Linear1DSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Data, Gridded1DSetIface, GriddedSetIface, LinearSet, SampledSetIface, Set1DIface, SetIface, SimpleSetIface, Thing

Direct Known Subclasses:

Integer1DSet

public class Linear1DSet
extends Gridded1DSet
implements LinearSet

Linear1DSet represents a finite set of samples of R in an arithmetic progression.

The samples are ordered from First to Last.

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

Linear1DSet(double first, double last, int length)
a 1-D arithmetic progression with null errors and generic type

Linear1DSet(MathType type, double first, double last, int length)

Linear1DSet(MathType type, double first, double last, int length, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
an arithmetic progression of length values between first and last; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Method Summary

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
int[]	doubleToIndex(double[][] value)
boolean	equals(java.lang.Object set) test for equality
double[][]	getDoubles(boolean copy) Returns an enumeration of the samples of the set in index order.
double	getFirst()
double	getInvstep()
double	getLast()
Linear1DSet	getLinear1DComponent(int i) Get the indexed component (X is at 0 and is the only valid index)
float[][]	getSamples(boolean copy) Returns the samples of this instance or a copy of the samples.
double	getStep()
float[][]	gridToValue(float[][] grid) transform an array of non-integer grid coordinates to an array of values in R
int	hashCode() Returns the hash code for this instance.
double[][]	indexToDouble(int[] index) Returns an array of sample-point values corresponding to an array of sample-point indicies.
float[][]	indexToValue(int[] index) convert an array of 1-D indices to an array of values in R^DomainDimension
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)
float[][]	valueToGrid(float[][] value) transform an array of values in R to an array of non-integer grid coordinates

Methods inherited from class visad.Gridded1DSet

create, getHiX, getLengthX, getLowX, isAscending, main, valueToIndex

Methods inherited from class visad.GriddedSet

create, create, getLength, getLengths, getNeighbors, getNeighbors, getWedge, makeSpatial, valueToInterp

Methods inherited from class visad.SampledSet

clone, computeRanges, computeRanges, cram_missing, getHi, getLow, getNeighbors, getSamples, make1DGeometry, make3DGeometry, makePointGeometry, setGeometryArray, setGeometryArray

Methods inherited from class visad.SimpleSet

getManifoldDimension

Methods inherited from class visad.Set

__getitem__, __len__, addEqualsCache, addNotEqualsCache, copyDoubles, copyFloats, doubleToFloat, equalUnitAndCS, floatToDouble, getCoordinateSystem, getDimension, getDoubles, getLength, getSetErrors, getSetUnits, longString, make2DGeometry, makeIsoLines, makeIsoSurface, 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, notify, notifyAll, wait, wait, wait

Methods inherited from interface visad.GriddedSetIface

getLength, getLengths

Methods inherited from interface visad.SampledSetIface

getHi, getLow

Methods inherited from interface visad.SimpleSetIface

valueToInterp

Methods inherited from interface visad.SetIface

cram_missing, equalUnitAndCS, getCoordinateSystem, getDimension, getDoubles, getLength, getManifoldDimension, getNeighbors, getNeighbors, getNeighbors, getSamples, getSetErrors, getSetUnits, getWedge, 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

Linear1DSet

public Linear1DSet(double first,
                   double last,
                   int length)
            throws VisADException

a 1-D arithmetic progression with null errors and generic type

Throws:

VisADException

Linear1DSet

public Linear1DSet(MathType type,
                   double first,
                   double last,
                   int length)
            throws VisADException

Throws:

VisADException

Linear1DSet

public Linear1DSet(MathType type,
                   double first,
                   double last,
                   int length,
                   CoordinateSystem coord_sys,
                   Unit[] units,
                   ErrorEstimate[] errors)
            throws VisADException

an arithmetic progression of length values between first and last; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Throws:

VisADException

Method Detail

indexToValue

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

convert an array of 1-D indices to an array of values in R^DomainDimension

Specified by:

indexToValue in interface SetIface

Overrides:

indexToValue in class Gridded1DSet

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.

indexToDouble

public double[][] indexToDouble(int[] index)
                         throws VisADException

Description copied from class: Set

Returns an array of sample-point values corresponding to an array of sample-point indicies.

Specified by:

indexToDouble in interface SetIface

Overrides:

indexToDouble in class Set

Parameters:

index - The indicies of the sample points.

Returns:

A corresponding array of sample-point values. RETURN_VALUE[i][j] is the jth component of sample-point i.

Throws:

VisADException - if a VisAD failure occurs.

doubleToIndex

public int[] doubleToIndex(double[][] value)
                    throws VisADException

Specified by:

doubleToIndex in interface SetIface

Overrides:

doubleToIndex in class Set

Throws:

VisADException

gridToValue

public float[][] gridToValue(float[][] grid)
                      throws VisADException

transform an array of non-integer grid coordinates to an array of values in R

Specified by:

gridToValue in interface GriddedSetIface

Overrides:

gridToValue in class Gridded1DSet

Parameters:

grid - The coordinates of the interpolation grid points for which interpolated sample values are desired. grid[i][j] is the i-th grid coordinate of the j-th interpolation point.

Returns:

The interpolated samples of the set. Element [i][j] is the i-th coordinate of the j-th interpolation point.

Throws:

VisADException - VisAD failure.

valueToGrid

public float[][] valueToGrid(float[][] value)
                      throws VisADException

transform an array of values in R to an array of non-integer grid coordinates

Specified by:

valueToGrid in interface GriddedSetIface

Overrides:

valueToGrid in class Gridded1DSet

Parameters:

value - The array of points for which non-integer grid coordinates are desired. value[i][j] is the i-th coordinate of the j-th point.

Returns:

The array of grid coordinates corresponding to the points. Element [i][j] is the i-th non-integer grid coordinate of the j-th point.

Throws:

VisADException - VisAD failure.

getFirst

public double getFirst()

getLast

public double getLast()

getStep

public double getStep()

getInvstep

public double getInvstep()

isMissing

public boolean isMissing()

Description copied from interface: Data

a method to tell whether data object has a missing value

Specified by:

isMissing in interface Data

Overrides:

isMissing in class SampledSet

getDoubles

public double[][] getDoubles(boolean copy)
                      throws VisADException

Description copied from interface: SetIface

Returns an enumeration of the samples of the set in index order.

Specified by:

getDoubles in interface SetIface

Overrides:

getDoubles in class Set

Parameters:

copy - Whether or not to make a copy of the samples of the set.

Returns:

An enumeration of the samples of the set. Element [i][j] is the i-th coordinate of the j-th sample.

Throws:

VisADException - VisAD failure.

getSamples

public float[][] getSamples(boolean copy)
                     throws VisADException

Description copied from class: SampledSet

Returns the samples of this instance or a copy of the samples.

Note that, if the actual sample array is returned, then it is possible to modify the values of this instance -- breaking the immutability aspect of this class. Don't do this unless you enjoy debugging.

Specified by:

getSamples in interface SetIface

Overrides:

getSamples in class SampledSet

Parameters:

copy - Whether or not a copy of the sample array should be returned.

Returns:

The sample array is copy is false; otherwise, a copy of the sample array.

Throws:

VisADException - VisAD failure.

equals

public boolean equals(java.lang.Object set)

Description copied from class: Set

test for equality

Specified by:

equals in interface SetIface

Overrides:

equals in class GriddedSet

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:

hashCode in class GriddedSet

Returns:

The hash code for this instance.

getLinear1DComponent

public Linear1DSet getLinear1DComponent(int i)

Get the indexed component (X is at 0 and is the only valid index)

Specified by:

getLinear1DComponent in interface LinearSet

Parameters:

i - Index of component

Returns:

The requested component

Throws:

java.lang.ArrayIndexOutOfBoundsException - If an invalid index is specified.

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

Overrides:

cloneButType in class Gridded1DSet

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 GriddedSet

Throws:

VisADException