Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

projects/themis/ground/

thm_load_greenland_gmag.pro


Routines

Routines from thm_load_greenland_gmag.pro

result = thm_load_greenland_gmag_relpath(sname=sname, trange=trange, addmaster=addmaster, version=version, _extra=_extra)

Procedure: THM_LOAD_GREENLAND_GMAG, thm_load_greenland_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_greenland_gmag, site = 'amk', the default is 'all', i.e., load all available stations .

thm_load_greenland_gmag_post, sname=sname, datatype=datatype, varcount=varcount, verbose=verbose, subtract_average=subtract_average, subtract_median=subtract_median, varname_out=varname_out, subtracted_values=subtracted_values, suffix=suffix, _extra=_extra
thm_load_greenland_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, no_download=no_download, relpathnames_all=relpathnames_all, valid_names=valid_names, get_support_data=get_support_data, progobj=progobj, files=files, suffix=suffix, _extra=_extra

Routine details

top source thm_load_greenland_gmag_relpath

result = thm_load_greenland_gmag_relpath(sname=sname, trange=trange, addmaster=addmaster, version=version, _extra=_extra)

Procedure: THM_LOAD_GREENLAND_GMAG, thm_load_greenland_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_greenland_gmag, site = 'amk', the default is 'all', i.e., load all available stations . This can be an array of strings, e.g., ['amk', 'atu'] or a single string delimited by spaces, e.g., 'amk atu'. The valid site names for this case are: amk and atu bfe bjn dmh dob don fhb gdh ghb hop jck kar kuv lyr nal naq nor nrd roe rvk sco skt sol sor stf svs tdc thl tro umq upn These names correspond to gmags at these locations: Ammassalik(Tasiilaq) Andenes Attu Brorfelde Bjornoya Danmarkshavn Dombas Donna Paamiut(Frederickshap) Qeqertarsuaq(Godhavn) Nuuk(Godthap) Hopen Jackvik Karmoy Kullorsuaq Longyearbyen NyAlesund Naqsarsuaq Nordkapp Nord Roemoe Rorvik Ittoqqortoormiit Maniitsoq(SukkerToppen) Solund Soroya Kangerlussuaq(SondreStromFjord) Savissivik TristanDaCunha Qaanaaq(Thule) Tromso Umanaq Upernavik Note that the station 'naq' is the THEMIS GMAG station 'NRSQ' 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_greenland_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: timespan, '2007-06-04',1 thm_load_greenland_gmag, site = 'amk' 19-mar-2007, jmm, chnaged name from thm_load_gmag, to read greenland gmag stations not included in the usual GMAG distribution 05-may-2011 lphilpott, updated site lists $LastChangedBy: lphilpott $ $LastChangedDate: 2012-06-04 16:06:33 -0700 (Mon, 04 Jun 2012) $ $LastChangedRevision: 10505 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_load_greenland_gmag.pro $

Keywords

sname
trange
addmaster
version
_extra

top source thm_load_greenland_gmag_post

thm_load_greenland_gmag_post, sname=sname, datatype=datatype, varcount=varcount, verbose=verbose, subtract_average=subtract_average, subtract_median=subtract_median, varname_out=varname_out, subtracted_values=subtracted_values, suffix=suffix, _extra=_extra

Keywords

sname
datatype
varcount
verbose
subtract_average
subtract_median
varname_out
subtracted_values
suffix
_extra

top source thm_load_greenland_gmag

thm_load_greenland_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, no_download=no_download, relpathnames_all=relpathnames_all, valid_names=valid_names, get_support_data=get_support_data, progobj=progobj, files=files, suffix=suffix, _extra=_extra

Keywords

site
datatype
trange
level
verbose
subtract_average
subtract_median
varname_out
subtracted_values
downloadonly
no_download
relpathnames_all
valid_names
get_support_data
progobj
files
suffix
_extra

File attributes

Modification date: Thu Feb 13 16:42:58 2014
Lines: 102