Skip to content

bulk_save_fig_dmp.m

Basic Information

  SYNTAX:  bulk_save_fig_dmp(dmp_fields,fig_paths)

  PURPOSE:
    Generate DIII-D DMP HDF5 files from matlab figures.

  INPUTS:

   *** If dmp_fields & fig_paths not provided, looks for a file in this
       directory called 'dmp_config.m' which defines them

   dmp_fields (optional):  string path to matlab file defining structures
                           dmp_fields and fig_paths as defined below.
   -or-
    dmp_fields (optional):  a struct with these fields defined:
           dmp_fields.author_last [str]:       Your last name
           dmp_fields.data_provider [str]:     Name of data provider
           dmp_fields.publication_year [str]:  Year of publication
           dmp_fields.journal [str]:           Name of journal
           dmp_fields.doc_number [str]:        DIII-D doc number for pubs
                                                 tracker
               dmp_fields.citation [str]:          Full citation

   fig_paths (optional):   a cell-array of strings to map figures to .fig files:
           fig_paths{:,1} [str]:   First column is figure numbers,
                                     a string like: '1', '2b', or '3abc'
           fig_paths{:,2} [str]:   Second column is file paths to .fig
                                     file, like '~/figs/figure3.fig'
                                   ** Alternately, this column can be
                                   a cell array of multiple string
                                   file paths. In this case, it is
                                   assumed that the figure in the
                                   publication is a compound figure
                                   containing multiple .fig files.

  OUTPUTS:
    None in matlab - but will generate .hdf5 files in the current directory
    for each requested figure.

  RESTRICTIONS:
   Not all figure elements are currently support, but most are. See
   get_graph_data.m for the most up to date list of what is and what is
   not supported.

  WRITTEN BY:  Jayson Barr ON 10/11/18

  MODIFICATION HISTORY:

Dependencies