NetCDFFile

A class for reading and writing to NetCDF files

---

Declaration

classdef NetCDFFile < handle

Overview

NetCDF files are a standard file format for reading and writing data. This class is designed to simplify the task of adding new dimensions, variables, and attributes to a NetCDF file compared to using the built-in ncread and ncwrite functions.

  ncfile = NetCDFFile('myfile.nc')
 
  % create two new dimensions and add them to the file
  x = linspace(0,10,11);
  y = linspace(-10,0,11);
  ncfile.addDimension('x',x);
  ncfile.addDimension('y',y);
 
  % Create new multi-dimensional variables, and add those to the file
  [X,Y] = ncgrid(x,y);
  ncfile.addVariable(X,{'x','y'});
  ncfile.addVariable(Y,{'x','y'});

Topics

• Initializing
  • NetCDFFile initialize an from existing or create new file
• Accessing file properties
  • format format
  • ncid file handle
  • path file path the NetCDF file
• Working with dimensions
  • addDimension Adds a both a new dimension and its associated coordinate variable to the NetCDF file.
  • dimensionWithName key-value Map to retrieve a NetCDFDimension object by name
  • dimensions array of NetCDFDimension objects
  • dimensionsForDimIDs return the dimension IDs given the dimension names
• Working with variables
  • addVariable add a new (real or complex) variable to the file
  • complexVariableWithName key-value Map to retrieve a NetCDFComplexVariable object by name
  • complexVariables array of NetCDFComplexVariable objects
  • concatenateVariableAlongDimension append new data to an existing variable
  • initComplexVariable initialize a complex-valued variable
  • initVariable initialize a real-valued variable
  • readVariables read variables from file
  • readVariablesAtIndexAlongDimension read variables from file at a particular index (e.g., time)
  • setVariable add data for a variable with a given name
  • variableWithName key-value Map to retrieve a NetCDFVariable object by name
  • variables array of NetCDFVariable objects
• Working with global attributes
  • addAttribute add a global attribute to the file
  • attributes key-value Map of global attributes
• Schema keys
  • GLNetCDFSchemaUnitsKey Units of the variable or dimension
  • Dimensions
    • GLNetCDFSchemaBasisFunctionKey What basis function describe this dimension
    • GLNetCDFSchemaDomainLengthKey The length of the domain
    • GLNetCDFSchemaDomainMinimumKey The minimum value of the domain
    • GLNetCDFSchemaGridTypeKey type of grid
    • GLNetCDFSchemaIsCoordinateVariableKey A Boolean value that indicates whether the dimension is associated with a coordinate variable
    • GLNetCDFSchemaIsEvenlySampledKey A Boolean value that indicates whether the dimension has even sampling
    • GLNetCDFSchemaIsFrequencyDomainKey A Boolean value that indicates whether the dimension is considered in the frequency (spectral) domain
    • GLNetCDFSchemaIsPeridiocKey A Boolean value that indicates whether the dimension is periodic
    • GLNetCDFSchemaMutableKey A Boolean value that indicates whether the dimension is mutable
    • GLNetCDFSchemaSampleIntervalKey sample interval of the domain, if it is evenly sampled
  • Variables
    • GLNetCDFSchemaIsComplexKey A Boolean value that indicates whether the variable is complex valued
    • GLNetCDFSchemaIsImaginaryPartKey A Boolean value that indicates whether this is the complex part of the variable
    • GLNetCDFSchemaIsRealPartKey A Boolean value that indicates whether this is the real part of the variable
    • GLNetCDFSchemaIsRowVectorKey A Boolean value that indicates whether the variable was defined as a row vector
    • GLNetCDFSchemaProperNameKey Human readable name of the variable
    • GLNetCDFSchemaUniqueVariableIDKey A custom unique variable ID
• Other
  • GLNetCDFSchemaVersionKey - Topic: Schema keys
  • InitializeFromExistingFile
  • addMutableDimension
  • close - Topic: Accessing file properties
  • createNewFile
  • dump
  • netCDF3TypeForData
  • netCDFTypeForData
  • open - Topic: Accessing file properties
  • sync - Topic: Accessing file properties
  • typeStringForTypeID

---