Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

external/developers/solarwind/

solarwind_load.pro


NAME: SOLARWIND_LOAD PURPOSE: Routine provides solar wind (SW) data time-shifted to the bow-shock nose. Time resolution of data is variable with 1 minute as finest. SW data sources: OMNI-2, HRO, and WIND. Time shifting of the WIND data is based on the OMNI-2 metodology. Important difference is that we first average and then propagate averaged WIND quantities to the Earth. If there still is a strong irregularity in the SW speed after averaging, the code warns user. In all cases of insufficient data, the code produces nominal static SW parameters, following SPDF standards. Static nominal SW data is default output if no user preferences are specified in the program call. CATEGORY: Data Processing CALLING SEQUENCE: solarwind_load,swdata,dstout,trange, resol=resol, wind=wind, hro=hro, min5=min5, h1=h1, dst=dst INPUTS: trange : [tstart, tend] - time range (at the magnetopause) for SW data Times tstart and tend need to be one of types supported by TDAS (specifically, by the time_double.pro routine), in part: double seconds since 1970 (internal TDAS format) string format: 'YYYY-MM-DD/hh:mm:ss' OPTIONAL INPUT: resol : desired time resolution of the output data in seconds - if not set, SW data are provided in original time resolution KEYWORDS: wind - WIND observations used (they are convolved to desired resolution and then time-shifted to the bow-shock nose using OMNI-2 methodology. The code checks if the SW speed irregularities are too large and warns user when more sophisticated processing may be needed. hro - HRO data are used (most consistent approach up-to-date). The data are already propagated, so they are just convolved to desired resolution. min5 - use 5 min HRO merged database (default is to use 1 min HRO merged data) h1 - use OMNI-2 1 hour SW database. No convolution employed and parameter resol is ignored dst - get Dst index from the OMNI-2 database. This switch works independently on the other data keywords (for example, it provides Dst output even if HRO or WIND data are ordered). Dst is interpolated onto the time grid od requested data, if any. PARAMETERS: 3 parameters for outlier filtering are described and set at the beginning of the code. OUTPUTS: swdata: | t | Dp | Bz | of IMF at the bow-shock nose - 2D double array (ntpoints,3) dstout: | Dst | - Dst index on the 1-hour OMNI-2 time grid - double array (ntpoints) DEPENDENCIES: convolve_gaussian_1d.pro, remove_outliers.pro, repair.pro, wi_swe_load.pro, wi_mfi_load.pro, omni_hro_load.pro, omni2_load.pro, get_data.pro, xclip.pro, xdegap.pro, xdeflag.pro, cotrans.pro. The code is a lowest-level part of LMN transform package. MODIFICATION HISTORY: Written by: Vladimir Kondratovich 2007/12/28. Modified by Vladimir Kondratovich 2008/03/31. Mods do not change call syntax. The code is made modular with plug-in subroutines for each data source, so it became easy to add a new one. Existing ingest modules provide a template.

Routines

top source solarwind_load

solarwind_load, swdata, dstout, trange, resol=resol, wind=wind, hro=hro, min5=min5, h1=h1, dst=dst

Parameters

swdata
dstout
trange

Keywords

resol
wind
hro
min5
h1
dst

File attributes

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