external/IDL_GEOPACK/t04s/
t04s.pro
Function: t04s 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 The following arguments can either be N length arrays or single values 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 w1_array: index represents a time integral over a storm w2_array: index represents a time integral over a storm w3_array: index represents a time integral over a storm w4_array: index represents a time integral over a storm w5_array: index represents a time integral over a storm w6_array: index represents a time integral over a storm 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 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) 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 = t04s(time_array,pos_array,pdyn_array,dsti_array,yimf_array,zimf_array,w1_array,w2_array,w3_array,w4_array,w5_array,w6_array) mag_array = t04s(time_array,pos_array,pdyn_array,dsti_array,yimf_array,zimf_array,w1_array,w2_array,w3_array,w4_array,w5_array,w6_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 W1-W6 can be found at: N. A. Tsyganenko and M. I. Sitnov, Modeling the dynamics of the inner magnetosphere during strong geomagnetic storms, J. Geophys. Res., v. 110 (A3), A03208, doi: 10.1029/2004JA010798, 2005 $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/t04s/t04s.pro $
Routines
top source t04s
result = t04s(tarray, rgsm_array, pdyn, dsti, yimf, zimf, w1, w2, w3, w4, w5, w6, period=period, add_tilt=add_tilt, get_tilt=get_tilt, set_tilt=set_tilt, get_nperiod=get_nperiod, get_period_times=get_period_times, geopack_2008=geopack_2008)
Parameters
- tarray
- rgsm_array
- pdyn
- dsti
- yimf
- zimf
- w1
- w2
- w3
- w4
- w5
- w6
Keywords
- period
- add_tilt
- get_tilt
- set_tilt
- get_nperiod
- get_period_times
- geopack_2008
File attributes
Modification date: | Thu Apr 10 11:53:04 2014 |
Lines: | 231 |