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).
• shouldReadOnly (optional) open the returned NetCDFFile read-only (default true).
• computationalBackend runtime backend override for constant-stratification transforms; default "matlab"

Returns

• wvt an instance of a WVTransform subclass
• ncfile a caller-owned 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.

Restoring only the transform closes the NetCDF file before returning. If you intend to read more than one time point from the save file, request the second output and hold onto that read-only NetCDFFile instance, then call initFromNetCDFFile. This avoids the relatively expensive operation recreating the WVTransform, and simply reads the appropriate data from file. The caller owns the returned NetCDFFile and must close it. Set shouldReadOnly=false only when writable access is required.

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