Gridded1DDoubleSet (VisAD 2.0.0-scijava-2-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Cloneable, Data, Gridded1DSetIface, GriddedDoubleSet, GriddedSetIface, SampledSetIface, Set1DIface, SetIface, SimpleSetIface, Thing
```
public class Gridded1DDoubleSet
extends Gridded1DSet
implements GriddedDoubleSet
```
Gridded1DDoubleSet is a Gridded1DSet 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

Constructors
Constructor and Description
`Gridded1DDoubleSet(MathType type, double[][] samples, int lengthX)` a 1-D sequence with no regular interval with null errors, CoordinateSystem and Units are defaults from type
`Gridded1DDoubleSet(MathType type, double[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)`
`Gridded1DDoubleSet(MathType type, double[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)` a 1-D sorted sequence with no regular interval.
`Gridded1DDoubleSet(MathType type, float[][] samples, int lengthX)` a 1-D sequence with no regular interval with null errors, CoordinateSystem and Units are defaults from type
`Gridded1DDoubleSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors)`
`Gridded1DDoubleSet(MathType type, float[][] samples, int lengthX, CoordinateSystem coord_sys, Unit[] units, ErrorEstimate[] errors, boolean copy)` a 1-D sorted sequence with no regular interval.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)`
`static Gridded1DDoubleSet`	`create(MathType type, double[] samples, CoordinateSystem coordSys, Unit unit, ErrorEstimate error)` Returns an instance of this class.
`double[][]`	`doubleToGrid(double[][] value)` transform an array of values in R^DomainDimension to an array of non-integer grid coordinates
`int[]`	`doubleToIndex(double[][] value)`
`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`	`getDoubleHiX()`
`double`	`getDoubleLowX()`
`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`	`getHiX()` Returns the maximum value in the set.
`float`	`getLowX()` Returns the minimum value in the set.
`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
`int`	`hashCode()` Returns the hash code of this instance.
`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.Gridded1DSet
create, getLengthX, isAscending, main

Methods inherited from class visad.GriddedSet
create, create, create, create, getLength, getLengths, getNeighbors, getNeighbors, getWedge, longString, makeSpatial, valueToGrid, valueToInterp

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
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          float[][] samples,
                          int lengthX)
                   throws VisADException
```
    a 1-D sequence with no regular interval with null errors, CoordinateSystem and Units are defaults from type
    
    Throws:
    
    VisADException
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          float[][] samples,
                          int lengthX,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors)
                   throws VisADException
```
    Throws:
    
    VisADException
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          float[][] samples,
                          int lengthX,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors,
                          boolean copy)
                   throws VisADException
```
    a 1-D sorted sequence with no regular interval. samples array is organized float[1][number_of_samples] where lengthX = number_of_samples. samples must be sorted (either increasing or decreasing). coordinate_system and units must be compatible with defaults for type, or may be null. errors may be null
    
    Throws:
    
    VisADException
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX)
                   throws VisADException
```
    a 1-D sequence with no regular interval with null errors, CoordinateSystem and Units are defaults from type
    
    Throws:
    
    VisADException
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors)
                   throws VisADException
```
    Throws:
    
    VisADException
  - Gridded1DDoubleSet
```
public Gridded1DDoubleSet(MathType type,
                          double[][] samples,
                          int lengthX,
                          CoordinateSystem coord_sys,
                          Unit[] units,
                          ErrorEstimate[] errors,
                          boolean copy)
                   throws VisADException
```
    a 1-D sorted sequence with no regular interval. samples array is organized double[1][number_of_samples] where lengthX = number_of_samples. samples must be sorted (either increasing or decreasing). coordinate_system and units must be compatible with defaults for type, or may be null. errors may be null
    
    Throws:
    
    VisADException
- Method Detail
  - create
```
public static Gridded1DDoubleSet create(MathType type,
                                        double[] 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
  - 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 Gridded1DSet 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 Gridded1DDoubleSet must have at least two points in the set. Specified by: valueToIndex in interface SetIface Overrides: valueToIndex in class Gridded1DSet 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 Description copied from class: Gridded1DSet 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 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^DomainDimension 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. 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. getLowX public float getLowX() Description copied from interface: Set1DIface Returns the minimum value in the set. Specified by: getLowX in interface Set1DIface Overrides: getLowX in class Gridded1DSet 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 Overrides: getHiX in class Gridded1DSet Returns: The highest value in the set. 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 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 getDoubleLowX public double getDoubleLowX() getDoubleHiX public double getDoubleHiX() 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 hashCode public int hashCode() Returns the hash code of this instance. Object.hashCode() should be overridden whenever Object.equals(Object) is. Overrides: hashCode in class GriddedSet Returns: The hash code of this instance (includes the values). 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 Gridded1DSet Parameters: type - The MathType for the clone. Returns: A clone of this set with the new MathType. Throws: VisADException - VisAD failure.

Class Gridded1DDoubleSet

Nested Class Summary

Nested classes/interfaces inherited from class visad.DataImpl

Field Summary

Fields inherited from interface visad.Data

Constructor Summary

Method Summary

Methods inherited from class visad.Gridded1DSet

Methods inherited from class visad.GriddedSet

Methods inherited from class visad.SampledSet

Methods inherited from class visad.SimpleSet

Methods inherited from class visad.Set

Methods inherited from class visad.DataImpl

Methods inherited from class visad.ThingImpl

Methods inherited from class java.lang.Object

Methods inherited from interface visad.GriddedSetIface

Methods inherited from interface visad.SampledSetIface

Methods inherited from interface visad.SetIface

Methods inherited from interface visad.Data

Methods inherited from interface visad.Thing

Constructor Detail

Gridded1DDoubleSet

Gridded1DDoubleSet

Gridded1DDoubleSet

Gridded1DDoubleSet

Gridded1DDoubleSet

Gridded1DDoubleSet

Method Detail

create

getSamples

getSamples

indexToValue

valueToIndex

gridToValue

valueToGrid

valueToInterp

getLowX

getHiX

getDoubles

getDoubles

indexToDouble

doubleToIndex

gridToDouble

doubleToGrid

doubleToInterp

getDoubleLowX

getDoubleHiX

cram_missing

isMissing

equals

hashCode

clone

cloneButType