Skip to content

get_pcssetup_struct.m

Basic Information

  SYNTAX:  setup = get_pcssetup_struct(shot, server, debug)

  PURPOSE:  Get all parameter data from the PCS setup file and load it into
            a single matlab data structure.

  INPUT:
   shot = shot number to get data from
   server = server name (see get_pcs_server for processing of this input)
   debug = flag, set = 1 to get debug prints, else 0

  OUTPUT:
   setup
       Each category/phase combination has three types of data, each of which
       is represented in the setup strucuture as a sub-structure.  The matrices
       field contains data from matrix parameter data blocks.  The labeled_data
       field contains structured data with labels.  The misc field contains data
       that does not fit into the matrix or labeled data classifications.

      Setup has the following structure:
       setup.
           (category).  --Struct. Name of pcs category. Spaces are replaced with '_'.
                        If the leading character is a number, 'x' is prepended.
               (phase). --Struct. Name of pcs phase. Spaces are replaced with '_'
                        If the leading character is a number, 'x' is prepended.
                   matrices. --array of structs--
                       param_name --char array--
                       dims. --struct--
                           nmatrices
                           nrows
                           ncols
                       matrix_names  --char matrix--
                       col_names     --char matrix--
                       row_names     --char matrix--
                       data          --3d matrix--
                   labeled_data  --array of structs--
                       param_name  --char array--
                       data_fields. --array of structs--
                           label --char array--
                           data
                   misc
                       param_name --char array--
                       data  -- See note below--

       Note on misc.data:
       When non-labeled or non-matrix data is retrieved, it is formatted one
       of two ways.  If the data has a single field, then misc.data
       simply holds that fields data (e.g. misc.data = [3 3]).  If the
       data has multiple fields, then misc.data has sub-fields with names
       field_0 ... field_N where N is the number of fields.