The nc_get_varm_ type family of functions reads a mapped array section of values from a netCDF variable of an open netCDF dataset. The mapped array section is specified by giving a corner, a vector of edge lengths, a stride vector, and an index mapping vector. The index mapping vector is a vector of integers that specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. No assumptions are made about the ordering or length of the dimensions of the data array. The netCDF dataset must be in data mode.
int nc_get_varm_text (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], char *tp); int nc_get_varm_uchar (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], unsigned char *up); int nc_get_varm_schar (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], signed char *cp); int nc_get_varm_short (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], short *sp); int nc_get_varm_int (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], int *ip); int nc_get_varm_long (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], long *lp); int nc_get_varm_float (int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], float *fp); int nc_get_varm_double(int ncid, int varid, const size_t start[], const size_t count[], const ptrdiff_t stride[], const ptrdiff_t imap[], double *dp);
ncid
varid
start
count
stride
imap
tp
up
cp
sp
ip
lp
fp
dp
nc_get_varm_ type returns the value NC_NOERR if no errors occurred. Otherwise, the returned status indicates an error. Possible causes of errors include:
The following imap vector maps in the trivial way a 4x3x2 netCDF variable and an internal array of the same shape:
float a[4][3][2]; /* same shape as netCDF variable */ size_t imap[3] = {6, 2, 1}; /* netCDF dimension inter-element distance */ /* ---------------- ---------------------- */ /* most rapidly varying 1 */ /* intermediate 2 (=imap[2]*2) */ /* most slowly varying 6 (=imap[1]*3) */
Using the imap vector above with nc_get_varm_float obtains the same result as simply using nc_get_var_float.
Here is an example of using nc_get_varm_float to transpose a netCDF variable named rh which is described by the C declaration float rh[6][4] (note the size and order of the dimensions):
#include <netcdf.h> ... #define NDIM 2 /* rank of netCDF variable */ int ncid; /* netCDF ID */ int status; /* error status */ int rhid; /* variable ID */ static size_t start[NDIM] /* netCDF variable start point: */ = {0, 0}; /* first element */ static size_t count[NDIM] /* size of internal array: entire netCDF */ = {6, 4}; /* variable; order corresponds to netCDF */ /* variable -- not internal array */ static ptrdiff_t stride[NDIM] /* variable subsampling intervals: */ = {1, 1}; /* sample every netCDF element */ static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */ = {1, 6}; /* would be {4, 1} if not transposing */ float rh[4][6]; /* note transposition of netCDF variable */ /* dimensions */ ... status = nc_open("foo.nc", NC_WRITE, &ncid); if (status != NC_NOERR) handle_error(status); ... status = nc_inq_varid(ncid, "rh", &rhid); if (status != NC_NOERR) handle_error(status); ... status = nc_get_varm_float(ncid, rhid, start, count, stride, imap, rh); if (status != NC_NOERR) handle_error(status);
Here is another example of using nc_get_varm_float to simultaneously transpose and subsample the same netCDF variable, by accessing every other point of the netCDF variable:
#include <netcdf.h> ... #define NDIM 2 /* rank of netCDF variable */ int ncid; /* netCDF ID */ int status; /* error status */ int rhid; /* variable ID */ static size_t start[NDIM] /* netCDF variable start point: */ = {0, 0}; /* first element */ static size_t count[NDIM] /* size of internal array: entire */ = {3, 2}; /* (subsampled) netCDF variable; order of */ /* dimensions corresponds to netCDF */ /* variable -- not internal array */ static ptrdiff_t stride[NDIM]/* variable subsampling intervals: */ = {2, 2}; /* sample every other netCDF element */ static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */ = {1, 3}; /* would be {2, 1} if not transposing */ float rh[2][3]; /* note transposition of (subsampled) */ /* netCDF variable dimensions */ ... status = nc_open("foo.nc", NC_WRITE, &ncid); if (status != NC_NOERR) handle_error(status); ... status = nc_inq_varid(ncid, "rh", &rhid); if (status != NC_NOERR) handle_error(status); ... status = nc_get_varm_float(ncid, rhid, start, count, stride, imap, rh); if (status != NC_NOERR) handle_error(status);