GridDataInstance (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.data.DataInstance
- - ucar.unidata.data.grid.GridDataInstance

```
public class GridDataInstance
extends DataInstance
```
A wrapper around grid data.

Version:

$Revision: 1.72 $ $Date: 2006/12/05 18:52:36 $

Author:

Jeff McWhirter

Field Summary
- Fields inherited from class ucar.unidata.data.DataInstance
  dataChoice, dataSelection, haveBeenInitialized, inError, myRequestProperties

Constructor Summary

Constructors
Constructor and Description
`GridDataInstance(DataChoice dataChoice, DataSelection dataSelection, java.util.Hashtable requestProperties)` Create a GridDataInstance.
`GridDataInstance(DataChoice dataChoice, DataSelection dataSelection, java.util.Hashtable requestProperties, visad.Data theData)` Create a GridDataInstance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`float[][]`	`getCoords3D()` Get the array of 3D coordinate values from the spatial set, this returns the actual array, so don't change the values!
`visad.DateTime[]`	`getDateTimes()` Get the array of times for this data
`visad.Gridded3DSet`	`getDomainSet3D()` Get the 3D domain
`visad.Gridded1DSet`	`getEnsembleSet()` Get the ensemble set
`visad.FieldImpl`	`getFieldImpl()` Deprecated. Use getGrid() instead
`visad.FlatField`	`getFlatField()` Get a representative grid from one timestep.
`visad.FieldImpl`	`getGrid()` Access to the FieldImpl made.
`visad.FieldImpl`	`getGrid(boolean copy)` Access to the FieldImpl made.
`visad.Real[]`	`getLevels()` Get the array of levels associated with this grid
`visad.georef.MapProjection`	`getNavigation()` Get the geolocation information for this grid
`int`	`getNumEnsembles()` Get number of ensembles
`int`	`getNumRealTypes()` Get the number of RealType (parameters) in this grid
`Range`	`getRange(int idx)` Return the idx'th range value
`Range[]`	`getRanges()` Get all the data ranges for this grid
`visad.MathType`	`getRangeType()` The MathType of the parameter(s)
`visad.Unit`	`getRawUnit(int idx)` Get the default unit for the parameter at idx
`visad.RealType`	`getRealType(int idx)` The real type of the field
`java.lang.String`	`getRealTypeName(int idx)` Get the name of the RealType of the parameter at idx
`ThreeDSize`	`getSize()` Get the sizes of the 3D domain
`int`	`getSizeX()` Get the number of X components in the domain
`int`	`getSizeY()` Get the number of Y components in the domain
`int`	`getSizeZ()` Get the number of Z components in the domain
`visad.SampledSet`	`getSpatialDomain()` Get the spatial domain associated with this grid.
`visad.CoordinateSystem`	`getThreeDCoordTrans()` Get the coordinate system for the 3D domain.
`visad.RealType`	`getZType()` Get the RealType of the data's Z coordinate
`visad.Unit`	`getZUnit()` Get the unit of the data's Z coordinate
`static visad.Unit`	`getZUnit(visad.FieldImpl field)` Get the vertical unit for a given grid
`java.lang.String`	`getZUnitName()` Get the name of the data's Z coordinate Unit
`protected void`	`init()` Initialize this object.
`boolean`	`is3D()` Check if this is a 3D grid or not
`boolean`	`isEnsemble()` Is the grid an ensemble?
`boolean`	`isTimeSequence()` Get whether this is a time sequence or not
`void`	`reInitialize()` Reinitialize this GridDataInstance
`visad.FieldImpl`	`slice(visad.SampledSet slice)` Slice (resample) the grid along the slice Interface to GridUtil.slice().
`visad.FieldImpl`	`sliceAlongLatLonLine(visad.georef.LatLonPoint start, visad.georef.LatLonPoint end)` Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
`visad.FieldImpl`	`sliceAlongLatLonLine(visad.georef.LatLonPoint start, visad.georef.LatLonPoint end, int samplingMode)` Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
`visad.FieldImpl`	`sliceAlongLatLonLine(java.util.List<visad.georef.LatLonPoint> points, int samplingMode)` Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
`visad.FieldImpl`	`sliceAtLevel(visad.Real level)` Slice the grid at a particular level.
`java.lang.String`	`toString()` String representation of this GridDataInstance

Methods inherited from class ucar.unidata.data.DataInstance
checkInit, dataOk, getData, getData, getData, getDataChoice, getDataSelection, getNextId, getParamName, needsInitialization, setData, setDataSelection, setTheData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GridDataInstance
```
public GridDataInstance(DataChoice dataChoice,
                        DataSelection dataSelection,
                        java.util.Hashtable requestProperties)
                 throws visad.VisADException,
                        java.rmi.RemoteException
```
    Create a GridDataInstance.
    
    Parameters:
    
    dataChoice - choice describing the data
    
    dataSelection - sub selection properties
    
    requestProperties - special control request properties
    
    Throws:
    
    java.rmi.RemoteException - Java RMI error
    
    visad.VisADException - VisAD Error
  - GridDataInstance
```
public GridDataInstance(DataChoice dataChoice,
                        DataSelection dataSelection,
                        java.util.Hashtable requestProperties,
                        visad.Data theData)
                 throws visad.VisADException,
                        java.rmi.RemoteException
```
    Create a GridDataInstance.
    
    Parameters:
    
    dataChoice - choice describing the data
    
    dataSelection - sub selection properties
    
    requestProperties - special control request properties
    
    theData - Any initial data. Usually is null.
    
    Throws:
    
    java.rmi.RemoteException - Java RMI error
    
    visad.VisADException - VisAD Error
- Method Detail
  - reInitialize
```
public void reInitialize()
                  throws visad.VisADException,
                         java.rmi.RemoteException
```
    Reinitialize this GridDataInstance
    
    Overrides:
    
    reInitialize in class DataInstance
    
    Throws:
    
    java.rmi.RemoteException - Java RMI error
    
    visad.VisADException - VisAD Error
  - init
```
protected void init()
             throws visad.VisADException,
                    java.rmi.RemoteException
```
    Initialize this object. Get the data and populate all the parameters
    
    Overrides:
    
    init in class DataInstance
    
    Throws:
    
    java.rmi.RemoteException - Java RMI error
    
    visad.VisADException - VisAD Error
  - getNavigation
```
public visad.georef.MapProjection getNavigation()
```
    Get the geolocation information for this grid
    
    Returns:
    
    geolocation as a MapProjection.
  - isTimeSequence
```
public boolean isTimeSequence()
```
    Get whether this is a time sequence or not
    
    Returns:
    
    true if a time sequence
  - is3D
```
public boolean is3D()
```
    Check if this is a 3D grid or not
    
    Returns:
    
    true if a 3D grid
  - getSpatialDomain
```
public visad.SampledSet getSpatialDomain()
```
    Get the spatial domain associated with this grid. It is assumed that the spatial domain is the same for each timestep.
    
    Returns:
    
    spatial domain
  - getZUnit
```
public static visad.Unit getZUnit(visad.FieldImpl field)
                           throws visad.VisADException,
                                  java.rmi.RemoteException
```
    Get the vertical unit for a given grid
    
    Parameters:
    
    field - 3D grid
    
    Returns:
    
    Unit of vertical coordinate
    
    Throws:
    
    java.rmi.RemoteException - Java RMI error
    
    visad.VisADException - VisAD Error
  - getRange
```
public Range getRange(int idx)
```
    Return the idx'th range value
    
    Parameters:
    
    idx - range index
    
    Returns:
    
    the Range of values for that index
  - getRanges
```
public Range[] getRanges()
```
    Get all the data ranges for this grid
    
    Returns:
    
    array of Ranges
  - getRealType
```
public visad.RealType getRealType(int idx)
```
    The real type of the field
    
    Parameters:
    
    idx - index of parameter
    
    Returns:
    
    RealType for parameter
  - getNumRealTypes
```
public int getNumRealTypes()
```
    Get the number of RealType (parameters) in this grid
    
    Returns:
    
    number of parameters
  - getRangeType
```
public visad.MathType getRangeType()
```
    The MathType of the parameter(s)
    
    Returns:
    
    the Tuple of parameters
  - getRealTypeName
```
public java.lang.String getRealTypeName(int idx)
```
    Get the name of the RealType of the parameter at idx
    
    Parameters:
    
    idx - index of parameter
    
    Returns:
    
    name of the RealType.
  - getFieldImpl
```
public visad.FieldImpl getFieldImpl()
```
    Deprecated. Use getGrid() instead
    
    Access to the FieldImpl made. Contains a sequence of times: (time -> (domain -> range)). Does not make a copy.
    
    Returns:
    
    the data in a FieldImpl
  - getGrid
```
public visad.FieldImpl getGrid()
```
    Access to the FieldImpl made. Contains a sequence of times: (time -> (domain -> range)). Does not copy data
    
    Returns:
    
    the data in a FieldImpl
  - getGrid
```
public visad.FieldImpl getGrid(boolean copy)
```
    Access to the FieldImpl made. Contains a sequence of times: (time -> (domain -> range))
    
    Parameters:
    
    copy - make a copy if true
    
    Returns:
    
    the data in a FieldImpl
  - getRawUnit
```
public visad.Unit getRawUnit(int idx)
```
    Get the default unit for the parameter at idx
    
    Parameters:
    
    idx - index of parameter
    
    Returns:
    
    default unit
  - getDomainSet3D
```
public visad.Gridded3DSet getDomainSet3D()
```
    Get the 3D domain
    
    Returns:
    
    3D domain or null if not a 3D grid
  - getCoords3D
```
public float[][] getCoords3D()
```
    Get the array of 3D coordinate values from the spatial set, this returns the actual array, so don't change the values!
    
    Returns:
    
    array of coordinates or null if not a 3D grid. This returns the actual array, so don't change the values!
  - getThreeDCoordTrans
```
public visad.CoordinateSystem getThreeDCoordTrans()
```
    Get the coordinate system for the 3D domain. The reference of the coordinate transform should be lat/lon/alt
    
    Returns:
    
    coordinate system with reference of lat/lon/alt or null if 2D data
  - getSize
```
public ThreeDSize getSize()
```
    Get the sizes of the 3D domain
    
    Returns:
    
    the sizes
  - getSizeX
```
public int getSizeX()
```
    Get the number of X components in the domain
    
    Returns:
    
    number of X components
  - getSizeY
```
public int getSizeY()
```
    Get the number of Y components in the domain
    
    Returns:
    
    number of Y components
  - getSizeZ
```
public int getSizeZ()
```
    Get the number of Z components in the domain
    
    Returns:
    
    number of Z components
  - getFlatField
```
public visad.FlatField getFlatField()
```
    Get a representative grid from one timestep. May be entire grid if not a sequence.
    
    Returns:
    
    one timestep grid (with no time dimension)
  - getZUnit
```
public visad.Unit getZUnit()
```
    Get the unit of the data's Z coordinate
    
    Returns:
    
    Unit zUnit the data's z coordinate unit.
  - getZType
```
public visad.RealType getZType()
```
    Get the RealType of the data's Z coordinate
    
    Returns:
    
    RealType the RealType of the Z (vertical) coordinate
  - getZUnitName
```
public java.lang.String getZUnitName()
```
    Get the name of the data's Z coordinate Unit
    
    Returns:
    
    String zUnit from z coordinate RealType unit.
  - toString
```
public java.lang.String toString()
```
    String representation of this GridDataInstance
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    output string
  - getLevels
```
public visad.Real[] getLevels()
```
    Get the array of levels associated with this grid
    
    Returns:
    
    array of levels
  - getDateTimes
```
public visad.DateTime[] getDateTimes()
```
    Get the array of times for this data
    
    Returns:
    
    array of times
  - sliceAtLevel
```
public visad.FieldImpl sliceAtLevel(visad.Real level)
                             throws visad.VisADException
```
    Slice the grid at a particular level. Interface to GridUtil.sliceAtLevel().
    
    Parameters:
    
    level - level to slice at
    
    Returns:
    
    2D grid of data at the level
    
    Throws:
    
    visad.VisADException - problems doing slice
    
    See Also:
    
    GridUtil.sliceAtLevel(FieldImpl, Real)
  - sliceAlongLatLonLine
```
public visad.FieldImpl sliceAlongLatLonLine(visad.georef.LatLonPoint start,
                                            visad.georef.LatLonPoint end)
                                     throws visad.VisADException
```
    Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
    
    Parameters:
    
    start - starting position for line
    
    end - ending position for line
    
    Returns:
    
    slice along the line
    
    Throws:
    
    visad.VisADException - problem doing slice
    
    See Also:
    
    GridUtil.sliceAlongLatLonLine(FieldImpl, LatLonPoint, LatLonPoint)
  - sliceAlongLatLonLine
```
public visad.FieldImpl sliceAlongLatLonLine(visad.georef.LatLonPoint start,
                                            visad.georef.LatLonPoint end,
                                            int samplingMode)
                                     throws visad.VisADException
```
    Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
    
    Parameters:
    
    start - starting position for line
    
    end - ending position for line
    
    samplingMode - type of sampling
    
    Returns:
    
    slice along the line
    
    Throws:
    
    visad.VisADException - problem doing slice
    
    See Also:
    
    GridUtil.sliceAlongLatLonLine(FieldImpl, LatLonPoint, LatLonPoint)
  - sliceAlongLatLonLine
```
public visad.FieldImpl sliceAlongLatLonLine(java.util.List<visad.georef.LatLonPoint> points,
                                            int samplingMode)
                                     throws visad.VisADException
```
    Slice the grid at along a lat/lon line Interface to GridUtil.sliceAlongLatLonLine().
    
    Parameters:
    
    start - starting position for line
    
    end - ending position for line
    
    samplingMode - type of sampling
    
    Returns:
    
    slice along the line
    
    Throws:
    
    visad.VisADException - problem doing slice
    
    See Also:
    
    GridUtil.sliceAlongLatLonLine(FieldImpl, LatLonPoint, LatLonPoint)
  - slice
```
public visad.FieldImpl slice(visad.SampledSet slice)
                      throws visad.VisADException
```
    Slice (resample) the grid along the slice Interface to GridUtil.slice().
    
    Parameters:
    
    slice - resampling domain
    
    Returns:
    
    slice of data from grid along the domain
    
    Throws:
    
    visad.VisADException - problem with slice
  - isEnsemble
```
public boolean isEnsemble()
```
    Is the grid an ensemble?
    
    Returns:
    
    true if an ensemble
  - getEnsembleSet
```
public visad.Gridded1DSet getEnsembleSet()
```
    Get the ensemble set
    
    Returns:
    
    the set or null if not an ensemble
  - getNumEnsembles
```
public int getNumEnsembles()
```
    Get number of ensembles
    
    Returns:
    
    number of ensemble members (or 0)

Class GridDataInstance

Field Summary

Fields inherited from class ucar.unidata.data.DataInstance

Constructor Summary

Method Summary

Methods inherited from class ucar.unidata.data.DataInstance

Methods inherited from class java.lang.Object

Constructor Detail

GridDataInstance

GridDataInstance

Method Detail

reInitialize

init

getNavigation

isTimeSequence

is3D

getSpatialDomain

getZUnit

getRange

getRanges

getRealType

getNumRealTypes

getRangeType

getRealTypeName

getFieldImpl

getGrid

getGrid

getRawUnit

getDomainSet3D

getCoords3D

getThreeDCoordTrans

getSize

getSizeX

getSizeY

getSizeZ

getFlatField

getZUnit

getZType

getZUnitName

toString

getLevels

getDateTimes

sliceAtLevel

sliceAlongLatLonLine

sliceAlongLatLonLine

sliceAlongLatLonLine

slice

isEnsemble

getEnsembleSet

getNumEnsembles