Directory: projects/themis/ground/

Contents

.pro files

thm_alt_stackplot.pro

NAME: thm_alt_stackplot.pro PURPOSE: To create 3 PNG files displaying the H,D and Z components of the magnetic field from multiple GBO stations out of GMAG data that is stored in CDF file.

thm_asi_create_mosaic.pro

NAME: THM_ASI_CREATE_MOSAIC PURPOSE: create mosaic with all THEMIS ASI CATEGORY: None CALLING SEQUENCE: THM_ASI_CREATE_MOSAIC,time INPUTS: Time like '2006-01-01/05:00:00' OPTIONAL INPUTS: None KEYWORD PARAMETERS: cal_files calibration files if they do not need to be read pgm_file do not read CDF, but pgm-files verbose print some diagnostics insert insert stop before end of program gif_out create a gif-file gif_dir directory for gif-output exclude string of station names that should not be plotted show string of station names that should only be plotted minval minimum value for black maxval maximum value for white minimum_elevation minimum elevation to plot in degrees mask mask certain parts of image scale scale for map set central_lon geographic longitude of center of plot central_lat geographic latitude of center of plot rotation rotate map projection projection for map set, MAP_PROJ_INFO, PROJ_NAMES=names color_continent shade of continent fill color_background shade of background zbuffer do in z-buffer, not on the screen cursor finish with cursor info, loop if cursor>1 window set window number xsize xsize of window ysize ysize of window position=position position of plot on window (normal coordinates) noerase=noerase do not erase current window (no effect if {x,y}size set keep_z keep z-buffer open for further plotting no_grid=no_grid do not plot geomagnetic grid no_midnight=no_midnight do not plot midnight meridian no_label do not label mosaic with date and time add_plot stop because we want to add something force_map plot map even if there are no images xy_pos xy position location mark geographic location [lo,la] track1 mark geographic location [lo,la] track2 mark geographic location [lo,la] top top color to be used for polyfill no_color do not load color table, use existing xy_cursor create array of cursor selected values to pass to upper program ssize size of symbol for location sym_color color of location stoptime create multiple mosaics timestep time steps for multiple mosaics in seconds OUTPUTS: None OPTIONAL OUTPUTS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: None EXAMPLE: THM_ASI_CREATE_MOSAIC,'2006-01-01/05:00:00' THM_ASI_CREATE_MOSAIC,'2007-03-01/04:00:00',/thumb,exclude='ekat' MODIFICATION HISTORY: Written by: Harald Frey, 02/06/2007 based on example from Donovan/Jackel 2007-03-15, hfrey, thumbnails, keyword exclude 2007-03-27, hfrey, special treatment for not mapped thumbsnails 2007-12-21, jmm, added explicit set_plot,'z' for zbuffer 2008-07-21, jmm, added gif_dir, for output directory option 2009-06-17, hfrey, a few additions to make my life easier 2009-11-10, cgabrielse, added xy_cursor keyword for sending cursor values up level 2012-07-02, jmm, Added color_annotation keyword NOTES: VERSION: $LastChangedBy: hfrey $ $LastChangedDate: 2014-01-07 12:17:57 -0800 (Tue, 07 Jan 2014) $ $LastChangedRevision: 13811 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_asi_create_mosaic.pro $

thm_asi_merge_mosaic.pro

NAME: THM_ASI_MERGE_MOSAIC PURPOSE: create mosaic with all THEMIS ASI CATEGORY: None CALLING SEQUENCE: THM_ASI_MERGE_MOSAIC,time INPUTS: Time like '2006-01-01/05:00:00' OPTIONAL INPUTS: None KEYWORD PARAMETERS: cal_files calibration files if they do not need to be read pgm_file do not read CDF, but pgm-files verbose print some diagnostics insert insert stop before end of program gif_out create a gif-file gif_dir directory for gif-output exclude string of station names that should not be plotted show string of station names that should only be plotted minval minimum value for black maxval maximum value for white minimum_elevation minimum elevation to plot in degrees mask mask certain parts of image scale scale for map set central_lon geographic longitude of center of plot central_lat geographic latitude of center of plot rotation rotate map projection projection for map set, MAP_PROJ_INFO, PROJ_NAMES=names color_continent shade of continent fill color_background shade of background zbuffer do in z-buffer, not on the screen cursor finish with cursor info, loop if cursor>1 window set window number xsize xsize of window ysize ysize of window position=position position of plot on window (normal coordinates) noerase=noerase do not erase current window (no effect if {x,y}size set no_grid=no_grid do not plot geomagnetic grid no_midnight=no_midnight do not plot midnight meridian add_plot stop because we want to add something force_map plot map even if there are no images xy_pos xy position location mark geographic location [lo,la] track1 mark geographic location [lo,la] track2 mark geographic location [lo,la] top top color to be used for polyfill no_color do not load color table, use existing xy_cursor create array of cursor selected values to pass to upper program ssize size of symbol for location sym_color color of location stoptime create multiple mosaics timestep time steps for multiple mosaics in seconds OUTPUTS: None OPTIONAL OUTPUTS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: None EXAMPLE: THM_ASI_MERGE_MOSAIC,'2006-01-01/05:00:00' THM_ASI_MERGE_MOSAIC,'2007-03-01/04:00:00',exclude='ekat' MODIFICATION HISTORY: Written by: Harald Frey, 09/06/2011 based on example from Donovan/Jackel and thm_asi_create_mosaic NOTES: WARNING!!!!!!!!!!!!!! This program may not be perfect and may not work in every situation.

thm_asi_recreate_mosaic.pro

NAME: THM_ASI_RECREATE_MOSAIC PURPOSE: recreate mosaic from gif-input CATEGORY: None CALLING SEQUENCE: THM_ASI_RECREATE_MOSAIC,file INPUTS: filename like 'MOSA.2008.01.28.10.58.30.gif' OPTIONAL INPUTS: None KEYWORD PARAMETERS: no_view do not regenerate mosaic, only show command OUTPUTS: None OPTIONAL OUTPUTS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: None EXAMPLE: THM_ASI_RECREATE_MOSAIC,'MOSA.2008.01.28.10.58.30.gif' MODIFICATION HISTORY: Written by: Harald Frey, 23/06/2009 NOTES: VERSION: $LastChangedBy: aaflores $ $LastChangedDate: 2012-01-09 09:54:03 -0800 (Mon, 09 Jan 2012) $ $LastChangedRevision: 9515 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_asi_recreate_mosaic.pro $

thm_asi_stations.pro

NAME: THM_ASI_STATIONS.PRO PURPOSE: define quantities for GBO stations CATEGORY: None CALLING SEQUENCE: thm_asi_stations,labels,location INPUTS: None OPTIONAL INPUTS: None KEYWORD PARAMETERS: id IP Adress of stations, now obsolete but we keep them for now epo names and locations of EPO sites OUTPUTS: labels Names of GBO stations location Geographic location of stations OPTIONAL OUTPUTS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: None EXAMPLE: MODIFICATION HISTORY: Written by: Harald Frey Version 1.0 August, 23, 2006 1.1 09/29/06 changed order of UMIJ and CHBG 1.2 10/04/06 replaced UMIJ with SNKQ 1.3 03/19/07 added EPO, corrected typo 1.4 11/16/07 exchanged NAIN for KUUJ 1.5 03/17/08 added YKNF 1.6 10/09/08 added NRSQ VERSION: $LastChangedBy: hfrey $ $LastChangedDate: 2008-11-19 14:50:04 -0800 (Wed, 19 Nov 2008) $ $LastChangedRevision: 4004 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_asi_stations.pro $

thm_gmag_stackplot.pro

NAME: thm_gmag_stackplot.pro PURPOSE: To create 3 PNG files displaying the H,D and Z components of the magnetic field from multiple GBO stations out of GMAG data that is stored in CDF file.

thm_gmag_stations.pro

NAME: THM_GMAG_STATIONS.PRO PURPOSE: define quantities for GMAG stations CATEGORY: None CALLING SEQUENCE: thm_gmag_stations,labels,location INPUTS: None OPTIONAL INPUTS: None KEYWORD PARAMETERS: conjugate conjugate locations magnetic geomagnetic coordinates midnight local magnetic midnight names full names of sites verbose some debug printing OUTPUTS: labels Names of GBO stations location Geographic location of stations OPTIONAL OUTPUTS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: None EXAMPLE: MODIFICATION HISTORY: Written by: Harald Frey Version 1.0 August, 16, 2011 VERSION: $LastChangedBy: nikos $ $LastChangedDate: 2013-04-05 08:53:30 -0700 (Fri, 05 Apr 2013) $ $LastChangedRevision: 11971 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_gmag_stations.pro $

thm_load_asi.pro

Procedure: THM_LOAD_ASI KEYWORD PARAMETERS: site = Observatory name, example, thm_load_gmag, site = 'fykn', the default is 'all', i.e., load all available stations .

thm_load_asi_cal.pro

NAME: THM_LOAD_ASI_CAL SYNTAX: thm_load_asi_cal,'fykn',fykn_cal PURPOSE: load the ASI calibration parameters into tplot variables INPUTS: SITE names of GBO stations requested OUTPUTS: CAL_STRUC structure containing pointers to calibration parameters KEYWORDS: TRANGE= (Optional) Time range of interest (2 element array).

thm_load_ask.pro

Procedure: THM_LOAD_ASKPurpose: Loads THEMIS All Sky Keogramskeywords: site = Observatory name, example, thm_load_gmag, site = 'fykn', the default is 'all', i.e., load all available stations .

thm_load_carisma_gmag.pro

thm_load_gmag.pro

Procedure: THM_LOAD_GMAG, thm_load_gmag, site = site, datatype = datatype, trange = trange, $ level = level, verbose = verbose, $ subtract_average = subtract_average, $ subtract_median = subtract_median, $ varname_out = varname_out, $ subtracted_values = subtracted_values, $ downloadonly = downloadonly, $ valid_names = valid_nameskeywords: site = Observatory name, example, thm_load_gmag, site = 'bmls', the default is 'all', i.e., load all available stations .

thm_load_greenland_gmag.pro

thm_load_pseudoae.pro

Procedure: THM_LOAD_PSEUDOAE, thm_load_pseudoAE, datatype = datatype, trange = trange, $ verbose = verbose, $ varname_out = varname_out, $ downloadonly = downloadonly, $ no_download=no_download, relpathnames_all=relpathnames_all,$ files=files,$ valid_names = valid_names,$ suffix=suffixPurpose: loads pregenerated Pseudo AE,AU,AL from CDF.

thm_make_ae.pro

Name: THM_MAKE_AE Purpose: This routine calculates the "pseudo" AE, AL, and AU geomagnetic indices by using ground magnetometer data from THEMIS GBOs.

thm_mult_gmag_plot.pro

NAME: thm_mult_gmag_plot.pro PURPOSE: Plots all GMAG data, in groups of 3 (or anything set by keyword n_per_page) for quick viewing CALLING SEQUENCE: thm_mult_gmag_plot, date, duration INPUTS: date: The start of the time interval to be plotted.

thm_plot_gmag_by_source.pro

NAME: thm_plot_gmag_by_source PURPOSE: Plots all GMAG data, arranged by the data source (e.g., THEMIS EPO, GBO, u of alaska, etc...) for quick viewing CALLING SEQUENCE: thm_mult_gmag_plot, date, duration INPUTS: date: The start of the time interval to be plotted.