njtbx-icon
Netcdf-Java Toolbox
previous Function nj_writeNcMLtoFile
Class mDataset Next

 
 
API Documentation

The NJ toolbox (njTBX) API is a matlab object API. Follow the navigation links below to know more about the njTBX objects and methods functionality.

Class

Methods

mDataset:
Opens a netcdf file and creates a grid or netcdf data object.
close(nc) - closes the dataset object (clean up).
getAttributes(nc) - get all global attributes in a matlab structure.
getGeoGridVar(nc, 'variable_name') - Get variable into a GeoGrid.
getInfo(nc) - Display detailed data information about the dataset, including grid types.
getJDataset(nc) - Retrieves a java JDataset object. (For experience java users)
getVar(nc, 'variable_name') - Retrieves the specified variable into an 'mVar' matlab object/class.
mGeoGridVar:
Creates a GeoGrid Variable object.
 
getAttributes(gvar,attName) - get attribute(s) associated with the gridded variable.
getCoordSys(gvar) - Get the Grid Coordinate System associated with the referenced GeoGrid.
getData(gvar, timeIndex, vertLevelIndex) - get the 3D volume data.
getGrid(gvar, timeIndex, vertLevel) - Get grid coordinate and time axes associated with the geogrid.
getJGeoGridDataset(gvar) - Retrieves a java JGeoGridDataset object.(For experience java users)
getShape(gvar) - get grid variable shape.
subsetGeoGridVar(gvar, start, count, stride) - subset gridded variable.
mGridCoordinates:
Creates a grid coordinates object associated with referenced geogrid.
 
getLatAxis(gcoord) - Get the Latitute points.
getLonAxis(gcoord) - Get the Longitude points.
getTimes(gcoord) - Get time(s) in DATENUM format
getVerticalAxis(gcoord) - get vertical coordinate data.
mVar:
Creates a netcdf variable (non-gridded/gridded) object.
 
getAttributes(mvar,attName) - get attribute(s) associated with the variable.
getData(mvar, start, count, stride) - get data from variable.
getJNetcdfDataset(mvar) - Retrieves a java JNetcdfDataset object.(For experience java users).
getShape(mvar) - get variable shape.
getTimes(mvar, timeIndex) - Get time(s) in DATENUM format.
isGridded(mvar) - Is variable a grid variable ?

 

previous Function nj_writeNcMLtoFile
Class mDatasetNext
© 2006-2009   Mississippi State University   • License Terms   • Credits