general/missions/rbsp/efw/
rbsp_cotrans.pro
NAME: rbsp_cotrans (procedure) PURPOSE: A wrapper of cotrans for RBSP, with a few mission-specific features added. CATEGORIES: CALLING SEQUENCE: rbsp_cotrans, from_tvar, to_tvar $ , gse2gsm = gse2gsm $ , gsm2gse = gsm2gse $ , dsc2gse = dsc2gse $ , dsc2mgse = dsc2mgse $ , dsc2gsm = dsc2gsm $ , gse2dsc = gse2dsc $ , gse2mgse = gse2mgse $ , gsm2dsc = gsm2dsc $ , dsc2fac = dsc2fac $ , mat_dsc = mat_dsc $ , tmag = tmag $ , vectype = vectype $ , verbose = verbose NOTES: 1. A tplot variable of magnetic field in DSC, specified with tmag keyword, is required to perfrom dsc2fac. The default value of tmag is something like 'rbspa_mag_dsc'. 2. A tplot variable of rotation matrix from DSC to GSE, specified with the mat_dsc keyword, is required to perform dsc2gse, gse2dsc, dsc2gsm, and gsm2dsc. The rotation matrix is usually generated by *rbsp_load_state*. The default value of mat_dsc is something like 'rbspa_mat_dsc'. ARGUMENTS: from_tvar: (In, required) A tplot variable to which the rotation is applied. to_tvar: (Out, required) A tplot name for storing the rotation results. KEYWORDS: The following keywords enable the transformations indicated by their names. /gse2gsm, /gsm2gse, /dsc2gse, /dsc2gsm, /gse2dsc, /gsm2dsc mat_dsc: (In, optional) A tplot name of the rotation matrix between DSC and GSE. It is usually loaded in rbsp_load_state. By default, this name is derived as strmid(from_tvar, 0, 6) + 'mat_dsc' vectype: (In, optional) The type of the vectors being transformed. Valid types are 'E', 'B', and 'V'. By default, vectype = ''. This string is used for labelling the to_tvar. verbose: (In, optional) A number to indicate the verbose level. See dprint. COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2012-11-03: Created by Jianbao Tao (JBT), SSL, UC Berkley. 2012-11-05: JBT, SSL, UC Berkley. Initial release to TDAS. 2012-11-20: JBT, SSL, UC Berkley. 1. Added dsc-to-fac transformation. VERSION: $LastChangedBy: jianbao_tao $ $LastChangedDate: 2013-03-20 13:46:28 -0700 (Wed, 20 Mar 2013) $ $LastChangedRevision: 11849 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_cotrans.pro $
Routines
top source rbsp_cotrans
rbsp_cotrans, from_tvar, to_tvar, gse2gsm=gse2gsm, gsm2gse=gsm2gse, dsc2gse=dsc2gse, dsc2mgse=dsc2mgse, dsc2gsm=dsc2gsm, gse2dsc=gse2dsc, gse2mgse=gse2mgse, gsm2dsc=gsm2dsc, dsc2fac=dsc2fac, mat_dsc=mat_dsc, tmag=tmag, vectype=vectype, verbose=verbose
Parameters
- from_tvar
- to_tvar
Keywords
- gse2gsm
- gsm2gse
- dsc2gse
- dsc2mgse
- dsc2gsm
- gse2dsc
- gse2mgse
- gsm2dsc
- dsc2fac
- mat_dsc
- tmag
- vectype
- verbose
File attributes
Modification date: | Thu Feb 13 16:43:26 2014 |
Lines: | 169 |