Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/spacecraft/fields/LASP/

trange_clip.pro


NAME: TRANGE_CLIP (PROCEDURE) PURPOSE: Utility to trim the time range of a tplot variable and remove excess data. CALLING SEQUENCE: trange_clip,name, t1, t2, newname=newname, data_in=data_in,$ remove_match=remove_match, BadClip=BadClip ARGUMENTS: name: (INPUT, REQUIRED) Either tplot variable name or data structure (if data_in keyword specified) t1: (INPUT, REQUIRED) Start time (double, time since 1970) t2: (INPUT, REQUIRED) Stop time (double, time since 1970) KEYWORDS: data_in: (INPUT, OPTIONAL) Set to specify that the input is a data structure, not a tplot name. remove_match: (INPUT, OPTIONAL) Removes data between t1 and t2 (default is keep only data between t1 and t2) BadClip: (OUTPUT, OPTIONAL) A named variable of the status of the clip. If the clip is valid, BadClip = 0, otherwise 1. newname: (INPUT, OPTIONAL) A new name for storing the clip into a tplot variable if the name is also a tplot variable name. Outputs: Modifies the specified tplot name or data structure. Examples: tvar = 'thd_fgh_dsl' newname = tvar + '_clip' trange_clip, tvar, t1, t2, newname = newname HISTORY: REE. 09-05-11. Changed to work with CLEAN EFP. Added BadClip=BadClip VERSION: $LastChangedBy$ $LastChangedDate$ $LastChangedRevision$ $URL$

Routines

top source trange_clip

trange_clip, name, t1, t2, newname=newname, data_in=data_in, remove_match=remove_match, BadClip=BadClip

Parameters

name
t1
t2

Keywords

newname
data_in
remove_match
BadClip

File attributes

Modification date: Thu Feb 13 16:42:36 2014
Lines: 56