visad
Class Gridded1DSet

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

All Implemented Interfaces:

Serializable, Cloneable, Data, Gridded1DSetIface, GriddedSetIface, SampledSetIface, Set1DIface, SetIface, SimpleSetIface, Thing

Direct Known Subclasses:

Gridded1DDoubleSet, Linear1DSet

public class Gridded1DSet
extends GriddedSet
implements Gridded1DSetIface

Gridded1DSet represents a finite set of samples of R.

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

Gridded1DSet(MathType type, float[][] samples, int lengthX)
Constructs a 1-D sorted sequence with no regular interval.

Gridded1DSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
Constructs a 1-D sorted sequence with no regular interval.

Gridded1DSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)
Constructs a 1-D sorted sequence with no regular interval.

Method Summary

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
static Gridded1DSet	create(MathType type, float[] samples, CoordinateSystem coordSys, Unit unit, ErrorEstimate error) Returns an instance of this class.
float	getHiX() Returns the maximum value in the set.
int	getLengthX()
float	getLowX() Returns the minimum value in the set.
float[][]	gridToValue(float[][] grid) transform an array of non-integer grid coordinates to an array of values in R^DomainDimension
float[][]	indexToValue(int[] index) convert an array of 1-D indices to an array of values in R^DomainDimension
boolean	isAscending()
static void	main(String[] args)
float[][]	valueToGrid(float[][] value) transform an array of values in R^DomainDimension to an array of non-integer grid coordinates
int[]	valueToIndex(float[][] value) Convert an array of values in R^DomainDimension to an array of 1-D indices.

Methods inherited from class visad.GriddedSet

create, create, create, create, equals, getLength, getLengths, getNeighbors, getNeighbors, getWedge, hashCode, longString, makeSpatial, valueToInterp

Methods inherited from class visad.SampledSet

clone, computeRanges, computeRanges, cram_missing, finalize, getHi, getLow, getMySamples, getNeighbors, getSamples, getSamples, isMissing, make1DGeometry, make3DGeometry, makePointGeometry, setCacheSizeThreshold, setGeometryArray, setGeometryArray, setMySamples

Methods inherited from class visad.SimpleSet

getManifoldDimension

Methods inherited from class visad.Set

__getitem__, __len__, addEqualsCache, addNotEqualsCache, copyDoubles, copyFloats, doubleToFloat, doubleToIndex, equalUnitAndCS, floatToDouble, getCoordinateSystem, getDimension, getDoubles, getDoubles, getLength, getSetErrors, getSetUnits, indexToDouble, longString, make2DGeometry, makeIsoLines, makeIsoSurface, merge1DSets, testEqualsCache, testNotEqualsCache, unary, unitAndCSHashCode

Methods inherited from class visad.DataImpl

__add__, __add__, __div__, __div__, __mod__, __mod__, __mul__, __mul__, __neg__, __pow__, __pow__, __radd__, __rdiv__, __rmod__, __rmul__, __rpow__, __rsub__, __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

Methods inherited from class visad.ThingImpl

addReference, removeReference

Methods inherited from class java.lang.Object

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, doubleToIndex, equals, equalUnitAndCS, getCoordinateSystem, getDimension, getDoubles, getDoubles, getLength, getManifoldDimension, 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, isMissing, local, log, log, longString, 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

Gridded1DSet

public Gridded1DSet(MathType type,
                    float[][] samples,
                    int lengthX)
             throws VisADException

Constructs a 1-D sorted sequence with no regular interval. The coordinate system and units are the default from the set type. The error estimate is null.

Parameters:

type - The type of the set. Must be a RealType or a single-component RealTupleType or SetType.

samples - The values in the set. samples[0][i] is the value of the ith sample point. Must be sorted (either increasing or decreasing). May be null.

lengthX - The number of samples.

Throws:

VisADException

Gridded1DSet

public Gridded1DSet(MathType type,
                    float[][] samples,
                    int lengthX,
                    CoordinateSystem coord_sys,
                    Unit[] units,
                    ErrorEstimate[] errors)
             throws VisADException

