Skip to content

fig2dmp.m

Basic Information

  SYNTAX:  fig2dmp(figOrAxesHandles,  contoursJustLevels, varargin)

  PURPOSE:
    Exteract the data from a figure, axes object, or combination of
    figure and axes objects, and store the data in a struture format
    that can be saved as an HDF5 in the DIII-D DMP format.

  INPUTS:
       figOrAxesHandles:    Any number or combination of figure or
                            axes objects. It will be assumed that all
                            included figs/axes are a part of a final
                            figure which should be included together
                            in a single DMP hdf5 file.

       contoursJustLevels:  (default=1) Option to just extract contour
                            traces at the levels displayed in a
                            figure, as opposed to all included data in
                            the underlying matrix from which contours
                            are displayed.
                            For example: if an EFIT flux grid is in
                            the figure, setting to 0 will include the
                            entire flux grid in the output structure.
                            Setting to 1 will just include the
                            contours of flux displayed in the figure
                            itself.

       varagin:             Pairs of strings defining fields to define
                            in the output structure in addition to the
                            data incorporated from the figures. For
                            example, to add info for the data provider
                            these two added args would work:
                                   fig2dmp(fig_handles, 1, 'data_provider','John Doe')

  OUTPUTS:
       dmpstruct:  A structure which can be exported to an hdf5 file
                   in the format used for DIII-D DMP files. See
                   dmphdf5_struct.m for more info on the format of the
                   structure.

  RESTRICTIONS:

  WRITTEN BY:  Jayson Barr ON 10/11/18

  MODIFICATION HISTORY: