visad
Class Gridded2DDoubleSet

java.lang.Object
  visad.ThingImpl
      visad.DataImpl
          visad.Set
              visad.SimpleSet
                  visad.SampledSet
                      visad.GriddedSet
                          visad.Gridded2DSet
                              visad.Gridded2DDoubleSet

All Implemented Interfaces:

Serializable, Cloneable, Data, GriddedDoubleSet, GriddedSetIface, SampledSetIface, SetIface, SimpleSetIface, Thing

public class Gridded2DDoubleSet
extends Gridded2DSet
implements GriddedDoubleSet

Gridded2DDoubleSet is a Gridded2DSet with double-precision samples.

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

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX)
a 2-D set with manifold dimension = 1, with null errors, CoordinateSystem and Units are defaults from type

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
a 2-D set with manifold dimension = 1; samples array is organized double[2][number_of_samples] where lengthX = number_of_samples; no geometric constraint on samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, int lengthY)
a 2-D set whose topology is a lengthX x lengthY grid, with null errors, CoordinateSystem and Units are defaults from type

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, int lengthY, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
a 2-D set whose topology is a lengthX x lengthY grid; samples array is organized double[2][number_of_samples] where lengthX * lengthY = number_of_samples; samples must form a non-degenerate 2-D grid (no bow-tie-shaped grid boxes); the X component increases fastest in the second index of samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, int lengthY, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)

Gridded2DDoubleSet(MathType type, double[][] samples, int lengthX, int lengthY, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy, boolean test)

Gridded2DDoubleSet(MathType type, float[][] samples, int lengthX)
a 2-D set with manifold dimension = 1, with null errors, CoordinateSystem and Units are defaults from type

Gridded2DDoubleSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
a 2-D set with manifold dimension = 1; samples array is organized float[2][number_of_samples] where lengthX = number_of_samples; no geometric constraint on samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Gridded2DDoubleSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)

Gridded2DDoubleSet(MathType type, float[][] samples, int lengthX, int lengthY)
a 2-D set whose topology is a lengthX x lengthY grid, with null errors, CoordinateSystem and Units are defaults from type

Gridded2DDoubleSet(MathType type, float[][] samples, int lengthX, int lengthY, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)
a 2-D set whose topology is a lengthX x lengthY grid; samples array is organized float[2][number_of_samples] where lengthX * lengthY = number_of_samples; samples must form a non-degenerate 2-D grid (no bow-tie-shaped grid boxes); the X component increases fastest in the second index of samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Method Summary

Object	clone() Clones this instance.
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
void	cram_missing(boolean[] range_select)
double[][]	doubleToGrid(double[][] value) transform an array of values in R^DomainDimension to an array of non-integer grid coordinates
int[]	doubleToIndex(double[][] value) convert an array of values in R^DomainDimension to an array of 1-D indices
void	doubleToInterp(double[][] value, int[][] indices, double[][] weights) for each of an array of values in R^DomainDimension, compute an array of 1-D indices and an array of weights, to be used for interpolation; indices[i] and weights[i] are null if i-th value is outside grid (i.e., if no interpolation is possible)
boolean	equals(Object set) test for equality
double[][]	getDoubles() Returns an enumeration of the samples of the set in index order.
double[][]	getDoubles(boolean copy) Returns an enumeration of the samples of the set in index order.
float[][]	getSamples() Returns a copy of the samples of this instance.
float[][]	getSamples(boolean copy) Returns the samples of this instance or a copy of the samples.
double[][]	gridToDouble(double[][] grid) transform an array of non-integer grid coordinates to an array of values in R^DomainDimension
float[][]	gridToValue(float[][] grid) transform an array of non-integer grid coordinates to an array of values in R^DomainDimension
double[][]	indexToDouble(int[] index) convert an array of 1-D indices 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	isMissing()
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
void	valueToInterp(float[][] value, int[][] indices, float[][] weights) for each of an array of values in R^DomainDimension, compute an array of 1-D indices and an array of weights, to be used for interpolation; indices[i] and weights[i] are null if i-th value is outside grid (i.e., if no interpolation is possible)

Methods inherited from class visad.Gridded2DSet

main

Methods inherited from class visad.GriddedSet

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

Methods inherited from class visad.SampledSet

computeRanges, computeRanges, finalize, getHi, getLow, getMySamples, getNeighbors, 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, equalUnitAndCS, floatToDouble, getCoordinateSystem, getDimension, getLength, getSetErrors, getSetUnits, 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.SetIface

equalUnitAndCS, getCoordinateSystem, getDimension, getLength, getManifoldDimension, getNeighbors, getNeighbors, getNeighbors, 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, 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

Gridded2DDoubleSet

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

a 2-D set whose topology is a lengthX x lengthY grid, with null errors, CoordinateSystem and Units are defaults from type

Throws:

VisADException

Gridded2DDoubleSet

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

a 2-D set whose topology is a lengthX x lengthY grid; samples array is organized float[2][number_of_samples] where lengthX * lengthY = number_of_samples; samples must form a non-degenerate 2-D grid (no bow-tie-shaped grid boxes); the X component increases fastest in the second index of samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Throws:

VisADException

Gridded2DDoubleSet

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

a 2-D set with manifold dimension = 1, with null errors, CoordinateSystem and Units are defaults from type

Throws:

VisADException

Gridded2DDoubleSet

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

