Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: general/missions/rbsp/efw/

Contents

.pro files

rbsp_ac_highpass_response.pro

NAME: rbsp_ac_highpass_response (function) PURPOSE: Calculate the response of the one-pole 10 Hz high-pass analog filter applied to RBSP AC channel field signals.

rbsp_adc_response.pro

NAME: rbsp_adc_response (function) PURPOSE: Calculate the responses of the RBSP DFB ADC chip.

rbsp_add_fce2spec.pro
rbsp_anti_aliasing_response.pro

NAME: rbsp_anti_aliasing_response (function) PURPOSE: Calculate the frequency responses of the anti-aliasing filters for RBSP field signals.

rbsp_corotation_efield.pro

NAME: rbsp_corotation_efield PURPOSE: Determine the co-rotation electric field for RBSP.

rbsp_cotrans.pro

NAME: rbsp_cotrans (procedure) PURPOSE: A wrapper of cotrans for RBSP, with a few mission-specific features added.

rbsp_despin.pro

NAME: rbsp_despin (procedure) PURPOSE: Rotate data from a spinning frame to DSC.

rbsp_detrend.pro
rbsp_dfb_response.pro

NAME: rbsp_dfb_response (function) PURPOSE: Calculate DFB responses at given frequencies.

rbsp_downsample.pro
rbsp_efw_b1_cmd.pro
rbsp_efw_boom_deploy_history.pro

NAME: rbsp_efw_boom_deploy_history (function) PURPOSE: Returns a structure with all the boom lengths for input date and time CATEGORIES: CALLING SEQUENCE: NOTES: Boom deploy schedule from https://efw.ssl.berkeley.edu/svn/SOC/software/deploy_history/ To Convert SPB total stroke to dipole tip-to-tip, double stroke length and add 1.82 m; e.g.

rbsp_efw_boom_length.pro

NAME: rbsp_efw_boom_length (function) PURPOSE: Return the boom length for a give time.

rbsp_efw_boom_response.pro

NAME: rbsp_efw_boom_response (function) PURPOSE: CATEGORIES: CALLING SEQUENCE: resp = rbsp_efw_boom_response(f, boom_type, rsheath = rsheath, $ H_before = H_before, H_after = H_after) ARGUMENTS: KEYWORDS: COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2012-08-12: Created by Jianbao Tao (JBT), SSL, UC Berkley.

rbsp_efw_cal_fbk.pro

NAME: rbsp_efw_cal_fbk PURPOSE: Calibrate RBSP filterbank data NOTES: -This is meant to be called from rbsp_load_efw_fbk.pro -No check at this point to see if the channel changes over day.

rbsp_efw_cal_spec.pro

NAME: rbsp_efw_cal_spec PURPOSE: Calibrate RBSP spectral data NOTES: Intended to be called from rbsp_load_efw_spec.pro TO DO: -No accounting for possible midday source change -not using boom shorting factor There are 7 returned spec channels.

rbsp_efw_cal_waveform.pro

NAME: rbsp_efw_cal_waveform (procedure) PURPOSE: Calibrate EFW waveform data.

rbsp_efw_cal_xspec.pro

NAME: rbsp_efw_cal_xspec PURPOSE: Calibrate RBSP cross-spectral data NOTES: meant to be called from rbsp_load_efw_xspec.pro The default is that xspec0 is SCMw x E12AC and xspec1 is V1AC x V2AC xspec3 is not used at this time A note on the various channels.

rbsp_efw_clean_esvy.pro

NAME: rbsp_efw_clean_esvy (procedure) PURPOSE: Clean the axial component of EFW esvy data type.

rbsp_efw_clean_vsvy.pro

NAME: rbsp_efw_clean_vsvy (procedure) PURPOSE: Clean the axial components (V5 and V6) of EFW vsvy data type.

rbsp_efw_config.pro

PRO rbsp_efw_config This procedure serves as the RBSP EFW configuration file.

rbsp_efw_config_filedir.pro

Function: rbsp_efw_config_filedir.proPurpose: Get the applications user directory for RBSP EFW data analysis software$LastChangedBy: peters $$LastChangedDate: 2011-12-28 10:26:47 -0800 (Wed, 28 Dec 2011) $$LastChangedRevision: 9477 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_efw_config_filedir.pro $

rbsp_efw_deconvol_inst_resp.pro

NAME: rbsp_efw_deconvol_inst_resp (function) PURPOSE: De-convolve instrument responses for RBSP EFW data, including search-coil data that are channeled into EFW.

rbsp_efw_get_cal_params.pro

NAME: rbsp_efw_get_cal_params (function) PURPOSE: Return RBSP EFW calibration parameters for converting L1 data to L2 data.

rbsp_efw_get_gain_results.pro

NAME: rbsp_efw_get_gain_results PURPOSE: return structure with freq-dependent calibration curves for the searchcoil and EDC channnels on EFW.

rbsp_efw_init.pro

PROCEDURE: rbsp_efw_initPURPOSE: Initializes system variables for RBSP EFW.

rbsp_efw_read_config.pro
rbsp_get_efw_dfb_config.pro

NAME: rbsp_get_efw_dfb_config (function) PURPOSE: Decode the EFW DFB Config byte CALLING SEQUENCE: result = rbsp_get_efw_dfb_config(config_byte) ARGUMENTS: config_byte: (Input, required) Integer or array of integers containing the DFB config byte KEYWORDS: COMMON BLOCKS: EXAMPLES: SEE ALSO: HISTORY: 2013-04-03: Created by Peter Schroeder (PCS), SSL, UC Berkley.

