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/

thm_jbt_get_btrange.pro


NAME: THM_JBT_GET_BTRANGE (FUNCTION) PURPOSE: This routine is to find the starting time and ending time of each continuous section of a give tplot variable which essentially is specified by a tplot name such as 'tha_efp'. If the routine exit unsuccessfully, it will return -1. Otherwise, it will return a 2D array as [2,number_of_total_bursts] which stores the the starting time and the ending time of each continuous section. CALLING SEQUENCE: btrange = thm_jbt_get_btrange(tvar, nbursts=nbursts, tind=tind) ARGUMENTS: tvar: (INPUT, REQUIRED). The name of a tplot variable. KEYWORDS: nbursts: (OUTPUT, OPTIONAL) A named variable to return the number of sections. tind: (OUTPUT, OPTIONAL) A named variable to return a 2D array of the index of starting and ending time points with structure [[starting],[ending]] EXAMPLES: tvar = 'tha_efp' btrange = thm_jbt_get_btrange(tvar, nb = nb, tind = tind) HISTORY: 2009-05-04, written by Jianbao Tao, in CU/LASP. 2010-04-08: Updated the help information. JBT, CU/LASP.

Routines

top source thm_jbt_get_btrange

result = thm_jbt_get_btrange(tvar, nbursts=nbursts, tind=tind, tlen=tlen)

Parameters

tvar

Keywords

nbursts
tind
tlen

File attributes

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