netcdf.getVar

Return data from netCDF variable

Syntax

data = netcdf.getVar(ncid,varid)
data = netcdf.getVar(ncid,varid,start)
data = netcdf.getVar(ncid,varid,start,count)
data = netcdf.getVar(ncid,varid,start,count,stride)
data = netcdf.getVar(...,output_type)

Description

data = netcdf.getVar(ncid,varid) returns data, the value of the variable specified by varid. MATLAB® attempts to match the class of the output data to netCDF class of the variable.

ncid is a netCDF file identifier returned by netcdf.create or netcdf.open.

data = netcdf.getVar(ncid,varid,start) returns a single value starting at the specified index, start.

data = netcdf.getVar(ncid,varid,start,count) returns a contiguous section of a variable. start specifies the starting point and count specifies the amount of data to return.

data = netcdf.getVar(ncid,varid,start,count,stride) returns a subset of a section of a variable. start specifies the starting point, count specifies the extent of the section, and stride specifies which values to return.

data = netcdf.getVar(...,output_type) specifies the data type of the return value data. You can specify any of the following strings for the output data type.

'int8'
'uint8'
'int16'
'int32'
'single'
'double'

This function corresponds to several functions in the netCDF library C API. To use this function, you should be familiar with the netCDF programming paradigm. See netcdf for more information.

Examples

Open the example netCDF file and get the value of a variable in the file.

% Open example file.
ncid = netcdf.open('example.nc','NC_NOWRITE');

% Get the name of the first variable.
[varname, xtype, varDimIDs, varAtts] = netcdf.inqVar(ncid,0);

% Get variable ID of the first variable, given its name.
varid = netcdf.inqVarID(ncid,varname);

% Get the value of the first variable, given its ID.
data = netcdf.getVar(ncid,varid)

data =

  6.0221e+023

% Determine the data type of the output value
whos data
 Name      Size            Bytes  Class     Attributes

  data      1x1                 8  double  

% Get the value again, this time specifying the output data type
data = netcdf.getVar(ncid,varid,'single');

% Determine the data type of the output value
whos data
  Name      Size            Bytes  Class     Attributes

  data      1x1                 4  single   
Was this topic helpful?