projects/themis/ground/
thm_load_carisma_gmag.pro
Routines
Routines from thm_load_carisma_gmag.pro
result = thm_load_carisma_gmag_relpath(sname=sname, trange=trange, addmaster=addmaster, version=version, _extra=_extra)
Procedure: THM_LOAD_CARISMA_GMAG, thm_load_carisma_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 NOTE: 1.
thm_load_carisma_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_carisma_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_carisma_gmag_relpath
result = thm_load_carisma_gmag_relpath(sname=sname, trange=trange, addmaster=addmaster, version=version, _extra=_extra)
Procedure: THM_LOAD_CARISMA_GMAG, thm_load_carisma_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 NOTE: 1. Data from the CARISMA gmag sites loaded by this routine is not mirrored by THEMIS. The data is downloaded directly from CARISMA (UAlberta) to the user's computer. Users of CARISMA data should be sure to read the Data Policy information at http://themis.ssl.berkeley.edu/roadrules.shtml before using this data for publication. 2. The data for some sites in the CARISMA network is mirrored by THEMIS: namely Rankin Inlet, Fort Smith, Gillam, Pinawa Fort Simpson. Data for these sites is loaded using the standard thm_load_gmag process. keywords: site = Observatory name, example, thm_load_carisma_gmag, site = 'daws', the default is 'all', i.e., load all available stations . This can be an array of strings, e.g., ['daws', 'isll'] or a single string delimited by spaces, e.g., 'daws isll'. The valid site names for this case are: anna back cont daws eski fchp fchu gull isll lgrr mcmu mstk norm osak oxfo pols rabb sach talo thrf vulc weyb wgry These names correspond to gmags at these locations: Ann Arbor, Back Lake, Contwoyto, Dawson City, Eskimo Point, Fort Chipewyan, Fort Churchill, Gull Lake, Island Lake, Little Grand Rapids, Fort McMurray, Ministik Lake, Norman Wells, Osakis, Oxford House, Polson, Rabbit Lake, Rankin Inlet, Sachs Harbour, Taloyoak, Thief River Falls, Vulcan, Weyburn, Wells Gray. NB: 1. The CARISMA fchu (Fort Churchill) magnetometer is distinct from the CANMOS fcc magnetometer at Fort Churchill. 2. The gmag site TALO is a CARISMA site. There is also a THEMIS ASI site TALO. 3. Data for some sites may not yet be available. 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. (in this case there is only one level of data available) /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_carisma_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, '2010-06-04',1 thm_load_carisma_gmag, site = 'daws' $LastChangedBy: egrimes $ $LastChangedDate: 2014-02-13 12:14:35 -0800 (Thu, 13 Feb 2014) $ $LastChangedRevision: 14372 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/ground/thm_load_carisma_gmag.pro $
Keywords
- sname
- trange
- addmaster
- version
- _extra
top source thm_load_carisma_gmag_post
thm_load_carisma_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_carisma_gmag
thm_load_carisma_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:57 2014 |
Lines: | 116 |