Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/maven/swia/

Contents

.pro files

mvn_swia_add_magf.pro

PROCEDURE: MVN_SWIA_ADD_MAGFPURPOSE: Add magnetic field (in SWIA coordinates) to SWIA fine and coarse common blocksINPUT:KEYWORDS: BDATA: tplot variable for the magnetic field (will be converted to 'MAVEN_SWIA' frame - so needs 'SPICE_FRAME' defined to work)AUTHOR: J.

mvn_swia_calc_bcrustal.pro

PROCEDURE: MVN_SWIA_CALC_BCRUSTALPURPOSE: Routine to calculate crustal magnetic field (uses Dave Brain's routine)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_CALC_BCRUSTALINPUTS:KEYWORDS: TR: Time range (prompts to choose interactively if not set) PDATA: Tplot variable for position (defaults to MSO), return will have same number of components (make sure this has 'SPICE_FRAME' set or you will fail) $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-17 09:08:14 -0800 (Mon, 17 Nov 2014) $ $LastChangedRevision: 16194 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_calc_bcrustal.pro $

mvn_swia_common_units.pro

PROCEDURE: MVN_SWIA_COMMON_UNITSPURPOSE: Make tplot variables with moments from SWIA 3d data (coarse and/or fine), including average energy flux spectraAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_COMMON_UNITS, UnitsInputs: Units: Units to change all data in common block into $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_common_units.pro $

mvn_swia_convert_units.pro

PROCEDURE: MVN_SWIA_CONVERT_UNITSPURPOSE: Convert the units for a SWIA 3d data structure (fine or coarse) Typically called by the wrapper routine 'Conv_units' Note that my routine works a bit differently from Wind/THEMIS heritage I use the dt_arr field to deal with summed time steps, instead of adding geometric factorsAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_CONVERT_UNITS, Data, Units, SCALE=SCALEINPUTS: Data: A 3d data structure for SWIA (coarse or fine) Units: Units to conver the structure toKEYWORDS: SCALE: Returns an array of conversion factors usedOUTPUTS: Returns the same data structure in the new units $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_convert_units.pro $

mvn_swia_crib.pro

PROCEDURE: MVN_SWIA_CRIBPURPOSE: Crib file to demonstrate SWIA softwareINPUT:KEYWORDS:AUTHOR: J.

mvn_swia_define_apid29.pro

PROCEDURE: MVN_SWIA_DEFINE_APID29PURPOSE: Routine to define decoder and data structures for APID29 (Housekeeping)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID29, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid29.pro $

mvn_swia_define_apid80.pro

PROCEDURE: MVN_SWIA_DEFINE_APID80PURPOSE: Routine to define decoder and data structures for APID80 (Coarse Survey)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID80, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid80.pro $

mvn_swia_define_apid81.pro

PROCEDURE: MVN_SWIA_DEFINE_APID81PURPOSE: Routine to define decoder and data structures for APID81 (Coarse Archive)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID81, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid81.pro $

mvn_swia_define_apid82.pro

PROCEDURE: MVN_SWIA_DEFINE_APID82PURPOSE: Routine to define decoder and data structures for APID82 (Fine Survey)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID82, Decoder = Decoder, Data = Data, /LONGKEYWORDS: LONG: Set to one if defining the large version of the product, else zeroOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid82.pro $

mvn_swia_define_apid83.pro

PROCEDURE: MVN_SWIA_DEFINE_APID83PURPOSE: Routine to define decoder and data structures for APID83 (Fine Archive)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID83, Decoder = Decoder, Data = Data, /LONGKEYWORDS: LONG: Set to one if defining the large version of the product, else zeroOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid83.pro $

mvn_swia_define_apid84.pro

PROCEDURE: MVN_SWIA_DEFINE_APID84PURPOSE: Routine to define decoder and data structures for APID84 (Raw Survey)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID84, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid84.pro $

mvn_swia_define_apid85.pro

PROCEDURE: MVN_SWIA_DEFINE_APID85PURPOSE: Routine to define decoder and data structures for APID85 (Moments)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID85, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid85.pro $

mvn_swia_define_apid86.pro

PROCEDURE: MVN_SWIA_DEFINE_APID86PURPOSE: Routine to define decoder and data structures for APID86 (Spectra)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID86, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid86.pro $

mvn_swia_define_apid87.pro

PROCEDURE: MVN_SWIA_DEFINE_APID87PURPOSE: Routine to define decoder and data structures for APID87 (Fast Housekeeping)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_DEFINE_APID87, Decoder = Decoder, Data = DataOPTIONAL OUTPUTS: Decoder: A structure containing the decommutator type for each field in the packet Data: A structure returning name/type of each field in the packet $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_define_apid87.pro $

mvn_swia_diret.pro

PROCEDURE: mvn_swia_dirEt PURPOSE: Makes directional E-t spectrograms in the specified frame from SWIA Coarse data.

mvn_swia_diretmag.pro

PROCEDURE: mvn_swia_diretmag PURPOSE: Makes directional E-t spectrograms in the specified pitch angle range from SWIA Coarse data.

mvn_swia_fit_step.pro

PROCEDURE: MVN_SWIA_FIT_STEPPURPOSE: Routine to fit discontinuity, in order to find attenuator and mode switchesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_FIT_STEP, Series, Ratio, IndINPUTS: Series: A series of 17 values Ratio: The expected ratio before/after discontinuityOUTPUTS Ind: Index where the change occurred $LastChangedBy: jhalekas $ $LastChangedDate: 2013-12-14 13:53:13 -0800 (Sat, 14 Dec 2013) $ $LastChangedRevision: 13669 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_fit_step.pro $

mvn_swia_get_3dc.pro

FUNCTION: MVN_SWIA_GET_3DCPURPOSE: Construct a standard 3-d data structure for SWIA coarse dataAUTHOR: Jasper HalekasCALLING SEQUENCE: Result = MVN_SWIA_GET_3DC(Time, INDEX=INDEX, /ARCHIVE)OPTIONAL INPUTS: Time: A double unix_time to return a packet for - otherwise uses index or clicksKEYWORDS: INDEX: Gets data at this index value in the common block (useful for looping) ARCHIVE: Returns archive distribution instead of survey START: Gets data at the first point in the common block (useful for looping)OUTPUTS: Returns a standard 3-d data structure that will work with plot3d, spec3d, n_3d, etc.

mvn_swia_get_3df.pro

FUNCTION: MVN_SWIA_GET_3DFPURPOSE: Construct a standard 3-d data structure for SWIA fine dataAUTHOR: Jasper HalekasCALLING SEQUENCE: Result = MVN_SWIA_GET_3DF(Time, INDEX=INDEX, /ARCHIVE)OPTIONAL INPUTS: Time: A double unix_time to return a packet for - otherwise uses index or clicksKEYWORDS: INDEX: Gets data at this index value in the common block (useful for looping) START: Gets data at the first point in the common block (useful for looping) ARCHIVE: Returns archive distribution instead of surveyOUTPUTS: Returns a standard 3-d data structure that will work with plot3d, spec3d, n_3d, etc.

mvn_swia_get_3ds.pro

FUNCTION: MVN_SWIA_GET_3DSPURPOSE: Construct a standard 3-d data structure for SWIA spectra dataAUTHOR: Jasper HalekasCALLING SEQUENCE: Result = MVN_SWIA_GET_3DS(Time, INDEX=INDEX)OPTIONAL INPUTS: Time: A double unix_time to return a packet for - otherwise uses index or clicksKEYWORDS: INDEX: Gets data at this index value in the common block (useful for looping) START: Gets data at the first point in the common block (useful for looping)OUTPUTS: Returns a standard 3-d data structure that will work with plot3d, spec3d, n_3d, etc.

mvn_swia_inst2mso.pro

PROCEDURE: MVN_SWIA_INST2MSOPURPOSE: Routine to rotate SWIA velocity and temperature moments from instrument coordinates to MS0 This routine is in the process of being modified to use Davin's routinesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_INST2MSOINPUTS:KEYWORDS: LOAD: if set, load (and unload) the spice kernels $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-25 12:07:32 -0800 (Tue, 25 Nov 2014) $ $LastChangedRevision: 16301 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_inst2mso.pro $

mvn_swia_iterateprotonalphadists.pro

PROCEDURE: MVN_SWIA_ITERATEPROTONALPHADISTSPURPOSE: Routine to compute approximately the proton and alpha moments from fine distributions, using a fit routine based on the SWIA energy/angle response.

mvn_swia_load_l0_data.pro

PROCEDURE: MVN_SWIA_LOAD_L0_DATAPURPOSE: Routine to load SWIA Level 0 data and produce common blocks and Tplot variablesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_LOAD_L0_DATA, Files, /TPLOT, /SYNCINPUTS: Files: An array of filenames containing PF Level 0 data (not needed if using file_retrieve)KEYWORDS: TPLOT: Produce Tplot variables SYNC: Sync on the spacecraft header and checksum (speeds performance greatly) QLEVEL: Set this keyword to not plot moments or spectra with a low quality flag or decommutation quality flag.

mvn_swia_load_l2_data.pro

PROCEDURE: MVN_SWIA_LOAD_L2_DATAPURPOSE: Routine to load SWIA Level 2 data and produce common blocks and Tplot variables This routine is still preliminary and will include a lot more bells and whistlesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_LOAD_L2_DATA, /TPLOT, /LOADALL, /EFLUX, TRANGE = TRANGEINPUTS: Files: An array of filenames containing PF Level 2 data, by default just the dates in 'YYYYMMDD' format (not needed if using file_retrieve functionality)KEYWORDS: PATH: Directory path for SWIA level 2 files (default 'maven/data/sci/swi/l2/') VERSION: Software version number to put in file (defaults to most recent) REVISION: Data version number to put in file (defaults to most recent) TPLOT: Produce Tplot variables QLEVEL: Set this keyword to not plot moments or spectra with a low quality flag or decommutation quality flag.

mvn_swia_log_decomp.pro

PROCEDURE: MVN_SWIA_LOG_DECOMPPURPOSE: Routine to log-decompress an array of values (OBSOLETE: I have switched to Davin's lookup table routine)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_LOG_DECOMP, Array, TYPE = 0INPUTS: Array: An array of log-compressed valuesKEYWORDS: TYPE: The type of compression, default 0 corresponds to 19-8OUTPUTS: Array: Returns the decompressed values as floats $LastChangedBy: jhalekas $ $LastChangedDate: 2013-05-23 09:54:15 -0700 (Thu, 23 May 2013) $ $LastChangedRevision: 12392 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_log_decomp.pro $

mvn_swia_make_info_str.pro

PROCEDURE: MVN_SWIA_MAKE_INFO_STRPURPOSE: Construct an array of structures with basic information for interpreting SWIA data productsAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_INFO_STR, Info_strOUTPUTS: Info_str: An array of structures defining basic info for given time ranges $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-24 13:15:31 -0800 (Mon, 24 Nov 2014) $ $LastChangedRevision: 16288 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_info_str.pro $

mvn_swia_make_info_str_2.pro

PROCEDURE: MVN_SWIA_MAKE_INFO_STR_2PURPOSE: Construct an array of structures with basic information for interpreting SWIA data productsAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_INFO_STR_2, Info_strOUTPUTS: Info_str: An array of structures defining basic info for given time ranges $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-24 13:15:31 -0800 (Mon, 24 Nov 2014) $ $LastChangedRevision: 16288 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_info_str_2.pro $

mvn_swia_make_l2_data.pro

PROCEDURE: MVN_SWIA_MAKE_L2_DATAPURPOSE: Routine to load SWIA Level 0 data from a file and make Level 2 data filesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_L2_DATA, STARTDATE = STARTDATE, DAYS = DAYS, VERSION = VERSION, REVISION = REVISION, TYPE = TYPE, KLOAD = KLOAD, OLDCAL = OLDCALINPUTS:KEYWORDS: STARTDATE: Starting date to process DAYS: Number of days to process VERSION: Software version number to put in file (default '00') REVISION: Data version number to put in file (default '00') TYPE: 'svy' or 'arc' (default = 'svy') L0_FILE_PATH: Hardwire the path to the L0 files (mainly for testing) OPATH: Hardwire the output path for L2 files (mainly for testing) KLOAD: Load all the relevant spice kernels if set OLDCAL: Use old calibration factors appropriate for original table $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-25 12:07:32 -0800 (Tue, 25 Nov 2014) $ $LastChangedRevision: 16301 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_l2_data.pro $

mvn_swia_make_swic_cdf.pro

PROCEDURE: MVN_SWIA_MAKE_SWIC_CDFPURPOSE: Routine to produce CDF file from SWIA coarse survey or archive dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIC_CDF, FILE=FILE, /ARCHIVE, DATA_VERSION = DATA_VERSIONKEYWORDS: FILE: Output file name ARCHIVE: If set, produce a file with archive data rather than survey (default) DATA_VERSION: Data version to put in file (default = '1') $LastChangedBy: jhalekas $ $LastChangedDate: 2014-10-28 11:45:50 -0700 (Tue, 28 Oct 2014) $ $LastChangedRevision: 16058 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swic_cdf.pro $

mvn_swia_make_swic_str.pro

PROCEDURE: MVN_SWIA_MAKE_SWIC_STRPURPOSE: Routine to produce an array of structures containing coarse dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIC_STR, Packets, Info, Swic_Str_ArrayINPUTS: Packets: An array of structures containing individual APID80/81 packets Info: An array of structures containing information needed to convert to physical unitsOUTPUTS Swic_Str_Array: An array of structures containing coarse 3d products (Note that for products with 16 or 24 energy steps, the counts are distributed evenly over 2 or 3 steps to produce a product that always has 48 energy steps) $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swic_str.pro $

mvn_swia_make_swif_cdf.pro

PROCEDURE: MVN_SWIA_MAKE_SWIF_CDFPURPOSE: Routine to produce CDF file from SWIA fine survey or archive dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIF_CDF, FILE=FILE, /ARCHIVE, DATA_VERSION = DATA_VERSIONKEYWORDS: FILE: Output file name ARCHIVE: If set, produce a file with archive data rather than survey (default) DATA_VERSION: Data version to put in file (default = '1') $LastChangedBy: jhalekas $ $LastChangedDate: 2014-10-28 11:45:50 -0700 (Tue, 28 Oct 2014) $ $LastChangedRevision: 16058 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swif_cdf.pro $

mvn_swia_make_swif_str.pro

PROCEDURE: MVN_SWIA_MAKE_SWIF_STRPURPOSE: Routine to produce an array of structures containing fine dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIF_STR, ShortPackets=ShortPackets, LongPackets=LongPackets, Info, Swif_Str_ArrayOPTIONAL INPUTS: ShortPackets: An array of structures containing short APID82/83 packets LongPackets: An array of structures containing long APID82/83 packets Info: An array of structures containing information needed to convert to physical unitsOUTPUTS Swif_Str_Array: An array of structures containing coarse 3d products (Note that for 32Ex8Dx6A mode the products are padded with zeros to produce a product that always has 48x12x10 elements) $LastChangedBy: jhalekas $ $LastChangedDate: 2014-01-06 11:51:10 -0800 (Mon, 06 Jan 2014) $ $LastChangedRevision: 13743 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swif_str.pro $

mvn_swia_make_swihsk_str.pro

PROCEDURE: MVN_SWIA_MAKE_SWIHSK_STRPURPOSE: Routine to produce an array of structures containing SWIA HousekeepingAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIHSK_STR, Packets, Info, SwiHSK_Str_ArrayINPUTS: Packets: An array of structures containing individual packets packetsOUTPUTS SwiHSK_Str_Array: An array of structures containing SWIA Housekeeping $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swihsk_str.pro $

mvn_swia_make_swim_cdf.pro

PROCEDURE: MVN_SWIA_MAKE_SWIM_CDFPURPOSE: Routine to produce CDF file from SWIA onboard moment dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIM_CDF, FILE=FILE, DATA_VERSION = DATA_VERSIONKEYWORDS: FILE: Output file name DATA_VERSION: Data version to put in file (default = '1') $LastChangedBy: jhalekas $ $LastChangedDate: 2014-10-28 11:45:50 -0700 (Tue, 28 Oct 2014) $ $LastChangedRevision: 16058 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swim_cdf.pro $

mvn_swia_make_swim_str.pro

PROCEDURE: MVN_SWIA_MAKE_SWIM_STRPURPOSE: Routine to produce an array of structures containing onboard moment dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIM_STR, Packets, Info, Swim_Str_ArrayINPUTS: Packets: An array of structures containing individual APID85 packets Info: An array of structures containing information needed to convert to physical unitsOUTPUTS Swim_Str_Array: An array of structures containing moments in real units $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-25 12:07:32 -0800 (Tue, 25 Nov 2014) $ $LastChangedRevision: 16301 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swim_str.pro $

mvn_swia_make_swis_cdf.pro

PROCEDURE: MVN_SWIA_MAKE_SWIS_CDFPURPOSE: Routine to produce CDF file from SWIA onboard energy spectra dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIS_CDF, FILE=FILE, DATA_VERSION = DATA_VERSIONKEYWORDS: FILE: Output file name DATA_VERSION: Data version to put in file (default = '1') $LastChangedBy: jhalekas $ $LastChangedDate: 2014-10-28 11:45:50 -0700 (Tue, 28 Oct 2014) $ $LastChangedRevision: 16058 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swis_cdf.pro $

mvn_swia_make_swis_str.pro

PROCEDURE: MVN_SWIA_MAKE_SWIS_STRPURPOSE: Routine to produce an array of structures containing spectra dataAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MAKE_SWIS_STR, Packets, Info, Swis_Str_ArrayINPUTS: Packets: An array of structures containing individual APID86 packets Info: An array of structures containing information needed to convert to physical unitsOUTPUTS Swis_Str_Array: An array of structures containing energy spectra $LastChangedBy: jhalekas $ $LastChangedDate: 2014-04-11 13:42:27 -0700 (Fri, 11 Apr 2014) $ $LastChangedRevision: 14811 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_make_swis_str.pro $

mvn_swia_minvar_bv.pro

PROCEDURE: MVN_SWIA_MINVAR_BVPURPOSE: Do minimum variance on magnetic field and rotate velocity to same frameINPUT:KEYWORDS: BDATA: tplot variable for the magnetic field (needs to be same frame as velocity) VDATA: tplot variable for the velocity (needs to be same frame as mag field) TRANGE: time range to do minimum variance (will prompt to choose if not set)AUTHOR: J.

mvn_swia_moment_decom.pro

PROCEDURE: MVN_SWIA_MOMENT_DECOMPURPOSE: Decompress the floating point moment valuesAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_MOMENT_DECOM, Mom, MomoutINPUTS: Mom: An array of floating point moments stored in compressed formOUTPUTS: Momout: Returns the floating point version of Mom $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_moment_decom.pro $

mvn_swia_packet_decode.pro

PROCEDURE: MVN_SWIA_PACKET_DECODEPURPOSE: General purpose routine to decode a series of words according to a provided definitionAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PACKET_DECODE, Message, Decoder, DataINPUTS: Message: An array of words from a packet Decoder: A struct with the decommutator type for each field in DataOUTPUTS: Data: A structure returning the decommutated version of Message $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_packet_decode.pro $

mvn_swia_packet_decompress.pro

FUNCTION: MVN_SWIA_PACKET_DECOMPRESSPURPOSE: Function to decompress a compressed telemetry packet.

mvn_swia_part_moments.pro

PROCEDURE: MVN_SWIA_PART_MOMENTSPURPOSE: Make tplot variables with moments from SWIA 3d data (coarse and/or fine), including average energy flux spectraAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PART_MOMENTS, TYPE = TYPEKEYWORDS: TYPE: Array of types to calculate moments for, out of ['CS','CA','FS','FA','S'] (Coarse survey/archive, Fine survey/archive) - Defaults to all types PHRANGE: Phi range to produce moments for (default 0-360) THRANGE: Theta range to produce moments for (default -50 - 50) ERANGE: Energy range to produce moments for (default 0-30000) MAGT3: Produce temperature in magnetic field coordinates (you need to have run 'mvn_swia_add_magf' first) $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-14 14:00:10 -0800 (Fri, 14 Nov 2014) $ $LastChangedRevision: 16187 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_part_moments.pro $

mvn_swia_penprot.pro

PROCEDURE: MVN_SWIA_PENPROTPURPOSE: Routine to determine density and velocity of penetrating protons at periapsisAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PENPROT, REG = REGINPUTS:KEYWORDS: REG: region structure from 'mvn_swia_regid' NPO: number of determinations per orbit $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-20 06:12:41 -0800 (Thu, 20 Nov 2014) $ $LastChangedRevision: 16252 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_penprot.pro $

mvn_swia_penprot_dir.pro

PROCEDURE: MVN_SWIA_PENPROT_DIRPURPOSE: Routine to determine density and velocity of penetrating protons at periapsis Uses directional spectra to better filter out penetrating proton populationAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PENPROT_DIR, REG = REG, NPO = NPO, /ARCHIVEINPUTS:KEYWORDS: REG: region structure from 'mvn_swia_regid' NPO: number of determinations per orbit ARCHIVE: use archive data $LastChangedBy: jhalekas $ $LastChangedDate: 2014-12-08 13:10:18 -0800 (Mon, 08 Dec 2014) $ $LastChangedRevision: 16405 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_penprot_dir.pro $

mvn_swia_plot_orb_whisk.pro

PROCEDURE: MVN_SWIA_PLOT_ORB_WHISKPURPOSE: Routine to plot whiskers of any quantity (default: magnetic field) on the orbitAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PLOT_ORB_WHISKINPUTS:KEYWORDS: TR: Time range (uses current tplot if not set) FREQ: How much to decimate the whisker quantity XRANGE, YRANGE, ZRANGE: Obvious LEN: Whisker length (multiplied by whisker magnitude) BNORM: Normalize by length of whisker (otherwise all have same length) PDATA: Tplot variable for position data (defaults to MSO position) BDATA: Tplot variable for whisker data (defaults to MSO B) $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-17 09:08:29 -0800 (Mon, 17 Nov 2014) $ $LastChangedRevision: 16195 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_plot_orb_whisk.pro $

mvn_swia_plot_packets.pro

PROCEDURE: MVN_SWIA_PLOT_PACKETSPURPOSE: Routine to generate Tplot variables from SWIA packets (arrays of structures) (Will not be typically used once I have everything stored in common blocks) (Does not work well when modes change)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_PLOT_PACKETS, /DECOMP, APID29=APID29, APID80=APID80, APID82SHORT=APID82SHORT, APID82LONG=APID82LONG, APID84=APID84, APID85=APID85, APID86=APID86, APID87=APID87KEYWORDS: DECOMP: Log-decompress all countsOPTIONAL INPUTS: APID29: Housekeeping packets APID80: Coarse Archive/Survey packets APID82SHORT: Fine Archive/Survey packets (small version) APID82LONG: Fine Archive/Survey packets (large version) APID84: Raw Survey APID85: Moments APID86: Spectra APID87: Fast Housekeeping $LastChangedBy: jhalekas $ $LastChangedDate: 2013-03-05 12:01:26 -0800 (Tue, 05 Mar 2013) $ $LastChangedRevision: 11695 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_plot_packets.pro $

mvn_swia_plot_packets_d.pro

PROCEDURE: MVN_SWIA_PLOT_PACKETS_DPURPOSE: Routine to generate Tplot variables from SWIA packets (arrays of structures) Unlike MVN_SWIA_PLOT_PACKETS, everything is plotted on a common 4s resolution grid, which works a lot better when modes change, etc.

mvn_swia_protonalphamoms.pro

PROCEDURE: MVN_SWIA_PROTONALPHAMOMSPURPOSE: Routine to compute approximately the proton and alpha moments from fine distributions.

mvn_swia_protonalphamoms_mag.pro

PROCEDURE: MVN_SWIA_PROTONALPHAMOMS_MAGPURPOSE: Routine to compute approximately the proton and alpha moments from fine distributions.

mvn_swia_read_compressed_packets.pro

PROCEDURE: MVN_SWIA_READ_COMPRESSED_PACKETSPURPOSE: Routine to read in compressed SWIA packets from any telemetry fileAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_READ_COMPRESSED_PACKETS, File, /SYNC, /R29, /R80, /R81, /R82S, /R82L, /R83S, /R83L, /R84, /R85, /R86, /R87, APID29=APID29, APID80=APID80, APID81=APID81, APID82SHORT=APID82SHORT, APID82LONG=APID82LONG, APID83SHORT=APID83SHORT, APID83LONG=APID83LONG, APID84=APID84, APID85=APID85, APID86=APID86, APID87=APID87INPUTS: File: A filename to read packets fromKEYWORDS: R29-R87: Set to one to read in each type of packet (saves time if not set) SYNC: Synchronize on spacecraft header and checksum (saves lots of time)OPTIONAL OUTPUTS: APID29: Housekeeping APID80: Coarse Survey APID81: Coarse Archive APID82SHORT: Fine Survey (small version) APID82LONG: Fine Survey(large version) APID83SHORT: Fine Archive (small version) APID83LONG: Fine Archive(large version) APID84: Raw Survey APID85: Moments APID86: Spectra APID87: Fast Housekeeping $LastChangedBy: jhalekas $ $LastChangedDate: 2013-09-09 08:08:13 -0700 (Mon, 09 Sep 2013) $ $LastChangedRevision: 12973 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_read_compressed_packets.pro $

mvn_swia_read_packets.pro

PROCEDURE: MVN_SWIA_READ_PACKETSPURPOSE: Routine to read in uncompressed SWIA packets from any telemetry file (Not typically used anymore now that we routinely compress packets)AUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_READ_PACKETS, File, APID29=APID29, APID80=APID80, APID81=APID81, APID82SHORT=APID82SHORT, APID82LONG=APID82LONG, APID83SHORT=APID83SHORT, APID83LONG=APID83LONG, APID84=APID84, APID85=APID85, APID86=APID86, APID87=APID87INPUTS: File: A filename to read packets fromOPTIONAL OUTPUTS: APID29: Housekeeping APID80: Coarse Survey APID81: Coarse Archive APID82SHORT: Fine Survey (small version) APID82LONG: Fine Survey(large version) APID83SHORT: Fine Archive (small version) APID83LONG: Fine Archive(large version) APID84: Raw Survey APID85: Moments APID86: Spectra APID87: Fast Housekeeping $LastChangedBy: jhalekas $ $LastChangedDate: 2013-03-05 12:01:26 -0800 (Tue, 05 Mar 2013) $ $LastChangedRevision: 11695 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_read_packets.pro $

mvn_swia_regid.pro

PROCEDURE: MVN_SWIA_REGIDPURPOSE: Routine to determine region of the Mars environment from SWIA and MAG data.

mvn_swia_slice2d_snap.pro

PROCEDURE: mvn_swia_slice2d_snap PURPOSE: Plots 2D slice for the times and data types selected by cursor.

mvn_swia_subword.pro

FUNCTION: MVN_SWIA_SUBWORDPURPOSE: Function to return a portion of a wordAUTHOR: Jasper HalekasCALLING SEQUENCE: Result = MVN_SWIA_SUBWORD(Word,BIT1 = 7, BIT2 = 0)INPUTS: Word: the input wordKEYWORDS: BIT1: The bit to start from (inclusive), from 15 to 0, default 15 BIT2: The bit to end at (inclusive), from 15 to 0, default 0OUTPUTS: Returns the value formed by the bits from ['bit1','bit2'] of 'word' $LastChangedBy: jhalekas $ $LastChangedDate: 2013-06-18 21:19:24 -0700 (Tue, 18 Jun 2013) $ $LastChangedRevision: 12551 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_subword.pro $

mvn_swia_swindave.pro

PROCEDURE: MVN_SWIA_SWINDAVEPURPOSE: Routine to determine density and velocity of undisturbed upstream solar windAUTHOR: Jasper HalekasCALLING SEQUENCE: MVN_SWIA_SWINDAVE, REG = REGINPUTS:KEYWORDS: REG: region structure from 'mvn_swia_regid' NPO: number of determinations per orbit $LastChangedBy: jhalekas $ $LastChangedDate: 2014-11-19 15:39:14 -0800 (Wed, 19 Nov 2014) $ $LastChangedRevision: 16250 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/swia/mvn_swia_swindave.pro $