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_spinfit.pro


NAME: rbsp_spinfit (procedure) PURPOSE: Derive spin-fit E-field from instantaneous E-field measurements. The spin-fit model is as such: fit = A + B * cos(phi) + C * sin(phi) where B and C are E-fields in the DSC X and Y dimensions, and angle is the angle between the DSC X direction and the EFW spin plane boom used in the spin-fit derivation, as demonstrated below. DSC Y | / EFW spin plane boom | / | / | / | / | / | / |/)angle________ DSC X NOTES: 1. Similar to thm_spinfit.pro, this routine is a wrapper of spinfit.pro for RBSP. Unlike thm_spinfit, this routine only works on one tplot variable at a time. 2. Normally, this routine saves four tplot variables, such as 'rbspa_efw_esvy_spinfit_a' 'rbspa_efw_esvy_spinfit_b' 'rbspa_efw_esvy_spinfit_c' 'rbspa_efw_esvy_spinfit' where the first three are the three cooefficients from the fit and the last one is like a normal EFW data type in DSC. CATEGORIES: CALLING SEQUENCE: rbsp_spinfit ,var_name_in, $ sigma=sigma, npoints=npoints, spinaxis=spinaxis, median=median, $ plane_dim=plane_dim, axis_dim=axis_dim, $ min_points=min_points,alpha=alpha,beta=beta, $ phase_mask_starts=phase_mask_starts, $ phase_mask_ends=phase_mask_ends, $ sc = sc, force = force, tper = tper, tphase = tphase ARGUMENTS: var_name_in: IN, REQUIRED EFW tplot data used for the spin-fit derivation. Must be in UVW. KEYWORDS: sc: IN, OPTIONAL Spacecraft name. Must be 'a' or 'b'. /force: IN, OPTIONAL If set, force to do the derivation. Useful when the input tplot data do not have coord_sys information. tper: IN, OPTIONAL Spin-period tplot name. tphase: IN, OPTIONAL Spin-phase tplot name. See spinfit.pro and thm_spinfit.pro for usage of other keywords. Exception: AXIS_DIM defaults to 2 instead of 0 in this routine. COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2013-01-22: Created by Jianbao Tao (JBT), SSL, UC Berkley. VERSION: $LastChangedBy: jianbao_tao $ $LastChangedDate: 2013-02-06 10:59:30 -0800 (Wed, 06 Feb 2013) $ $LastChangedRevision: 11535 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_spinfit.pro $

Routines

top source rbsp_spinfit

rbsp_spinfit, var_name_in, sigma=sigma, npoints=npoints, spinaxis=spinaxis, median=median, plane_dim=plane_dim, axis_dim=axis_dim, min_points=min_points, alpha=alpha, beta=beta, phase_mask_starts=phase_mask_starts, phase_mask_ends=phase_mask_ends, sc=sc, force=force, tper=tper, tphase=tphase

Parameters

var_name_in

Keywords

sigma
npoints
spinaxis
median
plane_dim
axis_dim
min_points
alpha
beta
phase_mask_starts
phase_mask_ends
sc
force
tper
tphase

File attributes

Modification date: Thu Feb 13 16:43:27 2014
Lines: 93