Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/maven/KP_Toolkit/

Contents

.pro files

mvn_kp_3d.pro

Interactive 3D visualization of MAVEN spacecraft trajectory and insitu/iuvs KP parameters.

mvn_kp_add_data.pro

A simple routine for adding a SINGLE user defined data field to the INSITU KP data structure This may get generalized in the future to allow multiple additions :Params: kp_data : in, required, type="structure" the original insitu KP data structure data_name : in, required, type="string" the name of the new data to be added onto the USER substructure data_in : in, required, type="dblarr" the data array that you are adding onto the structure output : out, required, type="structure" the name of the newly created data structure

mvn_kp_altplot.pro

THIS ROUTINE PLOTS ONE OR MORE ALITUDE PROFILES FROM THE INSITU KP DATA STRUCTURE :Params: kp_data: in, required, type=structure the INSITU KP data structure from which to plot data parameter: in, required, type=strarr,intarr the INSITU kp data fields to plot, maybe an integer or string array for multiple choices :Keywords: time: in, optional, type= if selected, plots only the given times from the data set list: in, optional, type=boolean if selected, will list the KP data fields included in kp_data range: in, optional, type=boolean if selected, will list the beginning and end times of kp_data title:in, optional, type=string a optional title string for the plot thick: in, optional, type=integer the thickness of the altitude profile lines symbol: in, optional, type=integer the idl symbol to be used in plotting linestyle: in, optional, type=integer the idl linestyle to be used in plotting directgraphic: in, optional, type=boolean if selected, will override teh default Graphics plot procedure and use direct graphics instead log: in, optional, type=boolean if selected, will plot the altitude profiles in log/linear format

mvn_kp_bin.pro

HERE RESTS THE ONE SENTENCE ROUTINE DESCRIPTION :Params: bounds : in, required, type="lonarr(ndims, 3)" bounds :Keywords: start : out, optional, type=lonarr(ndims) input for start argument to H5S_SELECT_HYPERSLAB count : out, optional, type=lonarr(ndims) input for count argument to H5S_SELECT_HYPERSLAB block : out, optional, type=lonarr(ndims) input for block keyword to H5S_SELECT_HYPERSLAB stride : out, optional, type=lonarr(ndims) input for stride keyword to H5S_SELECT_HYPERSLAB

mvn_kp_create_insitu_save.pro
mvn_kp_download_files.pro

:Name: mvn_kp_download_files :Author: John Martin :Description: Download in situ or IUVS kp data files from the Maven SDC web service.

mvn_kp_insitu_search.pro

:Name: mvn_kp_insitu_search :Author: Kris Larsen & John Martin :Description: Searches input in situ KP data structure based on min and/or max search parameters :Params: insitu_in: in, required, type=array of structures in situ KP data structure (data structure output from mvn_kp_read) insitu_out: out, required, type=array of structures output KP data structure containing datat that met all search criteria :Keywords: list: in, optional, type=boolean List out possible tags names to search (& index identifiers associated with tags).

mvn_kp_iuvs_corona.pro

HERE RESTS THE ONE SENTENCE ROUTINE DESCRIPTION :Params: bounds : in, required, type="lonarr(ndims, 3)" bounds :Keywords: start : out, optional, type=lonarr(ndims) input for start argument to H5S_SELECT_HYPERSLAB count : out, optional, type=lonarr(ndims) input for count argument to H5S_SELECT_HYPERSLAB block : out, optional, type=lonarr(ndims) input for block keyword to H5S_SELECT_HYPERSLAB stride : out, optional, type=lonarr(ndims) input for stride keyword to H5S_SELECT_HYPERSLAB

mvn_kp_iuvs_limb.pro

This routine plots the IUVS PERIAPSE limb-scan KP data.

mvn_kp_iuvs_search.pro

:Name: mvn_kp_iuvs_search :Author: Kris Larsen & John Martin :Description: Searches input IUVS KP data structure based on min and/or max search parameters :Params: iuvs_in: in, required, type=array of structures IUVS KP data structure (data structure output from mvn_kp_read) iuvs_out: out, required, type=array of structures output KP data structure containing datat that met all search criteria :Keywords: list: in, optional, type=boolean List out possible tags names to search (& index identifiers associated with tags).

mvn_kp_map2d.pro

THIS ROUTINE PLOTS THE ORBITAL TRACK OF MAVEN ON VARIOUS BASEMAPS, COLORED BY THE SELECTED DATA PARAMETER :Params: kp_data: in, required, type=structure the INSITU KP data structure from which to plot data :Keywords: iuvs: in, optional, type=structure optional IUVS data structure for overplotting of relevant parameters time: in, optional, type=strarr(2) an array that defines the start and end times to be plotted orbit: in, optional, type=intarr(2) an array that defines the start and end orbit indices to be plotted parameter: in, optional, type=integer/string the name or index of the insitu parameter to be plotted (if not selected, only orbital track shown) list: in, optional, type=boolean if selected, will list the KP data fields included in kp_data range: in, optional, type=boolean if selected, will list the beginning and end times of kp_data basemap: in, optional, type=string the name of the basemap to display (MDIM, MOLA, MOLA_BW, MAG).

mvn_kp_plot.pro

THIS ROUTINE PLOTS ONE OR MORE ALITUDE PROFILES FROM THE INSITU KP DATA STRUCTURE :Params: kp_data: in, required, type=structure the INSITU KP data structure from which to plot data parameter: in, required, type=strarr,intarr the INSITU kp data fields to plot, maybe an integer or string array for multiple choices :Keywords: time: in, optional, type= if selected, plots only the given times from the data set list: in, optional, type=boolean if selected, will list the KP data fields included in kp_data range: in, optional, type=boolean if selected, will list the beginning and end times of kp_data title:in, optional, type=string a optional title string for the plot thick: in, optional, type=integer the thickness of the altitude profile lines symbol: in, optional, type=integer the idl symbol to be used in plotting linestyle: in, optional, type=integer the idl linestyle to be used in plotting directgraphic: in, optional, type=boolean if selected, will override teh default Graphics plot procedure and use direct graphics instead log: in, optional, type=boolean if selected, will plot the altitude profiles in log/linear format

mvn_kp_read.pro

:Name: mvn_kp_read :Author: Kris Larsen & John Martin :Description: Read local Maven KP data files into memory.

mvn_kp_standards.pro

HERE RESTS THE ONE SENTENCE ROUTINE DESCRIPTION :Params: bounds : in, required, type="lonarr(ndims, 3)" bounds :Keywords: start : out, optional, type=lonarr(ndims) input for start argument to H5S_SELECT_HYPERSLAB count : out, optional, type=lonarr(ndims) input for count argument to H5S_SELECT_HYPERSLAB block : out, optional, type=lonarr(ndims) input for block keyword to H5S_SELECT_HYPERSLAB stride : out, optional, type=lonarr(ndims) input for stride keyword to H5S_SELECT_HYPERSLAB

mvn_kp_tplot.pro

A WRAPPER ROUTINE TO INTERFACE WITH THE BERKELEY TPLOT CODE :Params: kp_data: in, required, type=structure the INSITU KP data structure from which to plot data field: in, required, type=strarr,intarr the INSITU kp data fields to plot, maybe an integer or string array for multiple choices :Keywords: list: in, optional, type=boolean if selected, will list the KP data fields included in kp_data range: in, optional, type=boolean if selected, will list the beginning and end times of kp_data altitude: in, optional, type=boolean if selected, will inclue altitude on the xaxis along with time ytitles: in, optional, type=strarr if included, this array allows the user to define the yaxis titles as they like title: in, optional, type=string if included, this provides an overall title to the plot window