Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

external/IDL_GEOPACK/t01/

t01.pro


Function: t01 Purpose: generates an array of model magnetic field vectors from a monotonic time series and an array of 3-d position vectors Keywords: tarray: N array representing the time series in seconds utc since 1970 rgsm_array: Nx3 array representing the position series in earth radii GSM pdyn_array: Solar wind pressure (nanoPascals) dsti_array: DST index(nanoTeslas) yimf_array: y component of the interplanetary magnetic field zimf_array: z component of the interplanetary magnetic field g1_array: index describes solar wind conditions in the previous hour g2_array: index describes solar wind conditions in the previous hour period(optional): the amount of time between recalculations of geodipole tilt in seconds(default: 60) increase this value to decrease run time add_tilt: Increment the default dipole tilt used by the model with a user provided tilt in degrees. Result will be produced with TSY_DEFAULT_TILT+ADD_TILT Value can be set to an N length array an M length array or a single element array. N is the number of time elements for the data. M is the number of periods in the time interval.(determined by the period keyword) If single element is provided the same correction will be applied to all periods. If an N length array is provided, the data will be re-sampled to an M length array. Consequently, if the values change quickly, the period may need to be shortened. get_tilt: Returns the dipole_tilt parameter used for each period. Returned value has a number of elements equal to the value returned by get_nperiod set_tilt: Alternative alternative dipole_tilt value rather than the geopack tilt. This input can be an M length array, and N length array or a single elemnt. Value can be set to an N length array an M length array or a single element array. N is the number of time elements for the data. M is the number of periods in the time interval.(determined by the period keyword) If an N length array is provided, the data will be re-sampled to an M length array. Consequently, if the values change quickly, the period may need to be shortened. set_tilt will cause add_tilt to be ignored. get_nperiod: Returns the number of periods used for the time interval= ceil((end_time-start_time)/period) storm: Use the storm-time version of the T01 model geopack_2008 (optional): Set this keyword to use the latest version (2008) of the Geopack library. Version 9.2 of the IDL Geopack DLM is required for this keyword to work. Returns: an Nx3 length array or -1L on failure Example: mag_array = t01(time_array,pos_array,pdyn_array,dsti_array,yimf_array,zimf_array,g1_array,g2_array) mag_array = t01(time_array,pos_array,pdyn_array,dsti_array,yimf_array,zimf_array,g1_array,g2_array,period=10) Notes: 1. Relies on the IDL/Geopack Module provided by Haje Korth JHU/APL and N.A. Tsyganenko NASA/GSFC, if the module is not installed this function will fail. 2. Sums the contribution from the internal field model and the external field model. 3. Has a loop with number of iterations = (tarray[n_elements(t_array)]-tarray[0])/period This means that as period becomes smaller the amount time of this function should take will grow quickly. 4. Position units are in earth radii, be sure to divide your normal units by 6374 km to convert them. 5.Find more documentation on the inner workings of the model, any gotchas, and the meaning of the arguments at: http://geo.phys.spbu.ru/~tsyganenko/modeling.html -or- http://ampere.jhuapl.edu/code/idl_geopack.html 6. Definition of G1 and G2 can be found at: http://modelweb.gsfc.nasa.gov/magnetos/data-based/Paper220.pdf http://modelweb.gsfc.nasa.gov/magnetos/data-based/Paper219.pdf $LastChangedBy: egrimes $ $LastChangedDate: 2014-03-19 08:22:59 -0700 (Wed, 19 Mar 2014) $ $LastChangedRevision: 14600 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/external/IDL_GEOPACK/t01/t01.pro $

Routines

top source t01

result = t01(tarray, rgsm_array, pdyn, dsti, yimf, zimf, g1, g2, period=period, add_tilt=add_tilt, get_tilt=get_tilt, set_tilt=set_tilt, get_nperiod=get_nperiod, get_period_times=get_period_times, storm=storm, geopack_2008=geopack_2008)

Parameters

tarray
rgsm_array
pdyn
dsti
yimf
zimf
g1
g2

Keywords

period
add_tilt
get_tilt
set_tilt
get_nperiod
get_period_times
storm
geopack_2008

File attributes

Modification date: Thu Apr 10 11:53:03 2014
Lines: 215