a 2-D set with manifold dimension = 1; samples array is organized float[2][number_of_samples] where lengthX = number_of_samples; no geometric constraint on samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Throws:

VisADException

Gridded2DDoubleSet

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

Throws:

VisADException

Gridded2DDoubleSet

public Gridded2DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX,
                          int lengthY)
                   throws VisADException

a 2-D set whose topology is a lengthX x lengthY grid, with null errors, CoordinateSystem and Units are defaults from type

Throws:

VisADException

Gridded2DDoubleSet

public Gridded2DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX,
                          int lengthY,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors)
                   throws VisADException

a 2-D set whose topology is a lengthX x lengthY grid; samples array is organized double[2][number_of_samples] where lengthX * lengthY = number_of_samples; samples must form a non-degenerate 2-D grid (no bow-tie-shaped grid boxes); the X component increases fastest in the second index of samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Throws:

VisADException

Gridded2DDoubleSet

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

Throws:

VisADException

Gridded2DDoubleSet

public Gridded2DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX,
                          int lengthY,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors,
                          boolean copy,
                          boolean test)
                   throws VisADException

Throws:

VisADException

Gridded2DDoubleSet

public Gridded2DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX)
                   throws VisADException

a 2-D set with manifold dimension = 1, with null errors, CoordinateSystem and Units are defaults from type

Throws:

VisADException

Gridded2DDoubleSet

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

a 2-D set with manifold dimension = 1; samples array is organized double[2][number_of_samples] where lengthX = number_of_samples; no geometric constraint on samples; coordinate_system and units must be compatible with defaults for type, or may be null; errors may be null

Throws:

VisADException

Gridded2DDoubleSet

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

Throws:

VisADException

Method Detail

getSamples

public float[][] getSamples()
                     throws VisADException

Description copied from class: SampledSet

Returns a copy of the samples of this instance. Element [i][j] of the returned array is the j-th value of the i-th component.

This method is equivalent to getSamples(true).

Specified by:

getSamples in interface SetIface

Overrides:

getSamples in class SampledSet

Returns:

A copy of the sample array.

Throws:

VisADException - VisAD failure.

See Also:

SampledSet.getSamples(boolean)

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.

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 Gridded2DSet

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

Specified by:

valueToIndex in interface SetIface

Overrides:

valueToIndex in class Gridded2DSet

Parameters:

value - float[domain_dimension][number_of_values] array of Set values

Returns:

array of integer indices

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 Gridded2DSet

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 Gridded2DSet

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.

valueToInterp

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

for each of an array of values in R^DomainDimension, compute an array of 1-D indices and an array of weights, to be used for interpolation; indices[i] and weights[i] are null if i-th value is outside grid (i.e., if no interpolation is possible)

Specified by:

valueToInterp in interface SimpleSetIface

Overrides:

valueToInterp in class GriddedSet

Parameters:

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

indices - Indices of the neighboring samples in the set. If the j-th points lies within the set, then returned element [i][j] is the index of the i-th neighboring sample in the set; otherwise, returned array [j] is null.

weights - Weights for interpolating the neighboring samples in the set. If the j-th points lies within the set, then returned element [i][j] is the weight of the i-th neighboring sample in the set; otherwise, returned array [j] is null.

Throws:

VisADException - VisAD failure.

getDoubles

public double[][] getDoubles()
                      throws VisADException

Description copied from interface: SetIface

Returns an enumeration of the samples of the set in index order. This is the same as getDoubles(true).

Specified by:

getDoubles in interface SetIface

Overrides:

getDoubles in class 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.

See Also:

SetIface.getDoubles(boolean copy)

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 GriddedDoubleSet

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.

indexToDouble

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

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

Specified by:

indexToDouble in interface GriddedDoubleSet

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

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

Specified by:

doubleToIndex in interface GriddedDoubleSet

Specified by:

doubleToIndex in interface SetIface

Overrides:

doubleToIndex in class Set

Throws:

VisADException

gridToDouble

public double[][] gridToDouble(double[][] grid)
                        throws VisADException

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

Specified by:

gridToDouble in interface GriddedDoubleSet

Throws:

VisADException

doubleToGrid

public double[][] doubleToGrid(double[][] value)
                        throws VisADException

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

Specified by:

doubleToGrid in interface GriddedDoubleSet

Throws:

VisADException

doubleToInterp

public void doubleToInterp(double[][] value,
                           int[][] indices,
                           double[][] weights)
                    throws VisADException

for each of an array of values in R^DomainDimension, compute an array of 1-D indices and an array of weights, to be used for interpolation; indices[i] and weights[i] are null if i-th value is outside grid (i.e., if no interpolation is possible)

Specified by:

doubleToInterp in interface GriddedDoubleSet

Throws:

VisADException

cram_missing

public void cram_missing(boolean[] range_select)

Specified by:

cram_missing in interface SetIface

Overrides:

cram_missing in class SampledSet

isMissing

public boolean isMissing()

Specified by:

isMissing in interface Data

Overrides:

isMissing in class SampledSet

Returns:

true or false

equals

public boolean equals(Object set)

Description copied from class: Set

test for equality

Specified by:

equals in interface SetIface

Overrides:

equals in class GriddedSet

clone

public Object clone()

Clones this instance.

Overrides:

clone in class SampledSet

Returns:

A clone of this instance.

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 Gridded2DSet

Parameters:

type - The MathType for the clone.

Returns:

A clone of this set with the new MathType.

Throws:

VisADException - VisAD failure.