Procedure : ttrace2iono Purpose: tplot wrapper for field line footprint and tracing routines This program will always use the refined foot point mappings (a modification made by Vassilis Angelopoulos to provide more accurate mappings of foot points) unless you request the standard mapping. Model parameters can be provided in the par array or individually, using the parameter's name. If a model parameter is provided by name, it will overwrite an par value provided. If a named parameter is provided, but is unneeded by the model, it will be ignored. Input: in_pos_tvar: name of the tplot variable storing the position information for tracing, input values should be in 'gse','gei','gsm',or 'sm' Keywords: newname(optional): name of the tplot variable in which output footprints should be stored(default: in_pos_tvar+'_foot') trace_var_name(optional): name of the tplot variable in which to store the traces of field lines leading to footprints. Because traces are of variable length, the returned array will be of dimensions NxDx3 D is the maximum number of vectors in any of the traces. Shorter traces will have NaNs filling the space at the end of the array in_coord(optional): set this keyword to the coordinate system of the input, defaults to 'gsm', must match tplot meta data out_coord(optional): set this keyword to a string indicating the coordinate system output data should be in, defaults to 'gsm' (can be 'geo','gei','gse','gsm',or 'sm' default: the same as the input) internal_model(optional): set this keyword to a string indicating the internal model that should be used in tracing (can be 'dip' or 'igrf' default:igrf) external_model(optional): set this keyword to a string indicating the external model that should be used in tracing (can be 'none','t89','t96','t01', or 't04s' default: none) SOUTH(optional): set this keyword to indicate that fields should be traced towards the southern hemisphere. By default they trace north. KM(optional): set this keyword to indicate that input and output will be in KM not RE par(optional): parameter input for the external field model if using t89 then it should be an N element array containing kp values or a single kp value, if using t96,t01,t04s it should be an N x 10 element array of parmod values or a 10 element array or a 1x10 element array. At the moment if an external model is set and this is not set an error will be thrown. This can also contain a string naming a tplot variable storing the par values. If a tplot variable is named it will also be interpolated to match the position data. period(optional): the amount of time between recalculations of geodipole tilt and input of new model parameters in seconds (default: 60) increase this value to decrease run time if field line traces are requested this parameter is ignored and new model parameters are input on each iteration error(optional): named variable in which to return the error state of the procedure. 1 for success, 0 for failure standard_mapping(optional): Set to use Tsyganenko's unmodified version instead of the Angelopoulos's refined version R0(optional): Minimum trace distance in RE,unless /km is set. RLIM(optional): Maximum trace distance in RE unless,/km is set (default: 60 RE) NOBOUNDARY(optional): Override boundary limits. STORM(optional): Specify storm-time version of T01 external magnetic field model use together with /T01. pdyn(optional): Solar wind pressure(nanoPascals) should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar dsti(optional): DST index(nanoTeslas) should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar yimf(optional): y component of the interplanetary magnetic field should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar zimf(optional): z component of the interplanetary magnetic field should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar g1(optional): index describes solar wind conditions in the previous hour, should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar g2(optional): index describes solar wind conditions in the previous hour should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w1(optional): time integral from the beginning of a storm can be an array or a tplot variable(see paper reference below for definitions of w1-w6) or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w2(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w3(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w4(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w5(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w6(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar get_tilt(optional): Set this value to a tplot variable name in which the geodipole tilt for each period will be returned One sample will be returned for each period with time at the center of the period. set_tilt(optional): Set this to a tplot variable name or an array of values containing the dipole tilt that should be used. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar add_tilt(optional): Set this to a tplot variable name or an array of values containing the values to be added to the dipole tilt that should be used for each period. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar get_nperiod(optional): Return the number of periods used in the time interval 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. Example: ttrace2iono,'tha_state_pos',newname='tha_out_foot' See: ttrace_crib for more examples 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. 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. 3. If the trace_array variable is set the period variable will be ignored. The program will recalculate for each value, this will cause the program to run very slowly. 4. All calculations are done internally in double precision $LastChangedBy: egrimes $ $LastChangedDate: 2014-03-18 08:23:43 -0700 (Tue, 18 Mar 2014) $ $LastChangedRevision: 14569 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/external/IDL_GEOPACK/trace/ttrace2iono.pro $