Constructs a 1-D sorted sequence with no regular interval.

Parameters:

type - The type of the set. Must be a RealType or a single-component RealTupleType or SetType.

samples - The values in the set. samples[0][i] is the value of the ith sample point. Must be sorted (either increasing or decreasing). May be null.

lengthX - The number of samples.

coord_sys - The coordinate system for this, particular, set. Must be compatible with the default coordinate system. May be null.

units - The units for the tuple components. Only units[0] is meaningfull. Must be compatible with the default unit. May be null.

errors - The error estimates of the tuple components. Only errors[0] is meaningful. May be null.

Throws:

VisADException

Gridded1DSet

public Gridded1DSet(MathType type,
                    float[][] samples,
                    int lengthX,
                    CoordinateSystem coord_sys,
                    Unit[] units,
                    ErrorEstimate[] errors,
                    boolean copy)
             throws VisADException

Constructs a 1-D sorted sequence with no regular interval.

Parameters:

type - The type of the set. Must be a RealType or a single-component RealTupleType or SetType.

samples - The values in the set. samples[0][i] is the value of the ith sample point. Must be sorted (either increasing or decreasing). May be null.

lengthX - The number of samples.

coord_sys - The coordinate system for this, particular, set. Must be compatible with the default coordinate system. May be null.

units - The units for the tuple components. Only units[0] is meaningfull. Must be compatible with the default unit. May be null.

errors - The error estimates of the tuple components. Only errors[0] is meaningful. May be null.

copy - Whether or not to copy the values array.

Throws:

VisADException

Method Detail

create

public static Gridded1DSet create(MathType type,
                                  float[] samples,
                                  CoordinateSystem coordSys,
                                  Unit unit,
                                  ErrorEstimate error)
                           throws VisADException

Returns an instance of this class. This method uses a weak cache of previously-created instances to reduce memory usage.

Parameters:

type - The type of the set. Must be a RealType or a single-component RealTupleType or SetType.

samples - The values in the set. samples[i] is the value of the ith sample point. Must be sorted (either increasing or decreasing). May be null. The array is not copied, so either don't modify it or clone it first.

coordSys - The coordinate system for this, particular, set. Must be compatible with the default coordinate system. May be null.

unit - The unit for the samples. Must be compatible with the default unit. May be null.

error - The error estimate of the samples. May be null.

Throws:

VisADException

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 GriddedSet

Parameters:

index - array of integer indices

Returns:

float[domain_dimension][indices.length] array of Set values

Throws:

VisADException - a VisAD error occurred

valueToIndex

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

Convert an array of values in R^DomainDimension to an array of 1-D indices. This Gridded1DSet must have at least two points in the set.

Specified by:

valueToIndex in interface SetIface

Overrides:

valueToIndex in class GriddedSet

Parameters:

value - An array of coordinates. value[i][j] contains the ith component of the jth point.

Returns:

Indices of nearest points. RETURN_VALUE[i] will contain the index of the point in the set closest to value[][i] or -1 if value[][i] lies outside the set.

Throws:

VisADException - a VisAD error occurred

gridToValue

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

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

Specified by:

gridToValue in interface GriddedSetIface

Overrides:

gridToValue in class GriddedSet

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^DomainDimension to an array of non-integer grid coordinates

Specified by:

valueToGrid in interface GriddedSetIface

Overrides:

valueToGrid in class GriddedSet

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.

getLengthX

public int getLengthX()

getLowX

public float getLowX()

Description copied from interface: Set1DIface

Returns the minimum value in the set.

Specified by:

getLowX in interface Set1DIface

Returns:

The lowest value in the set.

getHiX

public float getHiX()

Description copied from interface: Set1DIface

Returns the maximum value in the set.

Specified by:

getHiX in interface Set1DIface

Returns:

The highest value in the set.

isAscending

public boolean isAscending()

cloneButType

public 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 GriddedSet

Parameters:

type - The MathType for the clone.

Returns:

A clone of this set with the new MathType.

Throws:

VisADException - VisAD failure.

main

public static void main(String[] args)
                 throws VisADException

Throws:

VisADException