Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/maven/sta/

Contents

.pro files

mav_apid_sta_handler.pro
mav_apid_sta_rate_surv_decom.pro
mav_sta_apid_0xda_Rate3_decom.pro
mav_sta_apid_0xdb_mhist_decom.pro
mav_sta_apid_decom.pro
mav_sta_checksum_decom.pro
mav_sta_crib.pro

PROCEDURE: mvn_sta_cribPURPOSE: crib file to demonstrate static functions and test softwareINPUT:KEYWORDS:CREATED BY: J.

mav_sta_hkp_decom.pro
mav_sta_mass_hist_avg.pro

PROCEDURE: mav_sta_mass_hist_avg,tp=tpPURPOSE: makes a tplot structure from 'STA_MASSHIST_MASS' with only 64 mass binsCREATED BY: J.

mav_sta_masshist_decom.pro
mav_sta_misg_decom.pro
mav_sta_msg_handler.pro
mav_sta_p1_misg_decom.pro
mav_sta_p2_misg_decom.pro
mav_sta_p3_misg_decom.pro
mav_sta_p4_misg_decom.pro
mav_sta_px_decom.pro
mav_sta_rates_decom.pro
mav_sta_rawevent_decom.pro
mvn_sta_apid_decom.pro
mvn_sta_apid_handler.pro
mvn_sta_cblk_load.pro

PROCEDURE: mvn_sta_cblk_load,pathname=pathname,source=sourcePURPOSE: To generate quicklook data plots and a tplot save fileINPUT:KEYWORDS:CREATED BY: J.

mvn_sta_cmn_concat.pro

NAME: mvn_sta_cmn_concatPURPOSE: concatenates two MAVEN STA commonblick structuresCALLING SEQUENCE: dat = mvn_sta_cmn_concat(dat1, dat2)INPUT: dat1, dat2 = two MAVEN STA data structures: e.g., PROJECT_NAME STRING 'MAVEN' SPACECRAFT STRING '0' DATA_NAME STRING 'C6 Energy-Mass' APID STRING 'C6' UNITS_NAME STRING 'counts' UNITS_PROCEDURE STRING 'mvn_sta_convert_units' VALID INT Array[21600] QUALITY_FLAG INT Array[21600] TIME DOUBLE Array[21600] END_TIME DOUBLE Array[21600] DELTA_T DOUBLE Array[21600] INTEG_T DOUBLE Array[21600] MD INT Array[21600] MODE INT Array[21600] RATE INT Array[21600] SWP_IND INT Array[21600] MLUT_IND INT Array[21600] EFF_IND INT Array[21600] ATT_IND INT Array[21600] NENERGY INT 32 ENERGY FLOAT Array[9, 32, 64] DENERGY FLOAT Array[9, 32, 64] NBINS INT 1 BINS INT Array[1] NDEF INT 1 NANODE INT 1 THETA FLOAT 0.00000 DTHETA FLOAT 90.0000 PHI FLOAT 0.00000 DPHI FLOAT 360.000 DOMEGA FLOAT 8.88577 GF FLOAT Array[9, 32, 4] EFF FLOAT Array[128, 32, 64] GEOM_FACTOR FLOAT 0.000195673 NMASS INT 64 MASS FLOAT 0.0104389 MASS_ARR FLOAT Array[9, 32, 64] TOF_ARR FLOAT Array[5, 32, 64] TWT_ARR FLOAT Array[5, 32, 64] CHARGE FLOAT 1.00000 SC_POT FLOAT Array[21600] MAGF FLOAT Array[21600, 3] QUAT_SC FLOAT Array[21600, 4] QUAT_MSO FLOAT Array[21600, 4] BINS_SC LONG Array[21600] POS_SC_MSO FLOAT Array[21600, 3] BKG FLOAT Array[21600, 32, 64] DEAD DOUBLE Array[21600, 32, 64] DATA DOUBLE Array[21600, 32, 64]OUTPUT: dat = a single structure concatenatedHISTORY: 19-may-2014, jmm, jimm@ssl.berkeley.edu $LastChangedBy: jimm $ $LastChangedDate: 2014-06-16 17:17:57 -0700 (Mon, 16 Jun 2014) $ $LastChangedRevision: 15383 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/sta/mvn_sta_cmn_concat.pro $

