njtbx-icon
Netcdf-Java Toolbox
previous API Index
Method Close Next

 
 
Class mDataset

PURPOSE ^

mDataset class constructor - opens a netcdf file and creates a grid or netcdf mDataset object.

SYNOPSIS ^

function result = mDataset(ncURI)

DESCRIPTION ^

mDataset class constructor - opens a netcdf file and creates a grid or netcdf mDataset object.

 Usage,
   nc=mDataset(ncURI) 
 where,
   ncURI - Location of netcdf file could be local, URL, NcML,
                 OpenDAP, THREDDS etc.
 returns,  
   nc -   A 'nc' object of class 'mDataset'.
          In order to know the methods available for data access under
          class 'mDataset', use matlab 'builtin' function
          'methods(className).
          i.e. methods(nc)        

      Methods for class mDataset:          
			
           a. close(nc) - closes the dataset object (clean up).
           
           b. getAttributes(nc) - get all global attributes in a
           matlab structure.          
           
           c. getGeoGridVar(nc, 'variable_name') - Get variable into a
           GeoGrid if it has a Georeferencing coordinate system. This
           method returns a 'mGeoGrid' matlab object/class.%
 		   
           d. getInfo(nc) - Display detailed data information about
           the dataset, including grid types. This is a good method to
           know status of dataset (especially grids) or quick error check,
           if you are trying to make a non-CF dataset into CF-compliant 
           using NcML.              

           e. getJDataset(nc) - Retrieves a java JDataset object.
              (For experience java users who whould like access to java objects) 
              
           f. getVar(nc, 'variable_name') - Retrieves the specified
           variable into an 'mVar' matlab object/class.
           Variable can also be retrieved using matlab's subscripted
           reference to objects. e.g
           v=nc{'variable_name'} - this will return 'mVariable' object as
           well.
           
 

CROSS-REFERENCE INFORMATION ^

See functions using mDataset:
  • nj_grid_varget NJ_GRID_VARGET - get variable data and associated grid coordinates from local NetCDF file, NetCDF URL or OpenDAP URL
  • nj_time NJ_TIME - Get entire time vector for variable 'var' from any CF-compliant file
  • nj_tslice NJ_TSLICE - Get data and coordinates from a CF-compliant file at a specific time step and level
  • nj_varget NJ_VARGET - get variable data from local NetCDF file, NetCDF URL or OpenDAP URL


previous API Index
Method Close Next
© 2006-2009   Mississippi State University   • License Terms   • Credits