initComplexVariable

initialize a complex-valued variable

---

Declaration

 complexVariable = initComplexVariable(name,dimNames,properties,ncType)

Parameters

• name name of the variable (a string)
• dimNames cell array containing the dimension names
• properties (optional) containers.Map
• properties ncType

Returns

• complexVariable a NetCDFComplexVariable object

Discussion

NetCDF does not directly work with complex variables, so this method manages the hassle of working with the real and imaginary parts separately.

The basic work flow is that you need to first,

• initComplexVariable followed by either,
• setVariable, or
• concatenateVariableAlongDimension depending on whether you have a variable dimension.

  ncfile.initComplexVariable('wave-components', {'k','l','j'},containers.Map({'units'},{'m/s'}),'NC_DOUBLE');
  ncfile.setVariable('wave-components',myVariable);