njtbx-icon
Netcdf-Java Toolbox
previous Method getVar
Method getAttributes Next

 
 
Class mGeoGridVar

PURPOSE ^

mGeoGridVar class constructor - creates a GeoGrid Variable object

SYNOPSIS ^

function result = mGeoGridVar(varName, mDatasetObj)

DESCRIPTION ^

mGeoGridVar class constructor - creates a GeoGrid Variable object

 Usage:
  gvar=mGeoGridVar(varName, mDatasetObj) reads the variable and create a
  mGeoGridVar object.
  where,            
       varName: variable name, e.g. 'temp' (only gridded variable)
       mDatasetObj- mDataset object
  returns,
       gvar - A 'gvar' object of class 'mGeoGridVar'.
       In order to know the methods available for data access under
       class 'mGeoGridVar', use matlab 'builtin' function
       'methods(className).
       i.e. methods(gvar)

    Methods for class mGeoGridVar:          

           a. getAttributes(gvar,attName) - get attribute(s) associated with the gridded variable 

           b. getCoordSys(gvar) - Get the Grid Coordinate System associated with the referenced GeoGrid
              It returns a 'Grid Coordinates' object containing coordinate and time axes.
                            
           c. getData(gvar, timeIndex, vertLevelIndex) - get the 3D volume data for all times or particular time index. 
              Specify 'level' to read a Y-X 'horizontal slice' at the given time  
           
           d. getGrid(gvar, timeIndex, vertLevel) - Get grid coordinate and time axes associated with the geogrid. 
              i.e. lat, lon, time and z.
              
           e. getJGeoGridDataset(gvar) - Retrieves a java JGeoGridDataset object.(For experience java users)  
                 
           f. getShape(gvar) - get grid variable shape       

           g. subsetGeoGridVar(gvar, start, count, stride) - subset gridded variable based on start,count and stride. 
              It returns a new subsampled mGeoGridVar object. 
              result = gvar(i,j, ...) - subset using matlab subscripting reference.
			
    See also getGeoGridVar



previous Method getVar
Method getAttributes Next
© 2006-2009   Mississippi State University   • License Terms   • Credits