mvn_sta_cmn_l2read.pro

NAME: mvn_sta_cmn_l2readPURPOSE: Reads an L2 file and fills a common block structure.

mvn_sta_cmn_l2vararr.pro

NAME: mvn_sta_cmn_l2vararrPURPOSE: Returns an array with common block variable names for the input apid.

mvn_sta_cmn_tclip.pro

NAME: mvn_sta_cmn_tclipPURPOSE: applies a trange to a STATIC common block structureCALLING SEQUENCE: dat = mvn_sta_cmn_tclip(dat, trange)INPUT: dat1 = a MAVEN STA data structure: e.g., PROJECT_NAME STRING 'MAVEN' SPACECRAFT STRING '0' DATA_NAME STRING 'C6 Energy-Mass' APID STRING 'C6' UNITS_NAME STRING 'counts' UNITS_PROCEDURE STRING 'mvn_sta_convert_units' VALID INT Array[21600] QUALITY_FLAG INT Array[21600] TIME DOUBLE Array[21600] END_TIME DOUBLE Array[21600] DELTA_T DOUBLE Array[21600] INTEG_T DOUBLE Array[21600] MD INT Array[21600] MODE INT Array[21600] RATE INT Array[21600] SWP_IND INT Array[21600] MLUT_IND INT Array[21600] EFF_IND INT Array[21600] ATT_IND INT Array[21600] NENERGY INT 32 ENERGY FLOAT Array[9, 32, 64] DENERGY FLOAT Array[9, 32, 64] NBINS INT 1 BINS INT Array[1] NDEF INT 1 NANODE INT 1 THETA FLOAT 0.00000 DTHETA FLOAT 90.0000 PHI FLOAT 0.00000 DPHI FLOAT 360.000 DOMEGA FLOAT 8.88577 GF FLOAT Array[9, 32, 4] EFF FLOAT Array[128, 32, 64] GEOM_FACTOR FLOAT 0.000195673 NMASS INT 64 MASS FLOAT 0.0104389 MASS_ARR FLOAT Array[9, 32, 64] TOF_ARR FLOAT Array[5, 32, 64] TWT_ARR FLOAT Array[5, 32, 64] CHARGE FLOAT 1.00000 SC_POT FLOAT Array[21600] MAGF FLOAT Array[21600, 3] QUAT_SC FLOAT Array[21600, 4] QUAT_MSO FLOAT Array[21600, 4] BINS_SC LONG Array[21600] POS_SC_MSO FLOAT Array[21600, 3] BKG FLOAT Array[21600, 32, 64] DEAD FLOAT Array[21600, 32, 64] DATA DOUBLE Array[21600, 32, 64]OUTPUT: dat = structure with data only in the time rangeNOTES: Only will work if the reocrd varying arrays are 5D or lessHISTORY: 19-may-2014, jmm, jimm@ssl.berkeley.edu $LastChangedBy: jimm $ $LastChangedDate: 2014-10-09 15:56:05 -0700 (Thu, 09 Oct 2014) $ $LastChangedRevision: 15966 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/maven/sta/mvn_sta_cmn_tclip.pro $

mvn_sta_crib.pro

PROCEDURE: mvn_sta_cribPURPOSE: crib file to demonstrate static functions and test softwareINPUT:KEYWORDS:CREATED BY: J.

mvn_sta_gen_kp.pro

PROCEDURE: mvn_sta_gen_kp,pathname=pathname,files=files,test=test,def_min=def_min,all=allPURPOSE: To generate tplotsave files of static KP data, if pathname or files not set, will query the userINPUT:KEYWORDS: all 0/1 if not set, housekeeping and raw variables 'mvn_STA_*' are deleted from tplot after data is loaded test 1/0 If set, will make plots while running and makepng files def_min float minimum number of counts before KP data set to NANsCREATED BY: J.

mvn_sta_gen_ql.pro

PROCEDURE: mvn_sta_gen_ql,pathname=pathname,files=files,mag=mag,all=allPURPOSE: To generate quicklook data plots and a tplot save file, assumes "timespan" has been runINPUT:KEYWORDS: all 0/1 if not set, housekeeping and raw variables 'mvn_STA_*' are deleted from tplot after data is loaded mag 0/1 if set, mag data is loadedCREATED BY: J.

