visad
Class GridCoordinateSystem

java.lang.Object
  extended by visad.CoordinateSystem
      extended by visad.GridCoordinateSystem
All Implemented Interfaces:
java.io.Serializable

public class GridCoordinateSystem
extends CoordinateSystem

GridCoordinateSystem is the VisAD CoordinateSystem class for grids defined by GriddedSets.

It should be used as the CoordinateSystem of an IntegerSet describing the set of grid values (so the dimensions of the IntegerSet should match the dimensions of the GriddedSet argument to the GridCoordinateSystem constructor) where the reference RealTupleType describes the value space of the GriddedSet.

See Also:
Serialized Form

Constructor Summary
GridCoordinateSystem(GriddedSet s)
          construct a CoordinateSystem for grid coordinates (e.g., (row, column, level) in 3-D) relative to the value space of set; for example, if satellite pixel locations are defined by explicit latitudes and longitude, these could be used to construct a Gridded2DSet which could then be used to construct a GridCoordinateSystem for (ImageLine, ImageElement) coordinates relative to reference coordinates (Latitude, Longitude)
 
Method Summary
 boolean equals(java.lang.Object cs)
          check for equality of CoordinateSystem objects; must test for cs == null
 double[][] fromReference(double[][] tuples)
          convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array
 float[][] fromReference(float[][] tuples)
          convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array for efficiency, subclasses should override this implementation
 GriddedSet getGriddedSet()
          Returns the GriddedSet associated with this instance.
 double[][] toReference(double[][] tuples)
          convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array
 float[][] toReference(float[][] tuples)
          convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array; for efficiency, subclasses should override this implementation
 
Methods inherited from class visad.CoordinateSystem
canConvert, checkTable, fromReference, getCoordinateSystemUnits, getDimension, getReference, getReferenceUnits, toReference, transformCoordinates, transformCoordinates, transformCoordinatesFreeUnits, transformCoordinatesFreeUnits
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridCoordinateSystem

public GridCoordinateSystem(GriddedSet s)
                     throws VisADException
construct a CoordinateSystem for grid coordinates (e.g., (row, column, level) in 3-D) relative to the value space of set; for example, if satellite pixel locations are defined by explicit latitudes and longitude, these could be used to construct a Gridded2DSet which could then be used to construct a GridCoordinateSystem for (ImageLine, ImageElement) coordinates relative to reference coordinates (Latitude, Longitude)

Throws:
VisADException
Method Detail

getGriddedSet

public GriddedSet getGriddedSet()
Returns the GriddedSet associated with this instance.

Returns:
The GriddedSet associated with this instance.

toReference

public double[][] toReference(double[][] tuples)
                       throws VisADException
Description copied from class: CoordinateSystem
convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array

Specified by:
toReference in class CoordinateSystem
Throws:
VisADException

fromReference

public double[][] fromReference(double[][] tuples)
                         throws VisADException
Description copied from class: CoordinateSystem
convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array

Specified by:
fromReference in class CoordinateSystem
Throws:
VisADException

toReference

public float[][] toReference(float[][] tuples)
                      throws VisADException
Description copied from class: CoordinateSystem
convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array; for efficiency, subclasses should override this implementation

Overrides:
toReference in class CoordinateSystem
Throws:
VisADException

fromReference

public float[][] fromReference(float[][] tuples)
                        throws VisADException
Description copied from class: CoordinateSystem
convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array for efficiency, subclasses should override this implementation

Overrides:
fromReference in class CoordinateSystem
Throws:
VisADException

equals

public boolean equals(java.lang.Object cs)
Description copied from class: CoordinateSystem
check for equality of CoordinateSystem objects; must test for cs == null

Specified by:
equals in class CoordinateSystem