Directory: projects/maven/swea/

Contents

.pro files

ctime2.pro

PROCEDURE: ctime2,time,y,zINPUT: time: Named variable in which to return the selected time (seconds since 1970) y: Named variable in which to return the y value z: Named variable in which to return the z valueKEYWORDS: PROMPT: Optional prompt string NPOINTS: Max number of points to return PSYM: If set to a psym number, the cooresponding psym is plotted at selected points SILENT: Do not print data point information PANEL: Set to a named variable to return an array of tplot panel numbers coresponding to the variables points were chosen from.

fit_pad_mag.pro

PROCEDURE: fit_pad_magPURPOSE: Determines the time offset between MAG1 data and SWEA MAG angles.

mav_apid_swea_handler.pro

mav_pfdpu_part_decompress_data2.pro

FUNCTION: mav_pfdpu_part_decompress_data2PURPOSE: Decompresses ESA science packets (SWEA/SWIA/STATIC).

mvn_sc_ramdir.pro

PROCEDURE: mvn_sc_ramdirPURPOSE: Determines the velocity vector relative to the body-fixed rotating Mars frame (IAU_MARS), rotated into either spacecraft or APP coordinates.

mvn_swe_calib.pro

PROCEDURE: mvn_swe_calibPURPOSE: Maintains SWEA calibration factors in a common block (mvn_swe_com).

mvn_swe_clear.pro

PROCEDURE: mvn_swe_clearPURPOSE: Clears the swe_dat common block.

mvn_swe_com.pro

mvn_swe_config.pro

PROCEDURE: mvn_swe_configPURPOSE: Maintains SWEA configuration changes in a common block (mvn_swe_com).

mvn_swe_convert_units.pro

PROCEDURE: mvn_swe_convert_unitsPURPOSE: Convert the units for a SWEA 3d data structure.

mvn_swe_crib.pro

mvn_swe_etspec.pro

mvn_swe_get3d.pro

