Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

general/missions/rbsp/efw/

rbsp_interp_spin_phase.pro


NAME: rbsp_interp_spin_phase (function) PURPOSE: Calculate spin phases at arbitrary times using linear interpolation. CATEGORIES: CALLING SEQUENCE: phase = rbsp_interp_spin_phase(sc, time_array, $ newname = newname $ , tper = tper $ , tphase = tphase $ , tumbra_sta = tumbra_sta $ , tumbra_end = tumbra_end $ , umbra_pad = umbra_pad) ARGUMENTS: sc: (In, required) Spacecraft name. Should be 'a' or 'b'. time_array: (In, required) A time array at which spin phases are returned. KEYWORDS: newname: (In, optional) A tplot name for storing the returned spin phases. If not provided, the spin phases are not stored into a tplot name. tper: (In, optional) Spin-period tplot name. By default, tper = 'rbsp' + strlowcase(sc[0]) + '_spinper' tphase: (In, optional) Spin-phase tplot name. By default, tphase = 'rbsp' + strlowcase(sc[0]) + '_spinphase' tumbra_sta: (In, optional) Umbra starting time tplot name. By default, tumbra_sta = 'rbsp' + strlowcase(sc[0]) + '_umbta_sta' tumbra_end: (In, optional) Umbra ending time tplot name. By default, tumbra_sta = 'rbsp' + strlowcase(sc[0]) + '_umbta_end' umbra_pad: (In, optional) Time padding to the umbra times. By default, umbra_pad = [-20d, 20d] * 60d This padding is to account for spin-period distrotion around umbra. APL has learned this problem, so this default padding will likely change in the future. COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2012-10-24: Created by Jianbao Tao (JBT), SSL, UC Berkley. 2012-11-05: Initial release to TDAS. JBT, SSL/UCB. VERSION: $LastChangedBy: jianbao_tao $ $LastChangedDate: 2013-03-20 13:46:27 -0700 (Wed, 20 Mar 2013) $ $LastChangedRevision: 11848 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_interp_spin_phase.pro $

Routines

Routines from rbsp_interp_spin_phase.pro

result = rbsp_interp_spin_phase_integration(per, tarr, t0, phi0, time_array)
result = rbsp_interp_spin_phase(sc, time_array, newname=newname, tper=tper, tphase=tphase, tumbra_sta=tumbra_sta, tumbra_end=tumbra_end, umbra_pad=umbra_pad)

Routine details

top source rbsp_interp_spin_phase_integration

result = rbsp_interp_spin_phase_integration(per, tarr, t0, phi0, time_array)

Parameters

per
tarr
t0
phi0
time_array

top source rbsp_interp_spin_phase

result = rbsp_interp_spin_phase(sc, time_array, newname=newname, tper=tper, tphase=tphase, tumbra_sta=tumbra_sta, tumbra_end=tumbra_end, umbra_pad=umbra_pad)

Parameters

sc
time_array

Keywords

newname
tper
tphase
tumbra_sta
tumbra_end
umbra_pad

File attributes

Modification date: Thu Feb 13 16:43:26 2014
Lines: 159