Choosing the Display in read_stxm5.pro

Read Sec. 10.3 for a general description of read_stxm5, our command-line IDL program to read data files.

You have several options to obtain a specific signal:

• Set the keyword(s) image_data_khz, image_data_raw and / or image_data_intraw to named variables which will contain the entire 3-d dataset of that signal type. You can easily cut out a certain slice from there.

• To obtain the image of a certain predefined combination, set the parameter khz to a named variable to hold that array (it will be 2-dimensional, because it's only one combination). Also, set the keyword disp_name to a string which holds the name of the combination you want (see Table 9.1). If you omit this, the value from sm_par.disp_name will be taken, which means the signal which was currently displayed when the file was stored.

  If the disp_name is invalid, the khz variable will be undefined. This also holds true if you specified a generally valid disp_name, but the respective signal was not recorded in the scan (say, you recorded only the proportional counter in a scan, but now want to read the display "BF total").

• It is also possible to return one entry from image_data_khz, raw or intraw into the khz array. For that, set disp_name to a string 'signal_type::channel_name', e.g.

          IDL> read_stxm5, filename, sm_par, khz, $
               disp_name='calibrated khz::sidet04'
  

It is currently not possible to have read_stxm5.pro return the entire 3-d array of predefined combinations. I might write a separate routine to do build the combinations from the calibrated khz array, as is done already internally in SM_GUI.

Also note that all string comparisons are made case-insensitive, so you don't have to pay special attention to case when passing a disp_name etc.