![[attach.png]](../../../../idldoc-resources/attach.png)
general/missions/rbsp/spacecraft/
rbsp_load_state.pro
NAME: rbsp_load_state (procedure) PURPOSE: Load spacecraft state. As of 10/29/12, valid data types are: 'pos' 'vel' 'spinper' 'spinphase' 'mat_dsc' 'umbra' where: 'pos'('vel'): Spacecraft position(velocity). By default, the routine only loads GSE coordinates. Set /get_support_data to load GSM coordinates as well. 'spinper': Spacecraft spin period. 'spinphase': Spacecraft spin phase. Spin phase is defined as the angle of the sun sensor with respect to the sun-pulse location (i.e., DSC x). 'mat_dsc': Rotation matrix in the form [N, 3, 3] between DSC and GSE. This matrix should be near constant over an orbit. 'umbra': Loads eclipse umbra times and inward and outward penumbra lengths. MATRIX USE EXAMPLES IN IDL Suppose mat_dsc is stored in 'rbsp_mat_dsc', and 'rbsp_vector_dsc' is a vector in vector in DSC with array form [N,3]. Then the following code will rotate 'rbsp_vector_dsc' into a vector in GSE, say, 'rbsp_vector_gse': tvector_rotate, 'rbsp_mat_dsc', 'rbsp_vector_dsc', $ newname = 'rbsp_vector_gse' If keyword get_support_data is set, GSM positon and velocity of the spacecraft are obtained via cotrans, and the Xgse, Ygse, and Zgse unit vectors in DSC are extracted from mat_dsc. Tips: 1. Set /no_update if no need to look for new files in the remote server to increase speed. CATEGORIES: CALLING SEQUENCE: rbsp_load_state, probe = probe, datatype = datatype, dt = dt, $ no_update = no_update, klist = klist, unload = unload, $ spice_only = spice_only, get_support_data = get_support_data, $ verbose = verbose, downloadonly = downloadonly, $ no_eclipse = no_eclipse, $ use_eph_predict = use_eph_predict, $ no_spice_load = no_spice_load ARGUMENTS: KEYWORDS: probe: (In, optional) RBSP spacecraft names, either 'a', or 'b', or ['a', 'b']. The default is ['a', 'b'] datatype: (In, optional) See above. dt: (In, optional) Cadence in seconds of the loaded state data. Default = 5. /no_update: If set, will not check if the remote server has newer SPICE kernels, and will use the local SPICE kernels. klist: A named variable to return the loaded local spice kernels. /unload: If set, will not unload the loaded SPICE kernels. !!!Use this with caution.!!! /spice_only: If set, will only load SPICE kernels, and will not load regular tplot state data. /get_support_data: See above. verbose: IN, OPTIONAL Verbose level for dprint. Default equals !rbsp_efw.verbose /downloadonly: If set, only download data, no processing. Default equals !rbsp_efw.downloadonly no_eclipse: OUT, OPTIONAL A named variable to receive 1 or 0 for no/with eclipse. COMMON BLOCKS: EXAMPLES: sc = 'a' timespan, '2012-10-16' rbsp_load_state, probe = sc SEE ALSO: HISTORY: 2012-10-29: Created by Jianbao Tao (JBT), SSL, UC Berkley. 2012-11-02: Initial release to TDAS. JBT, SSL/UCB. 2012-11-03: JBT, SSL/UCB. 1. Changed the behavior of keyword get_support_data. Eclipse times are loaded by default now. The new behavior of get_support_data is to get spacecraft GSM position and velocity, and extract Xgse, Ygse, and Zgse in DSC from mat_dsc and save them into tplot. 2. Added keyword verbose. 3. Some minor improvements. 2012-11-03: JBT, SSL/UCB. 1. Changed *interpol* to *interp* 2012-11-23: JBT, SSL/UCB. 1. Added downloadonly keyword. 2013-01-27: JBT, SSL/UCB. 1. Restricted attitude files to be downloaded to be within +/- 3 days of current time span. 2013-01-27: JBT, SSL/UCB. 1. Added no_eclipse keyword. 2013-04-04: JBT, SSL/UCB. 1. Added keyword *use_eph_predict*. 2. Added keyword *no_spice_load*. VERSION: $LastChangedBy: jianbao_tao $ $LastChangedDate: 2013-07-19 10:17:46 -0700 (Fri, 19 Jul 2013) $ $LastChangedRevision: 12690 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/spacecraft/rbsp_load_state.pro $
Routines
Routines from rbsp_load_state.pro
result = rbsp_load_state_get_attitude_filelist(remote_dir, localdir=localdir)rbsp_load_state_download_spice_probe_attitude, probe=proberbsp_load_state_download_spice_probe, probe=proberbsp_load_state_download_spice_generalresult = rbsp_load_state_lsk_kernel(sc)result = rbsp_load_state_general_kernels(sc)result = rbsp_load_state_eph_kernel(sc)result = rbsp_load_state_eph_predict_kernel(sc)result = rbsp_load_state_att_kernels(sc)result = rbsp_load_state_sclk_kernel(sc)result = rbsp_load_state_spice_kernel_list(probe=probe, use_eph_predict=use_eph_predict)rbsp_load_state_load_spice, probe=probe, no_update=no_update, klist=klist, downloadonly=downloadonly, use_eph_predict=use_eph_predictresult = rbsp_load_state_eclipse_time_files(sc)result = rbsp_load_state_eclipse_str2time(subitems)rbsp_load_state_parse_eclipse_time_file, file, sc, umbra_sta, umbra_end, in_penumbra_len, out_penumbra_len, no_eclipse=no_eclipserbsp_load_state_load_eclipse_time, probe=probe, no_eclipse=no_eclipseresult = rbsp_load_state_smooth_mat_dsc(mat_dsc)rbsp_load_state, probe=probe, datatype=datatype, dt=dt, no_update=no_update, klist=klist, unload=unload, spice_only=spice_only, get_support_data=get_support_data, verbose=verbose, downloadonly=downloadonly, no_eclipse=no_eclipse, use_eph_predict=use_eph_predict, no_spice_load=no_spice_load
Routine details
top source rbsp_load_state_get_attitude_filelist
result = rbsp_load_state_get_attitude_filelist(remote_dir, localdir=localdir)
Parameters
- remote_dir
Keywords
- localdir
top source rbsp_load_state_download_spice_probe_attitude
rbsp_load_state_download_spice_probe_attitude, probe=probe
Keywords
- probe
top source rbsp_load_state_download_spice_probe
rbsp_load_state_download_spice_probe, probe=probe
Keywords
- probe
top source rbsp_load_state_general_kernels
result = rbsp_load_state_general_kernels(sc)
Parameters
- sc
top source rbsp_load_state_eph_predict_kernel
result = rbsp_load_state_eph_predict_kernel(sc)
Parameters
- sc
top source rbsp_load_state_spice_kernel_list
result = rbsp_load_state_spice_kernel_list(probe=probe, use_eph_predict=use_eph_predict)
Keywords
- probe
- use_eph_predict
top source rbsp_load_state_load_spice
rbsp_load_state_load_spice, probe=probe, no_update=no_update, klist=klist, downloadonly=downloadonly, use_eph_predict=use_eph_predict
Keywords
- probe
- no_update
- klist
- downloadonly
- use_eph_predict
top source rbsp_load_state_eclipse_time_files
result = rbsp_load_state_eclipse_time_files(sc)
Parameters
- sc
top source rbsp_load_state_eclipse_str2time
result = rbsp_load_state_eclipse_str2time(subitems)
Parameters
- subitems
top source rbsp_load_state_parse_eclipse_time_file
rbsp_load_state_parse_eclipse_time_file, file, sc, umbra_sta, umbra_end, in_penumbra_len, out_penumbra_len, no_eclipse=no_eclipse
Parameters
- file
- sc
- umbra_sta
- umbra_end
- in_penumbra_len
- out_penumbra_len
Keywords
- no_eclipse
top source rbsp_load_state_load_eclipse_time
rbsp_load_state_load_eclipse_time, probe=probe, no_eclipse=no_eclipse
Keywords
- probe
- no_eclipse
top source rbsp_load_state_smooth_mat_dsc
result = rbsp_load_state_smooth_mat_dsc(mat_dsc)
Parameters
- mat_dsc
top source rbsp_load_state
rbsp_load_state, probe=probe, datatype=datatype, dt=dt, no_update=no_update, klist=klist, unload=unload, spice_only=spice_only, get_support_data=get_support_data, verbose=verbose, downloadonly=downloadonly, no_eclipse=no_eclipse, use_eph_predict=use_eph_predict, no_spice_load=no_spice_load
Keywords
- probe
- datatype
- dt
- no_update
- klist
- unload
- spice_only
- get_support_data
- verbose
- downloadonly
- no_eclipse
- use_eph_predict
- no_spice_load
File attributes
| Modification date: | Thu Feb 13 16:43:27 2014 |
| Lines: | 703 |