This page was created by the IDL library routine
mk_html_help2
.
Last modified: Fri Apr 1 11:58:51 2022.
Procedure: mms_ui_cotrans Purpose: Perform coordinate transforms for MMS dproc plugin. This is the primary routine which loads support data as requested and calls mms_qcotrans to perform the transformation. Calling Sequence: Called internally by SPEDAS API Input: active_data: List of of tplot vars exported from the GUI for processing support_parameters: Structure containing options from the setup routine (mms_ui_qcotrans_options) status_bar: SPEDAS GUI status bar object history_window: SPEDAS GUI history window object _extra keyword also required by API API Output: output_names: List of tplot variables to be loaded into the GUI on completion. support_names: List of support data to be left as tplot variables. All other new tplot variables will be deleted on completion Notes: This routine executes the core of the operation and should be replayable without required user input. To that end, any user querries should be placed in the setup routine (mms_ui_qcotrans_options). $LastChangedBy: pcruce $ $LastChangedDate: 2016-12-07 11:04:32 -0800 (Wed, 07 Dec 2016) $ $LastChangedRevision: 22444 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/mms/common/gui/mms_ui_qcotrans/mms_ui_qcotrans.pro $
(See projects/mms/common/gui/mms_ui_qcotrans/mms_ui_qcotrans.pro)
Procedure: mms_ui_qcotrans_options Purpose: Gets and returns information required to perform MMS coordinate transforms in the SPEDAS GUI. This is the setup routine for mms_ui_qcotrans and the routine explicitly listed in the plugin text file. Calling Sequence: Called internally by SPEDAS API Input: gui_id: Top level widget ID needed for building new windows status_bar: SPEDAS GUI status bar object history_window: SPEDAS GUI history window object loaded_data: SPEDAS loaded data object. Used to check necessity of loading MMS support data. API Output: plugin_structure: Custom output structure used to pass information to plugin's primary routine (mms_ui_qcotrans). Notes: This routine is for setup only. Any action needed to replay the requested operation must occur in the primary routine (mms_ui_qcotrans) instead of here. This includes: -adding to or editing the GUI's loaded data -loading support data or other necessary tplot variables $LastChangedBy: pcruce $ $LastChangedDate: 2016-12-07 11:04:32 -0800 (Wed, 07 Dec 2016) $ $LastChangedRevision: 22444 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/mms/common/gui/mms_ui_qcotrans/mms_ui_qcotrans_options.pro $
(See projects/mms/common/gui/mms_ui_qcotrans/mms_ui_qcotrans_options.pro)
NAME: mms_ui_req_mec PURPOSE: Determines availability of mec quaternion support data CALLING SEQUENCE: General: bool = mms_ui_req_spin(probe,inCoord,outCoord,trange [,loadedData]) Example: if mms_ui_req_spin(probe,inCoord,outCoord,trange,loadedData) then begin mms_load_mec,probe=probe,trange=trange,varformat='*_quat_*' endif INPUT: inCoord: string storing the destination coordinate system (e.g. 'gse') outCoord: string storing the destination coordinate system (e.g. 'sse') probe: mms probe for check trange: two element arraw storing the time range loadedData: gui loadedData object reference OUTPUT: Returns boolean: 1 if required data is not present or does not cover the time range, 0 otherwise. NOTES: This code assumes that only explicit transformations into the coordinates in question will require mec data. HISTORY: 2015-04-24 - loaded data object now optional $LastChangedBy: pcruce $ $LastChangedDate: 2016-12-07 11:04:32 -0800 (Wed, 07 Dec 2016) $ $LastChangedRevision: 22444 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_5_0/projects/mms/common/gui/mms_ui_qcotrans/mms_ui_req_mec.pro $
(See projects/mms/common/gui/mms_ui_qcotrans/mms_ui_req_mec.pro)