This page was created by the IDL library routine mk_html_help2.

Last modified: Wed May 14 01:32:10 2008.


Directory Listing of Routines


Routine Descriptions

CDF2TPLOT

[Next Routine] [List of Routines]
ault is 'all', i.e., load all available probes.
          This can be an array of strings, e.g., ['a', 'b'] or a
          single string delimited by spaces, e.g., 'a b'
  datatype = The type of data to be loaded, can be an array of strings
          or single string separate by spaces.  The default is 'all'
  TRANGE= (Optional) Time range of interest  (2 element array), if
          this is not set, the default is to prompt the user. Note
          that if the input time range is not a full day, a full
          day's data is loaded

(See ssl_general/CDF/cdf2tplot.pro)


CDF_INFO

[Previous Routine] [Next Routine] [List of Routines]
not set, the default is to prompt the user. Note
          that if the input time range is not a full day, a full
          day's data is loaded
  version = the version of the state file, one of 'v01', 'v02', 'v03', 'v04'.
            defaults to 'v01'
  level = the level of the data, the default is 'l1', or level-1
          data. A string (e.g., 'l2') or an integer can be used. 'all'
          can be passed in also, to get all levels.
  CDF_DATA: named variable in which to return cdf data structure: only works
          for a single spacecraft and datafile name.
  VARNAMES: names of variables to load from cdf: default is all.
  /GET_SUPPORT_DATA: load support_data variables as well as data variables
                      into tplot variables.

(See ssl_general/CDF/cdf_info.pro)


CDF_INFO_TO_TPLOT

[Previous Routine] [Next Routine] [List of Routines]
    for a single spacecraft and datafile name.
  VARNAMES: names of variables to load from cdf: default is all.
  /GET_SUPPORT_DATA: load support_data variables as well as data variables
                      into tplot variables.
  /DOWNLOADONLY: download file but don't read it.
  /valid_names, if set, then this routine will return the valid probe, datatype
          and/or level options in named variables supplied as
          arguments to the corresponding keywords.
  files   named varible for output of pathnames of local files.
  /VERBOSE  set to output some useful info
Example:

(See ssl_general/CDF/cdf_info_to_tplot.pro)


CDF_LOAD_VARS

[Previous Routine] [Next Routine] [List of Routines]
ut some useful info
Example:
   thm_load_state
Notes:

 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-08-21 09:11:07 -0700 (Tue, 21 Aug 2007) $
 $LastChangedRevision: 1464 $
 $URL $
Procedure: THM_LOAD_STATE

Purpose:  Loads THEMIS STATE (orbit and attitude) data

;keywords:
  probe = Probe name. The default is 'all', i.e., load all available probes.

(See ssl_general/CDF/cdf_load_vars.pro)


CDF_SAVE_VARS

[Previous Routine] [Next Routine] [List of Routines]
          data. A string (e.g., 'l2') or an integer can be used. 'all'
          can be passed in also, to get all levels.
  suffix= suffix to add to tplot variable names.  Note: this will get added
          support_data variables as well as regular data variables.
  CDF_DATA: named variable in which to return cdf data structure: only works
          for a single spacecraft and datafile name.
  VARNAMES: names of variables to load from cdf: default is all.
  /GET_SUPPORT_DATA: load support_data variables as well as data variables
                      into tplot variables.
  /DOWNLOADONLY: download file but don't read it.
  /no_download: use only files which are online locally.
  relpathnames_all: named variable in which to return all files that are

(See ssl_general/CDF/cdf_save_vars.pro)


CDF_SET_CDF27

[Previous Routine] [Next Routine] [List of Routines]
d: use only files which are online locally.
  relpathnames_all: named variable in which to return all files that are
          required for specified timespan, probe, datatype, and level.
          If present, no files will be downloaded, and no data will be loaded.
  /valid_names, if set, then this routine will return the valid probe, datatype
          level, and version options in named variables supplied as
          arguments to the corresponding keywords.
  files   named varible for output of pathnames of local files.
  /VERBOSE  set to output some useful info
  coord: Can specify the coordinate system you would like data
  returned in.

(See ssl_general/CDF/cdf_set_cdf27.pro)


CDF_VAR_ATTS

[Previous Routine] [Next Routine] [List of Routines]
es   named varible for output of pathnames of local files.
  /VERBOSE  set to output some useful info
  coord: Can specify the coordinate system you would like data
  returned in.
  no_spin: if set, do not call thm_load_spin to load spinmodel data.


Example:
   thm_load_state
Notes:

Modifications:
  If /GET_SUPPORT_DATA and ~/NO_SPIN, then call THM_LOAD_SPIN, W.M.Feuerstein,
    4/10/2008.
  Delete th?_spin* TPLOT variables after calling THM_LOAD_SPIN (as long as
    ~/KEEP_SPIN_DATA), add KEEP_SPIN_DATA kw, include a couple of (normally
    commented) lines to chck consistency of spinmodel, WMF, 4/10/08.

 coordinate systems of returned variables:
 *_pos : gei
 *_vel : gei
 *_ras : gei

(See ssl_general/CDF/cdf_var_atts.pro)


MAKE_CDF_INDEX

[Previous Routine] [Next Routine] [List of Routines]
 $
 $LastChangedDate: 2008-04-14 11:10:03 -0700 (Mon, 14 Apr 2008) $
 $LastChangedRevision: 2709 $
 $URL $
NAME:
  thm_spin_phase
Purpose:
  Use sunpulse data produced by thm_sunpulse to get spinphase at abitrary times
Input Parameters:
      time_dat: double precision array: times of data points at which
                interpolates are desired.
Output Parameters:
   spinpha_int: interpolated spin phase
Keywords:
         Probe: a single probe name. e.g. 'a'
        suffix: suffix on tplot variable (thx_state_sunpulse[_suffix])

Optional Input Parameters (If not present, then state data will be
   loaded from standard state tplot variables, using probe keyword)
      sunpulse: double precision array: times of sunpulses
  sunp_spinper: spin period at each sunpulse time

K. Bromund, SPSystems/NASA/GSFC, May 2007
$LastChangedBy: bckerr $

(See ssl_general/CDF/make_cdf_index.pro)


PRINT_CDF_INFO

[Previous Routine] [List of Routines]
C, May 2007
$LastChangedBy: bckerr $
$LastChangedDate: 2007-10-18 18:57:15 -0700 (Thu, 18 Oct 2007) $
$LastChangedRevision: 1733 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/state/thm_spin_phase.pro $
NAME:
  thm_sunpulse
Purpose: 
  Interpolate spin phase to have same time resolution as time_dat

(See ssl_general/CDF/print_cdf_info.pro)