Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

general/missions/rbsp/efw/utils/

rbsp_rotate_field_2_vec.pro


NAME: rotate_field_2_vec.pro SYNTAX: rbsp_rotate_field_2_vec,'waveform','vec' where 'waveform' is a tplot variable and 'vec' is either a tplot variable or an array of [3] PURPOSE: Returns the input waveform or vector rotated to one of the following systems. a) Min Var - input "vec" (e.g. DC Bfield) only z-hat defined to be direction of "vec" y_hat is given by vec cross x_max, where x_max is the maximum variance eigenvector x_hat - max variance eigenvector always lies in x-z plane Uses this system by default unless /efa is set or "vec2" is input b) Two vec - input "vec" and "vec2" z-hat is direction of "vec" y-hat = (vec x vec2)/|vec2 x vec| x-hat = (y-hat x vec)/|vec x y-hat| (vec2 is in x-z plane) Uses this if "vec2" is set c) EFA - similar to Two Vec, but doesn't require an additional input vector z-hat is direction of "vec" y-hat is the x-axis of input coord (roughly), formed by crossing vec with [0,1,0]. Uses this if /efa is set INPUT: Tplot variable names of: waveform -> Name of tplot variable of [m,3] or [3] waveform data. Note that if the Min var rotation is requested then must input a [m,3] where m>1 vec -> [3] element vector OR name of tplot variable containing [n,3] element vector to represent the z-hat direction. Ex. Bo in the coord system of "waveform". Note that the coordinates of "vec" and "waveform" must be the same! Also note that m != n necessarily vec2 -> (optional) Same type as "vec". Used to determine the perp direction ("Two vec" rotation only). The x-z plane will contain vec2. Note that vec2 must be the same size as vec NOTES: For EFA and Two Vec rotations, if "waveform" and "vec" have the same number of elements then the rotations are vectorized and the program runs quickly. This doesn't work for the Min Var rotation b/c "waveform" and "vec" cannot be the same size. OUTPUT: Returns tplot variables of rotated waveform in requested coordinates HISTORY: CREATED BY: Aaron Breneman, 03/16/2010 Major modification for use with tplot variables AWB (2/26/2014) VERSION: $LastChangedBy: aaronbreneman $ $LastChangedDate: 2014-09-16 16:26:35 -0700 (Tue, 16 Sep 2014) $ $LastChangedRevision: 15808 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/utils/rbsp_rotate_field_2_vec.pro $

Routines

top source rbsp_rotate_field_2_vec

result = rbsp_rotate_field_2_vec(waveform, vec, vec2=vec2, efa=efa)

Parameters

waveform
vec

Keywords

vec2
efa

File attributes

Modification date: Tue Oct 21 13:53:51 2014
Lines: 231