Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

general/misc/

time_clip.pro


Procedure: time_clip Purpose: clips a tplot variable between a start time and an end time Inputs: tplot_var_name: the name of the variable to be clipped start_time: the start time for the clipping(double or string) end_time: the end time for the clipping(double or string) Keywords: newname(optional): the name of the output tplot variable otherwise it will be tplot_var_name+'_tclip' tvar(optional): set this keyword and start_time and end_time will be interpreted as the names of tplot variables The start and end times will then be taken from the first and last component of the tplot variables listed replace(optional): set this to replace the variable, rather than create a new one error(optional): set this to a named variable to return the error status of the function, it will return 0 for no error and 1 to signal an error. This may be set to true even if the error was non fatal. Also if you are using globbing to modify many tplot variables it will signal an error if any of the variables failed examples: time_clip,'thb_fgs_gsm','2007-03-23/10:00:00','2007-03-23/12:00:00',newname='thb_fgs_gsm_10t12clip' time_clip,'thb_peem_velocity','thb_fgs_gsm',thb_fgs_gsm',/tvar $LastChangedBy: pcruce $ $LastChangedDate: 2008-01-03 13:53:59 -0800 (Thu, 03 Jan 2008) $ $LastChangedRevision: 2224 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/idl_socware/trunk/external/IDL_GEOPACK/trace/ttrace_crib.pro $

Routines

top source time_clip

time_clip, tplot_var_name, start_time, end_time, newname=newname, tvar=tvar, replace=replace, error=error

Parameters

tplot_var_name
start_time
end_time

Keywords

newname
tvar
replace
error

File attributes

Modification date: Thu Feb 13 16:43:47 2014
Lines: 78