FUNCTION: mvn_swe_get3dPURPOSE: Returns a SWEA 3D data structure constructed from telemetry data (APID's A0 and A1).

mvn_swe_getbits.pro

FUNCTION: mvn_swe_getbitsPURPOSE: Extracts a sub-word defined by a range of bits from an input word.

mvn_swe_getpad.pro

FUNCTION: mvn_swe_getpadPURPOSE: Constructs PAD data structure from raw data.

mvn_swe_getspec.pro

FUNCTION: mvn_swe_getspecPURPOSE: Extracts ENGY data common block at a specified time or time range.

mvn_swe_kp.pro

PROCEDURE: mvn_swe_kpPURPOSE: Calculates SWEA key parameters.

mvn_swe_load_l0.pro

PROCEDURE: mvn_swe_load_l0PURPOSE: Reads in MAVEN Level 0 telemetry files (PFDPU packets wrapped in spacecraft packets).

mvn_swe_magdir.pro

PROCEDURE: mvn_swe_magdirPURPOSE: Converts magnetic field azimuth and elevation bytes from PAD packets (A2 and A3) into azimuth and elevation in radians.

mvn_swe_makecdf_3d.pro

NAME: MVN_SWE_MAKECDF_3D SYNTAX: MVN_SWEA_MAKECDF_3D, DATA, FILE = FILE, VERSION = VERSION PURPOSE: Routine to produce CDF file from SWEA 3D data structures INPUTS: DATA: Structure with which to populate the CDF file (nominally created by mvn_swe_get3d.pro) OUTPUT: CDF file KEYWORDS: FILE: full file name of the output file - only used for testing if not specified (usually won't be), the program creates the appropriate filename VERSION: integer; software version - should be hardcoded when/if software changes HISTORY: Created by Matt Fillingim (with code stolen from JH and RL) Added directory keyword, and deletion of old files, jmm, 2014-11-14 VERSION: $LastChangedBy: jimm $ $LastChangedDate: 2014-11-26 13:47:48 -0800 (Wed, 26 Nov 2014) $ $LastChangedRevision: 16314 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_makecdf_3d.pro $

mvn_swe_makecdf_pad.pro

NAME: MVN_SWE_MAKECDF_PAD SYNTAX: MVN_SWEA_MAKECDF_PAD, DATA, FILE = FILE, VERSION = VERSION PURPOSE: Routine to produce CDF file from SWEA pad data structures INPUT: DATA: Structure with which to populate the CDF file (nominally created by mvn_swe_getpad.pro) OUTPUT: CDF file KEYWORDS: FILE: full file name of the output file - only used for testing if not specified (usually won't be), the program creates the appropriate filename VERSION: integer; software version - should be hardcoded when/if software changes HISTORY: Created by Matt Fillingim (with code stolen from JH and RL) Added directory keyword, jmm, 2104-11-14 VERSION: $LastChangedBy: jimm $ $LastChangedDate: 2014-11-26 13:47:48 -0800 (Wed, 26 Nov 2014) $ $LastChangedRevision: 16314 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_makecdf_pad.pro $

mvn_swe_makecdf_spec.pro

NAME: MVN_SWE_MAKECDF_SPEC SYNTAX: MVN_SWE_MAKECDF_SPEC, DATA, FILE = FILE, VERSION = VERSION PURPOSE: Routine to produce CDF file from SWEA spec data structures INPUT: DATA: Structure with which to populate the CDF file (nominally created by mvn_swe_getspec.pro) OUTPUT: CDF file KEYWORDS: FILE: full name of the output file - only used for testing if not specified (usually won't be), the program creates the appropriate filename VERSION: integer; software version - should be hardcoded when/if software changes HISTORY: created by Matt Fillingim (with code stolen from JH and RL) Added directory keyword, and deletion of old files, jmm, 2014-11-14 VERSION: $LastChangedBy: jimm $ $LastChangedDate: 2014-11-26 13:47:48 -0800 (Wed, 26 Nov 2014) $ $LastChangedRevision: 16314 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_makecdf_spec.pro $

mvn_swe_makespec.pro

PROCEDURE: mvn_swe_makespecPURPOSE: Constructs ENGY data structure from raw data.

mvn_swe_n1d.pro

FUNCTION parabola(x,par=p)PURPOSE: Evaluates a (2nd degree) polynomial (can be used with "FIT")

mvn_swe_n3d.pro

PROCEDURE: mvn_swe_n3dPURPOSE: Determines density from a 3D distribution.

mvn_swe_pad_resample.pro

mvn_swe_padlut.pro

PROCEDURE: mvn_swe_padlutPURPOSE: Calculates the pitch angle sorting look up table.

mvn_swe_padmap.pro

FUNCTION: mvn_swe_padmapPURPOSE: Calculates the pitch angle map for a PAD.

mvn_swe_ql.pro

PROCEDURE: mvn_swe_qlPURPOSE: Creates SWEA TPLOT variables for QuickLook plots.

mvn_swe_read_l0.pro

PROCEDURE: mvn_swe_read_l0PURPOSE: Reads in MAVEN Level 0 telemetry files (PFDPU packets wrapped in spacecraft packets).

mvn_swe_readcdf_3d.pro

NAME: MVN_SWE_READCDF_3D SYNTAX: MVN_SWE_READCDF_3D, INFILE, STRUCTURE PURPOSE: Routine to read CDF file from mvn_swe_makecdf_3d.pro INPUTS: INFILE: CDF file name to read (nominally created by mvn_swe_makecdf_3d.pro) OUTPUT: STRUCTURE: IDL data structure KEYWORDS: OUTFILE: Output file name HISTORY: Created by Matt Fillingim VERSION: $LastChangedBy: mattf $ $LastChangedDate: 2014-11-25 10:16:02 -0800 (Tue, 25 Nov 2014) $ $LastChangedRevision: 16300 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_readcdf_3d.pro $

mvn_swe_readcdf_spec.pro

NAME: MVN_SWE_READCDF_SPEC SYNTAX: MVN_SWE_READCDF_SPEC, INFILE, STRUCTURE PURPOSE: Routine to read CDF file from mvn_swe_makecdf_spec.pro INPUTS: INFILE: CDF file name to read (nominally created by mvn_swe_makecdf_spec.pro) OUTPUT: STRUCTURE: IDL data structure KEYWORDS: OUTFILE: Output file name HISTORY: Created by Matt Fillingim VERSION: $LastChangedBy: mattf $ $LastChangedDate: 2014-11-25 10:16:02 -0800 (Tue, 25 Nov 2014) $ $LastChangedRevision: 16300 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swea/mvn_swe_readcdf_spec.pro $

mvn_swe_sc_pot.pro

PROCEDURE: mvn_swe_sc_potPURPOSE: Estimates the spacecraft potential from SWEA energy spectra.

mvn_swe_shape_par.pro

PROCEDURE: mvn_swe_shape_parPURPOSE: Calculates SWEA energy shape parameter and stores it as a TPLOT variable.

mvn_swe_spice_init.pro

PROCEDURE: mvn_swe_spice_initPURPOSE: Initializes SPICE.

mvn_swe_stat.pro

PROCEDURE: mvn_swe_statPURPOSE: Reports the status of SWEA data loaded into the common block.

mvn_swe_struct.pro

PROCEDURE: mvn_swe_structPURPOSE: Defines data structures for 3D, PAD, and ENGY products.

mvn_swe_sumplot.pro

PROCEDURE: mvn_swe_sumplotPURPOSE: Plots information generated by MAVEN SWEA APID's.

mvn_swe_sundir.pro

PROCEDURE: mvn_swe_sundirPURPOSE: Determines the direction of the Sun in SWEA coordinates.

mvn_swe_sweep.pro

PROCEDURE: mvn_swe_sweepPURPOSE: Generates a SWEA sweep table exactly as done in flight software (same digital commands, same checksum).

mvn_swe_tabnum.pro

FUNCTION: mvn_swe_tabnumPURPOSE: Given a checksum, determines the corresponding table number.

nibble.pro

FUNCTION: nibblePURPOSE: Converts a byte into an 8-element byte array where the elements are the individual bits (0 or 1).

nibble_long.pro

FUNCTION: nibble_longPURPOSE: Converts an unsigned long into a 32-element byte array where the elements are the individual bits (0 or 1).

nibble_word.pro

FUNCTION: nibble_wordPURPOSE: Converts an unsigned int into a 16-element byte array where the elements are the individual bits (0 or 1).

rotate_mag_to_swe.pro

FUNCTION: rotate_mag_to_swePURPOSE: Rotates input vectors from MAG instrument coordinates to SWEA FSW coordinates.

sigfig.pro

FUNCTION: sigfigPURPOSE: Simple function for rounding off.

swe_3d_snap.pro

PROCEDURE: swe_3d_snapPURPOSE: Plots 3D snapshots in a separate window for times selected with the cursor in a tplot window.

swe_3d_stitch.pro

PROCEDURE: swe_3d_stitchPURPOSE: Constructs 3D spectrograms from A0 packets.

swe_3d_strahl_dir.pro

PROCEDURE: swe_3d_strahl_dirPURPOSE: Determines the direction in SWEA coordinates of the strahl.

swe_3d_timing.pro

PROCEDURE: swe_3d_timingPURPOSE: Disassembles A0 packets and sorts data in time sequence.

swe_a0_snap.pro

PROCEDURE: swe_a0_snapPURPOSE: Plots 3D snapshots in a separate window for times selected with the cursor in a tplot window.

swe_a2_snap.pro

PROCEDURE: swe_a2_snapPURPOSE: Plots PAD snapshots in a separate window for times selected with the cursor in a tplot window.

swe_cal_snap.pro

PROCEDURE: swe_cal_snapPURPOSE: Plots snapshots of calibration data in a separate window for times selected with the cursor in a tplot window.

swe_engy_snap.pro

PROCEDURE: swe_engy_snapPURPOSE: Plots energy spectrum snapshots in a separate window for times selected with the cursor in a tplot window.

swe_engy_timing.pro

PROCEDURE: swe_engy_timingPURPOSE: Disassembles A4 packets and sorts data in time sequence.

swe_getmag_ql.pro

PROCEDURE: swe_getmag_qlPURPOSE: Loads MAG data from one of two sources: (1) MAG quicklook sts files provided by the MAG team.

swe_hsk_snap.pro

PROCEDURE: swe_hsk_snapPURPOSE: Plots housekeeping snapshots for times selected with the cursor in a tplot window.

swe_maxbol.pro

PROCEDURE: swe_maxbolPURPOSE: Maxwell-Boltzmann distribution for fitting SWEA electron energy spectra.

swe_n_3d.pro

FUNCTION: swe_n_3d(dat,EBINS=ebins,ABINS=abins,DBINS=dbins)INPUT: dat: structure, 2d data structure filled mvn_swe_get3dKEYWORDS EBINS: bytarr(na), optional, energy bins array for integration 0,1=exclude,include, na = dat.nenergy ABINS: bytarr(16), optional, anode bins array for integration 0,1=exclude,include DBINS: bytarr(6), optional, deflector bins array for integration 0,1=exclude,include OBINS: bytarr(96), optional, solid angle bins for integration 0,1=exclude,includePURPOSE: Returns the density, n, 1/cm^3CREATED BY: J.McFadden 95-7-27LAST MODIFICATION: 96-7-6 J.McFadden added more keywords 14-7-6 D.Mitchell redefined keywords, added correction for spacecraft potential

swe_pad_snap.pro

PROCEDURE: swe_pad_snapPURPOSE: Plots PAD snapshots in a separate window for times selected with the cursor in a tplot window.

swe_pad_timing.pro

PROCEDURE: swe_pad_timingPURPOSE: Disassembles A2 packets and sorts data in time sequence.

swe_plot_fhsk.pro

PROCEDURE: swe_plot_fhskPURPOSE: Plots SWEA fast housekeeping data (A6).

swe_snap_layout.pro

PROCEDURE: swe_snap_layoutPURPOSE: Puts snapshot windows in convenient, non-overlapping locations, depending on display hardware.

swe_testpulser_model.pro

PROCEDURE: swe_testpulser_modelPURPOSE: Creates SWEA Test Pulser Model and generates test pulser signatures in the three main data products (APID's A0, A2, A4).

timefit.pro

PROCEDURE: timefitPURPOSE: Given an input time array or tplot variable name, sets the tplot time window to span the range of times in the array or tplot variable.