Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/themis/state/

Contents

.pro files

apply_spinaxis_corrections.pro
thm_autoload_support.pro

NAME: thm_autoload_supportPURPOSE: given a THEMIS tplot variable name, check to see if spin period and phase exist, for coordinate transformations, If they do not, load the state data for the appropriate time periodCALLING SEQUENCE: thm_autoload_support, vname=vname, spinmodel=spinmodel, spinaxis=spinaxis, slp=slp, probe_in=probe, trange=[tmin, tmax], history_out=hist_stringINPUT:OUTPUT:KEYWORDS: vname = tplot variable name probe_in: Specifies the probe name to load support data for (required for /spinmodel and /spinaxis) spinmodel: if set to 1, ensure spinmodel data is loaded and covers the requested time interval spinaxis: if set to 1, ensure state (spinras, spindec) data is loaded and covers the requested time interval slp: if set, ensure sun & moon data are loaded and cover the requested time interval trange: Specify a time range for which support data should be loaded (required if vname is not supplied) history_out = a history string, if data needs loadingHISTORY: 2013-12-19: Adapted from thm_ui_check4spin by jwl NOTES:$LastChangedBy: jwl $$LastChangedDate: 2014-06-12 10:12:12 -0700 (Thu, 12 Jun 2014) $$LastChangedRevision: 15355 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/state/thm_autoload_support.pro $

thm_interpolate_state.pro

function: thm_interpolate_statePurpose: interpolates the low res STATE file all variables are structures as produced by get_datakeywords:Examples: tha_spinper_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spinper=thx_spinper) --> linear interpolation tha_spinphase_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spinper=thx_spinper,thx_spinphase=thx_spinphase) --> phase constructed according to the nearest neighbor spin phase, spin period tha_spinras_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spinras=thx_spinras) --> linear interpolation tha_spindec_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spindec=thx_spindec) --> linear interpolation tha_spinalpha_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spinalpha=thx_spinalpha) --> linear interpolation tha_spinbeta_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_spinbeta=thx_spinbeta) --> linear interpolation tha_pos_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_pos=thx_pos) --> spline interpolation tha_vel_highres=thm_interpolate_state(thx_xxx_in=thx_xxx_in,thx_vel=thx_vel) --> spline interpolationNotes: under construction!!Written by Hannes Schwarzl $LastChangedBy: pcruce $ $LastChangedDate: 2013-06-13 17:51:42 -0700 (Thu, 13 Jun 2013) $ $LastChangedRevision: 12531 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/state/thm_interpolate_state.pro $

thm_load_slp.pro
thm_load_state.pro

Procedure: THM_LOAD_STATEPurpose: Loads THEMIS STATE (orbit and attitude) data;keywords: probe = Probe name.

thm_load_state2.pro

Procedure: THM_LOAD_STATE2Purpose: Loads THEMIS STATE (orbit and attitude) data;keywords: probe = Probe name.

thm_load_state3.pro

Procedure: THM_LOAD_STATE2Purpose: Loads THEMIS STATE (orbit and attitude) data;keywords: probe = Probe name.

thm_load_state_relpath.pro

NAME:thm_load_state_relpathPURPOSE:Alternate relpathname routine for L1 state data, allows for differentrelpath from SPDF directory with v0? in the final relpathnameCALLING SEQUENCE:relpathnames = thm_load_state_relpath(sname = sname, filetype = filetype, level = level, $ version = version, $ trange = trange, $ addmaster = addmaster)INPUT: sname = probe, one of ['a','b','c','d','e'] filetype = 'state' -> this keyword is only defined here due to the interface to thm_load_xxx level = 'l1' -> this keyword is only defined here due to the interface to thm_load_xxx version = '0','1','2','3' or '?' The default is to not have a version number, and this keyword is not used trange = the timerange relpathnames_local = the fullpath of the file as it will be saved locally, this is an output keywordOUTPUT: relpathnames = the full path of the files relative to the local and remote data directories.

thm_spin_phase.pro

NAME: thm_spin_phasePurpose: Use sunpulse data produced by thm_sunpulse to get spinphase at abitrary timesInput Parameters: time_dat: double precision array: times of data points at which interpolates are desired.

thm_sunpulse.pro

NAME: thm_sunpulsePurpose: Interpolate spin phase to have same time resolution as time_datKeyword: probe: string indicating probe.