general/missions/rbsp/efw/
rbsp_despin.pro
NAME: rbsp_despin (procedure) PURPOSE: Rotate data from a spinning frame to DSC. By default, the spinning frame is assumed to be the UVW frame. CATEGORIES: CALLING SEQUENCE: rbsp_despin, sc, tvar, angle_offset = angle_offset, pertvar = pertvar, $ newname = newname, uvw = uvw, xyz = xyz, offset_name = offset_name, $ no_axial_processing = no_axial_processing, $ no_offset_remove = no_offset_remove, $ tper = tper, tphase = tphase ARGUMENTS: sc: (In, required) Spacecraft name. Should be 'a' or 'b'. tvar: (In, required) Tplot variable to be despun, such as 'rbspa_mag_uvw'. KEYWORDS: angle_offset: (In, optional) Angle offset additional to spin phase. For UVW, angle_offset is 10 degree, which is the default. pertvar: (In, optional) Spin period tplot data. By default, pertvar = 'rbsp' + strlowcase(sc[0]) + '_spinper'. newname: (In, optional) New name for the despun data. By default, newname = tvar + '_dsc' /uvw: Shortcut for rotating UVW data. /xyz: Shortcut for rotating XYZ data. Equivalent to set angle_offset = 45. offset_name: A tplot name for saving offsets in spin-plane components. /no_axial_processing: If set, axial component is not processed. By default, the first spin-tone harmonic is removed in the axial component. /no_offset_remove: If set, offsets in spin-plane components are not removed. tper: (In, optional) Tplot name of spin period data. By default, tper = pertvar. If tper is set, pertvar = tper. tphase: (In, optional) Tplot name of spin phase data. By default, tphase = 'rbsp' + strlowcase(sc[0]) + '_spinphase' Note: tper and and tphase are mostly used for using eclipse-corrected spin data. COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2012-11-03: Created by Jianbao Tao (JBT), SSL, UC Berkley. 2012-11-05: Initial release to TDAS. JBT, SSL/UCB. 2012-11-06: JBT, SSL/UCB. 1. Added tper and tphase to use eclipse-corrected spin data. 2. Added keyword *no_offset_remove*. VERSION: $LastChangedBy: jianbao_tao $ $LastChangedDate: 2013-02-08 16:58:01 -0800 (Fri, 08 Feb 2013) $ $LastChangedRevision: 11556 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_despin.pro $
Routines
Routines from rbsp_despin.pro
result = rbsp_despin_remove_offset(bu, time_array, pertvar, offset=offset, remove_spintone=remove_spintone)
rbsp_despin, sc, tvar, angle_offset=angle_offset, pertvar=pertvar, newname=newname, uvw=uvw, xyz=xyz, offset_name=offset_name, no_axial_processing=no_axial_processing, no_offset_remove=no_offset_remove, tper=tper, tphase=tphase
Routine details
top source rbsp_despin_remove_offset
result = rbsp_despin_remove_offset(bu, time_array, pertvar, offset=offset, remove_spintone=remove_spintone)
Parameters
- bu
- time_array
- pertvar
Keywords
- offset
- remove_spintone
top source rbsp_despin
rbsp_despin, sc, tvar, angle_offset=angle_offset, pertvar=pertvar, newname=newname, uvw=uvw, xyz=xyz, offset_name=offset_name, no_axial_processing=no_axial_processing, no_offset_remove=no_offset_remove, tper=tper, tphase=tphase
Parameters
- sc
- tvar
Keywords
- angle_offset
- pertvar
- newname
- uvw
- xyz
- offset_name
- no_axial_processing
- no_offset_remove
- tper
- tphase
File attributes
Modification date: | Thu Feb 13 16:43:26 2014 |
Lines: | 122 |