mvn_sta_handler.pro
mvn_sta_hkp_cal.pro

PROCEDURE: mvn_sta_hkp_calPURPOSE: Calibrates STATIC tplot housekeeping generated by mav_sta_misg_decom.proINPUT: time: dbl time of data to be returnedKEYWORDS:CREATED BY: J.

mvn_sta_hkp_decom.pro
mvn_sta_l0_load.pro

PROCEDURE: mvn_sta_l0_load,pathname=pathname,trange=trange,files=files,mag=mag,pfdpu=pfdpu,sep=sep,lpw=lpw,RT=RT,download_only=download_onlyPURPOSE: To generate quicklook data plots and a tplot save fileINPUT:KEYWORDS: all 0/1 if not set, housekeeping and raw variables 'mvn_STA_*' are deleted from tplot after data is loadedCREATED BY: J.

mvn_sta_l2_crib.pro

NAME:mvn_sta_l2_cribPURPOSE: Crib for loading MAVEN L2 STATIC data

mvn_sta_l2_gen_kp.pro

PROCEDURE: mvn_sta_l2_gen_kpPURPOSE: To generate tplotsave files of static KP data, if pathname or files not set, will query the userINPUT:KEYWORDS: test 1/0 If set, will make plots while running and makepng files def_min float minimum number of counts before KP data set to NANsCREATED BY: J.

mvn_sta_l2_load.pro

NAME: mvn_sta_l2_loadPURPOSE: Loads MVN L2 data for a given file(s), or time_rangeCALLING SEQUENCE: mvn_sta_l2_load, files = files, trange=trange, sta_apid=sta_apidINPUT: All via keyword, if none are set, then the output of timerange() is used, which may prompt for a time intervalKEYWORDS: files = if set, then read from these files, otherwise, files are figured out from the time range.

mvn_sta_l2_tplot.pro

PROCEDURE: mvn_sta_l2_tplot,all=all,units=units,apids=apids,test=test,gf_nor=gf_norPURPOSE: Creates tplot data from the STATIC common blocksINPUT:KEYWORDS: all 0/1 if not set, deletes all currently stored STATIC tplot structures (mvn_sta* and mvn_STA*) before generating new structures generally this is only used for code diagnostics units string select the units for generated tplot structures - not working yet apids strarr if set, selectes subset of apids to generate tplot structures - not working yet test 0/1 if set, diagnostic tplot structures (APIDs: 2A,d6,d7,d8,d9,da) are made generates "mode" and "rate" tplot structures for all APIDs, default only generates c6 mode and rate tplot structures gf_nor 0/1 if set, keyword for testing - not working yetCREATED BY: J.

mvn_sta_pfdpu_hv_turnon_plot.pro

PROCEDURE: mvn_sta_pfdpu_hv_turnon_plot,pathname=pathname,all=all,apids=apidsPURPOSE: Loads and Plots STATIC data for HV turnonINPUT:KEYWORDS: pathname string if not set, then pathname = 'maven/dpu/prelaunch/live/flight/Split_At_20130524_224251/initial/common_block.dat' all 0/1 if set, then all the temporary tplot structures generated by the decommutator are kept apids strarr if set, selectes subset of apids to generate tplot structuresCREATED BY: J.

mvn_sta_prod_cal.pro

PROCEDURE: mvn_sta_prod_cal,all=all,units=units,apids=apids,test=test,gf_nor=gf_norPURPOSE: Calibrates STATIC data products generated by mvn_sta_apid_handler.proINPUT:KEYWORDS: all 0/1 if not set, then raw tplot structures are deleted units string select the units for generated tplot structures apids strarr if set, selectes subset of apids to generate tplot structures test 0/1 if set, prints out MLUT check gf_nor 0/1 if set, keyword for testing mechanical attenuator - ignores attM open or closedCREATED BY: J.

spp_static_read.pro
sta_prod_cal.pro

PROCEDURE: sta_prod_cal,all=allPURPOSE: Calibrates STATIC data products generated by mav_apid_sta_handler.proINPUT:KEYWORDS:CREATED BY: J.