netcdf.inqVarChunking

Determine chunking settings for NetCDF variable

Syntax

[storage,chunkSizes] = netcdf.inqVarChunking(ncid,varid)

Description

[storage,chunkSizes] = netcdf.inqVarChunking(ncid,varid) returns the type of chunking and the dimensions of a chunk for the NetCDF variable specified by varid, in the file or group specified by ncid.

Input Arguments

`ncid`	Identifier of NetCDF file, returned by `netcdf.create` or `netcdf.open`, or of a NetCDF group, returned by `netcdf.defGrp`.
`varid`	Identifier of NetCDF variable, returned by `netcdf.defVar`.

Output Arguments

storage

Character vector specifying if NetCDF breaks the data into chunks when writing to a file. The value 'CHUNKED' indicates the data is chunked; 'CONTIGUOUS' indicates that the data is not chunked.

chunkSizes

Array specifying the dimensions of the chunk.

Because MATLAB^® uses FORTRAN-style ordering, the order of dimensions in chunkdims is reversed relative to what would be in the NetCDF C API.

If the storage type specified is CONTIGUOUS, netcdf.inqVarChunking returns an empty array, [].

Examples

This example opens the NetCDF sample dataset and gets the values of chunking parameters associated with a variable.

ncid = netcdf.open('example.nc','NOWRITE');
groupid = netcdf.inqNcid(ncid,'grid1');
varid = netcdf.inqVarID(groupid,'temp');
[storage,chunkSize] = netcdf.inqVarChunking(groupid,varid);
netcdf.close(ncid);

References

This function corresponds to the nc_inq_var_chunking function in the netCDF library C API.

For copyright information, read the netcdfcopyright.txt and mexnccopyright.txt files.

Documentation