Directory: projects/goes/

Contents

.pro files

goes_combine_tdata.pro

Procedure: goes_combine_tdata Purpose: The procedures in this library combine multi-dimensional GOES tplot variables and ensure the combined tplot variables contain the standard data attributes structure required for TDAS/SPEDAS data processing and analysis For instance, GOES magnetometer data can be loaded as 'he', 'hn', 'hp', goes_combine_mag_data will find and combine these into a single 'g[8-15]_h_enp' variable, with the coordinates set to 'ENP' and units set to 'nT' in the data attributes structure Notes: If the get_support_data keyword isn't set, these routines will delete the tplot variables corresponding to the support data (i.e., variables ending in *_NUM_PTS and *_QUAL_FLAG).

goes_config_filedir.pro

Function: goes_config_filedir.proPurpose: Get the applications user directory for SPEDAS$LastChangedBy: egrimes $$LastChangedDate: 2014-03-20 14:33:46 -0700 (Thu, 20 Mar 2014) $$LastChangedRevision: 14616 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/goes/goes_config_filedir.pro $

goes_init.pro

Procedure: goes_init Purpose: Initializes system variables for GOES data.

goes_lib.pro

Procedure: goes_lib Purpose: Provides an interface to various routines for postprocessing GOES data Notes: Most of these routines were provided by Juan Rodriguez, CIRES with modifications by A.

goes_load_crib_sheet.pro

Procedure: goes_load_crib_sheet Purpose: Example of loading GOES data using the command line Notes: The GOES routines have their own configuration routines, since the data products are in a different location than the THEMIS products.

goes_load_data.pro

Procedure: goes_load_data Keywords: trange: time range of interest datatype: type of GOES data to be loaded.

goes_load_pos.pro

Procedure: goes_load_pos Purpose: Loads ephemeris data for GOES spacecraft using SSCWeb Keywords: trange: Standard time range of interest probe: Number of the GOES spacecraft, i.e., probes=15 or probes='15' coord_sys: Coordinate system for the requested ephemeris data; defaults to GEI (geij2000) Valid coordinate systems are: geo, gm, gse, gsm, sm, geitod, geij2000 Example: To load the GOES-10 position data for the month of January, 2008, in GSM coordinates: goes_pos = goes_load_pos(trange=['2008-01-01', '2008-01-31'], probe=10, coord_sys='gsm') help, /st, goes_pos goes_pos is set to a structure containing the position [x, y, z], time and coordinate system.

goes_overview_plot.pro

Procedure: goes_overview_plot Purpose: Generates daily overview plots for GOES data Keywords: date: start date for the overview plot duration: duration of the overview plot, in days; defaults to 1-day directory: local directory to save the overview plots to (should end with '/' or '\') device: change the plot device for cron plotting (for cron use device = 'z') geopack_lshell: calculate L-shell by tracing field lines to the equator instead of using the dipole assumption skip_ae_idx: set this keyword to skip downloading/plotting AE data error: 1 indicates an error, 0 for no error * Keywords specific to creating overview plots in the GUI: gui_overplot: overview plot was created in the GUI oplot_calls: pointer to an int for tracking calls to overview plots - for avoiding overwriting tplot data already loaded during this session Notes: For GOES 13-15: Panel 1: Kyoto AE, THEMIS AE Panel 2: B components in SM coordinates (colored), B magnitude (black) Panel 3: delta B components, (B components subtracted from the IGRF) Panel 4: MAGPD, line plot of protons by energy channel (omni directional) Panel 5: EPEAD, line plot of e- by energy channel (omni directional) Panel 6: MAGED, line plot of e- by energy channel (omni directional) Panel 7: EPEAD high energy protons by energy channel (omni directional) Panel 8: X-ray, short wavelength and long wavelength For GOES 8-12: Panel 1: Kyoto AE, THEMIS AE Panel 2: B components in SM coordinates (colored), B magnitude (black) Panel 3: delta B components, (B components subtracted from the IGRF) Panel 4: EPS, line plot of protons measured by the telescope detector by energy channel Panel 5: EPS, line plot of integral electron flux by energy channel Panel 6: EPS, line plot of protons measured by the dome detector by energy channel Panel 7: X-ray, short wavelength and long wavelength $LastChangedBy: aaflores $ $LastChangedDate: 2014-03-20 15:10:15 -0700 (Thu, 20 Mar 2014) $ $LastChangedRevision: 14619 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/goes/goes_overview_plot.pro $

goes_overview_plot_wrapper.pro

NAME: goes_overview_plot_wrapperPURPOSE: Generates daily overview plots for GOES data - wrapper for goes_overview_plotKEYWORDS: probes: array of goes probe numbers, if probe='' then probe=['10','11','12','13','14','15'] date_start: begin processing at this date (eg.

goes_read_config.pro

NAME: goes_read_configPURPOSE: Reads the goes_config fileCALLING SEQUENCE: cstruct = goes_read_config()INPUT: none, the filename is hardcoded, 'goes_config.txt',and is s put in a folder given by the routine goes_config_filedir, that uses the IDL routine app_user_dir to create/obtain it: my linux example: /disks/ice/home/jimm/.idl/themis/thm_config-4-linuxOUTPUT: cstruct = a structure with the changeable fields of the !istp structure Copied from thm_read_config and tt2000_read_config lphilpott 20-jun-2012$LastChangedBy: egrimes $$LastChangedDate: 2014-02-28 14:10:44 -0800 (Fri, 28 Feb 2014) $$LastChangedRevision: 14467 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/goes/goes_read_config.pro $

goes_write_config.pro

NAME: goes_write_configPURPOSE: Writes the goes_config fileCALLING SEQUENCE: goes_write_config, copy=copyINPUT: none, the filename is hardcoded, 'goes_config.txt',and is s put in a folder given by the routine thm_config_filedir, that uses the IDL routine app_user_dir to create/obtain it: my linux example: /disks/ice/home/jimm/.idl/themis/thm_config-4-linuxOUTPUT: the file is written, and a copy of any old file is generatedKEYWORD: copy = if set, the file is read in and a copy with the !stime appended is written outHISTORY: 17-may-2007, jmm, jimm@ssl.berkeley.edu 18-mar-2009, jmm, fixed problem with writing string representations of byte values$LastChangedBy: egrimes $$LastChangedDate: 2014-03-20 14:33:46 -0700 (Thu, 20 Mar 2014) $$LastChangedRevision: 14616 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/goes/goes_write_config.pro $

goesstruct_to_cdfstruct.pro

Function: GOESstruct_to_cdfstruct Purpose: Converts an IDL structure returned from a GOES netCDF file into an IDL structure that can be passed to cdf_info_to_tplot Input: netCDFi: GOES IDL structure from ncdf_load_vars Output: IDL structure that follows the SPDF CDF standard (at least enough so to be read by cdf_info_to_tplot) $LastChangedBy: egrimes $ $LastChangedDate: 2014-02-28 14:10:44 -0800 (Fri, 28 Feb 2014) $ $LastChangedRevision: 14467 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/goes/goesstruct_to_cdfstruct.pro $