waveVortexTransformFromFile

Initialize a WVTransform instance from an existing file

Declaration 

 [wvt,ncfile] = WVTransform.waveVortexTransformFromFile(path,options)

Parameters

  • path path to a NetCDF file
  • iTime (optional) time index to initialize from (default 1).

Returns

  • wvt an instance of a WVTransform subclass
  • ncfile a NetCDFFile instance pointing to the file

Discussion

A WVTransform instance can be recreated from a NetCDF file and .mat sidecar file if the default variables were save to file. For example,

  wvt = WVTransform.waveVortexTransformFromFile('cyprus-eddy.nc',iTime=Inf);

will create a WVTransform instance populated with values from the last time point of the file. Note that this is a static function—it is a function defined on the class, not an instance variable—so requires we prepend WVTransform. The result of this function call is an instance variable.

If you intend to read more than one time point from the save file, hold onto the NetCDFFile instance that is returned, and then call initFromNetCDFFile. This avoids the relatively expensive operation recreating the WVTransform, and simply read the appropriate data from file.

See also the users guide for reading and writing to file.