This page was created by the IDL library routine
mk_html_help2.
Last modified: Thu Sep 27 14:05:48 2007.
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
gif_out create a gif-file
verbose print some diagnostics
pgm_file do not read CDF, but pgm-files
zbuffer do in z-buffer, not on the screen
thumb use thumbnails instead of full resolution images
exclude string of station names that should not be plotted
show string of station names that should only be plotted
top top color to be used for polyfill
special special treatment for not mapped thumbnail
scale scale for map set
central_lon geographic longitude of center of plot
central_lat geographic latitude of center of plot
xsize xsize of window
ysize ysize of window
color_continent shade of continent fill
color_background shade of background
position=position position of plot on window (normal coordinates)
noerase=noerase do not erase current window (no effect if {x,y}size set
cursor finish with cursor info
projection projection for map set
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
NOTES:
VERSION:
$LastChangedBy: hfrey $
$LastChangedDate: 2007-04-25 16:58:17 -0700 (Wed, 25 Apr 2007) $
$LastChangedRevision: 613 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_2_02/idl/themis/ground/thm_asi_create_mosaic.pro $
(See themis/ground/thm_asi_create_mosaic.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
VERSION:
$LastChangedBy$
$LastChangedDate$
$LastChangedRevision$
$URL$
(See themis/ground/thm_asi_stations.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.
CALLING SEQUENCE:
thm_gmag_stackplot, date, duration, stack_shift=stack_shift, no_expose=no_expose, make_png=make_png
INPUTS:
date: The start of the time interval to be plotted. (Format: 'YYYY-MM-DD/hh:mm:ss')
duration: The length of the interval being plotted. (Floating point number of days -> 12hr=0.5), default=1
stack_shift: Space between stations on the y-axis (units are nanotesla), default=50
no_expose: Set this keyword to prevent the plot from being printed to the screen.
make_png: Set this keyword to make the 3 PNG files.
max_deviation: Large spikes in the data (probably gliches) can screw up the y-axis scales. This keyword allows
you to set the maximum deviation the data can go from the median; points that exceed this value are omitted.
The default value is 500 nT.
no_data_load: This keyword prevents new data from being loaded; the routine will try to plot existing data if it exists.
hi_lat: Set this keyword to plot high latitude stations (above 49 degrees)
lo_lat: Set this keyword to plot low latitude stations (below 49 below)
OUTPUTS:
None, but it creates 3 PNG files in the directory that IDL is being run.
PROCEDURE:
Read in data from CDF files; plot the data using tplot.pro routines;
make PNG files with makegif.pro routine
EXAMPLE:
thm_gmag_stackplot, '2006-11-11',1,/make_png, max_deviation=500, stack_shift=200.
MODIFICATION HISTORY:
Written by: Matt Davis
October 23, 2006 Initial version
NOTE: This program is still in development. Features to be added:
-generalizing the routine
(See themis/ground/thm_gmag_stackplot.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 . This
can be an array of strings, e.g., ['fykn', 'gako'] or a
single string delimited by spaces, e.g., 'fykn gako'
datatype = request 'ast' or 'asf', default is 'asf', can also be 'all'.
TRANGE= (Optional) Time range of interest (2 element array), if
this is not set, the default is to prompt the user. Note
that if the input time range is not a full day, a full
day's data is loaded
level = the level of the data, the default is 'l2', or level-2
data. A string (e.g., 'l2') or an integer can be used. 'all'
can be passed in also, to get all levels.
/VERBOSE : set to output some useful info
/downloadonly, if set, then only download the data, do not load it
into variables.
/no_download: use only files which are online locally.
relpathnames_all: named variable in which to return all files that are
required for specified timespan, probe, datatype, and level.
If present, no files will be downloaded, and no data will be loaded.
/valid_names, if set, then this will return the valid site, datatype
and/or level options in named variables, for example,
thm_load_gmag, site = xxx, /valid_names
will return the array of valid sites in the
variable xxx
/CURSOR get time range with cursor
/TIME specify just one time (record) for data
Example:
thm_load_asi,'fykn',time='2006-01-01/04:29:53'
Notes:
To get an array of valid names make the following call;
thm_load_asi,site=vn,/valid_names
No further action will be taken.
Written by: Ken Bromund ????, Jan 5 2007
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-07-03 09:10:02 -0700 (Tue, 03 Jul 2007) $
$LastChangedRevision: 987 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_2_02/idl/themis/ground/thm_load_asi.pro $
(See themis/ground/thm_load_asi.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).
/VERBOSE : set to output some useful info
/ALL get data from all 20 THEMIS-GBO
/DOWNLOADONLY
/VALID_NAMES
/CURSOR get time range with cursor
HISTORY:
adapted from thm_load_asi
Notes:
To get an array of valid names make the following call;
thm_load_asi_cal,valid_names=vn
No further action will be taken.
Written by: Harald Frey, Jan 26 2007
$LastChangedBy: kenb-mac $
$LastChangedDate: 2007-05-02 17:25:43 -0700 (Wed, 02 May 2007) $
$LastChangedRevision: 629 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_2_02/idl/themis/ground/thm_load_asi_cal.pro $
(See themis/ground/thm_load_asi_cal.pro)
Procedure: THM_LOAD_ASK
Purpose: Loads THEMIS All Sky Keograms
keywords:
site = Observatory name, example, thm_load_gmag, site = 'fykn', the
default is 'all', i.e., load all available stations . This
can be an array of strings, e.g., ['fykn', 'gako'] or a
single string delimited by spaces, e.g., 'fykn gako'
datatype = request 'ast' or 'asf', default is 'asf', can also be 'all'.
TRANGE= (Optional) Time range of interest (2 element array), if
this is not set, the default is to prompt the user. Note
that if the input time range is not a full day, a full
day's data is loaded
level = the level of the data, the default is 'l2', or level-2
data. A string (e.g., 'l2') or an integer can be used. 'all'
can be passed in also, to get all levels.
/VERBOSE : set to output some useful info
/downloadonly, if set, then only download the data, do not load it
into variables.
/no_download: use only files which are online locally.
relpathnames_all: named variable in which to return all files that are
required for specified timespan, probe, datatype, and level.
If present, no files will be downloaded, and no data will be loaded.
/valid_names, if set, then this will return the valid site, datatype
and/or level options in named variables, for example,
thm_load_gmag, site = xxx, /valid_names
will return the array of valid sites in the
variable xxx
get_support_data = does nothing. present only for consistency with other
load routines
Example:
thg_load_ask
Notes:
This routine is (should be) platform independent.
$LastChangedBy: jimm $
$LastChangedDate: 2007-05-21 16:44:54 -0700 (Mon, 21 May 2007) $
$LastChangedRevision: Added valid_names output option$
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_2_02/idl/themis/ground/thm_load_ask.pro $
(See themis/ground/thm_load_ask.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_names
keywords:
site = Observatory name, example, thm_load_gmag, site = 'bmls', the
default is 'all', i.e., load all available stations . This
can be an array of strings, e.g., ['bmls', 'ccmv'] or a
single string delimited by spaces, e.g., 'bmls ccnv'
datatype = The type of data to be loaded, for this case, there is only
one option, the default value of 'mag', so this is a
placeholder should there be more that one data type. 'all'
can be passed in also, to get all variables.
TRANGE= (Optional) Time range of interest (2 element array), if
this is not set, the default is to prompt the user. Note
that if the input time range is not a full day, a full
day's data is loaded
level = the level of the data, the default is 'l2', or level-2
data. A string (e.g., 'l2') or an integer can be used. 'all'
can be passed in also, to get all levels.
/VERBOSE : set to output some useful info
/SUBTRACT_AVERAGE, if set, then the average values are subtracted
from the loaded variables,
/SUBTRACT_MEDIAN, if set, then the median values are subtracted
from the loaded variables,
varname_out= a string array containing the tplot variable names for
the loaded data, useful for the following keyword:
subtracted_values = returns N_elements(varname_out) by 3 array
containing the average or median (or 0) values
subtracted from the data.
/downloadonly, if set, then only download the data, do not load it
into variables.
no_download: use only files which are online locally.
relpathnames_all: named variable in which to return all files that are
required for specified timespan, probe, datatype, and level.
If present, no files will be downloaded, and no data will be loaded.
/valid_names, if set, then this will return the valid site, datatype
and/or level options in named variables, for example,
thm_load_gmag, site = xxx, /valid_names
will return the array of valid sites in the
variable xxx
get_support_data = does nothing. present only for consistency with other
load routines
Example:
thm_load_gmag, site = 'bmls', trange =
['2007-01-22/00:00:00','2007-01-24/00:00:00']
Written by: Davin Larson, Dec 2006
22-jan-2007, jmm, jimm@ssl.berkeley.edu rewrote argument list, added
keywords,
1-feb-2007, jmm, added subtract_median, subtracted_value keywords
19-mar-2007, jmm, fixed the station list...
$LastChangedBy: jimm $
$LastChangedDate: 2007-05-21 16:44:54 -0700 (Mon, 21 May 2007) $
$LastChangedRevision: 678 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/tags/tdas_2_02/idl/themis/ground/thm_load_gmag.pro $
(See themis/ground/thm_load_gmag.pro)