rbsp_gse2mgse.pro

Procedure: rbsp_gse2mgsePurpose: Transforms from GSE to MGSE (modified GSE coord..defined below) If W gse is the spin axis unit vector in GSE coordinates, then (1) Ymgse = -(Wgse x Zgse) So Ymgse is now in the spin plane and in the ecliptic plane and duskward.

rbsp_interp_spin_phase.pro

NAME: rbsp_interp_spin_phase (function) PURPOSE: Calculate spin phases at arbitrary times using linear interpolation.

rbsp_load_eclipse_predict.pro
rbsp_load_efw_b1.pro
rbsp_load_efw_burst_times.pro

NAME: RBSP_LOAD_EFW_BURST_TIMES SYNTAX: rbsp_load_efw_burst_times,probe='a b' PURPOSE: Loads EFW B1 and B2 availability KEYWORDS: probe = 'a', 'b', 'a b', or ['a','b'] trange = time range local_data_dir = local data directory, for overriding default location set in !rbsp_efw or root_data_dir() b1_times, b2_times -> set to named variables to return [x,2] arrays of the start and stop times of each burst in trange HISTORY: 11/2012 - Created - Kris Kersten, kris.kersten@gmail.com 22 Apr 2013 - changed remote_data_dir location 04 Sept 2013 - added support for EB1,2 and MSCB1,2 13 Jan 2014 - added b1_times, b2_times keywords (AWB) VERSION: $LastChangedBy: aaronbreneman $ $LastChangedDate: 2014-01-16 10:31:20 -0800 (Thu, 16 Jan 2014) $ $LastChangedRevision: 13921 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/missions/rbsp/efw/rbsp_load_efw_burst_times.pro $

rbsp_load_efw_esvy_mgse.pro

NAME: RBSP_LOAD_EFW_ESVY_MGSE SYNTAX: rbsp_load_efw_esvy_mgse,probe='a' rbsp_load_efw_esvy_mgse,probe='a',/no_spice_load PURPOSE: Loads EFW ESVY data and despins using SPICE via rbsp_uvw_to_mgse.pro The MGSE coordinate system is defined: Y_MGSE=-W_SC(GSE) x Z_GSE Z_MGSE=W_SC(GSE) x Y_MGSE X_MGSE=Y_MGSE x Z_MGSE where W_SC(GSE) is the spin axis direction in GSE.

rbsp_load_efw_fbk.pro
rbsp_load_efw_fit.pro

Procedure: RBSP_LOAD_EFW_FITPurpose: Loads RBSP EFW FIT datakeywords: probe = Probe name.

rbsp_load_efw_hsk.pro
rbsp_load_efw_hsk_idpu_events.pro
rbsp_load_efw_spec.pro

Procedure: RBSP_LOAD_EFW_SPECPurpose: Loads RBSP EFW SPEC datakeywords: probe = Probe name.

rbsp_load_efw_waveform.pro

Procedure: RBSP_LOAD_EFW_WAVEFORMPurpose: Loads RBSP EFW Waveform datakeywords: probe = Probe name.

rbsp_load_efw_waveform_l2.pro

Procedure: RBSP_LOAD_EFW_WAVEFORM_L2Purpose: Loads RBSP EFW L2 Waveform datakeywords: probe = Probe name.

rbsp_load_efw_xspec.pro

Procedure: RBSP_LOAD_EFW_XSPECPurpose: Loads RBSP EFW XSPEC datakeywords: probe = Probe name.

rbsp_load_maneuver_file.pro

NAME: rbsp_load_maneuver_file SYNTAX: x = rbsp_load_maneuver_file(probe,date) PURPOSE: Returns a structure with start and end times of maneuvers from the MOC data product "maneuver_sequence" files.

rbsp_mgse2gse.pro

TYPE: function.

rbsp_msc_response.pro

NAME: rbsp_msc_response (function) PURPOSE: Calculate the transmittance of the search-coil magnetometer.

rbsp_poynting_flux.pro

***************************************************************************************** PROCEDURE : rbsp_poynting_flux PURPOSE : calculates Poynting flux.

rbsp_read_ect_mag_ephem.pro

NAME: rbsp_read_ect_mag_ephem SYNTAX: PURPOSE: Read in RBSP ECT's official magnetic field model predicted quantities INPUT: sc -> 'a' or 'b' date -> '2014-01-01' OUTPUT: tplot variables with prefix 'rbsp'+sc+'_ME_' Will also return perigeetimes as keyword KEYWORDS: HISTORY: Written by Aaron W Breneman, UMN VERSION: $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

rbsp_remove_spikes.pro
rbsp_spinfit.pro

NAME: rbsp_spinfit (procedure) PURPOSE: Derive spin-fit E-field from instantaneous E-field measurements.

rbsp_split_fbk.pro

NAME: rbsp_split_fbk PURPOSE: Split the filterbank data into separate tplot variables for each channel.

rbsp_uvw_to_mgse.pro

NAME: RBSP_UVW_TO_MGSE SYNTAX: rbsp_uvw_to_mgse,'a','rbspa_efw_esvy' rbsp_uvw_to_mgse,'a','rbspa_efw_esvy',/no_spice_load PURPOSE: Transforms from spinning UVW (RBSP SCIENCE) frame to MGSE.

rbsp_vector_bandpass.pro

***************************************************************************************** FUNCTION : vector_bandpass.pro PURPOSE : This program does a bandpass filter on the input data using IDL's built-in FFT.PRO routine.

rbsp_vxb_subtract.pro