This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Nov 2 01:15:13 2012.


Directory Listing of Routines


Routine Descriptions

JBT_TPLOT_POS (FUNCTION)

[Next Routine] [List of Routines]
 NAME:
   jbt_tplot_pos (function)

 PURPOSE:
   Get the positions of tplot panels. The returned array has the form 
   [n_panels, 4]. The meanings of the 4 values of each panel are:
       [*, 0]: left x
       [*, 1]: bottom y
       [*, 2]: right x
       [*, 3]: top y

 CATEGORIES:

 CALLING SEQUENCE:
   pos = jbt_tplot_pos(npanels = npanels, xpos = xpos, ypos = ypos, $
   enclose = enclose)
   
   xpos and ypos store locations for plots. For example, 
       plots, xpos[0,*], ypos[0,*], color = 6 ; 6 = red
   will draw lines along the top panel frame.

 ARGUMENTS:

 KEYWORDS:
     npanels: (Output, optional)
     xpos: (Output, optional)
     ypos: (Output, optional)
     /enclose: (Input, optional)

 COMMON BLOCKS:

 EXAMPLES:

 SEE ALSO:

 HISTORY:
   2012-08-24: Created by Jianbao Tao(JBT), SSL, UC Berkeley.

(See ssl_general/missions/rbsp/efw/utils/jbt_tplot_pos.pro)


RBSP_BTRANGE (PROCEDURE)

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
   rbsp_btrange (procedure)

 PURPOSE:
     This routine is to find the starting time and ending time of each
     continuous segment (burst, usually) of a give tplot variable which
     essentially is specified by a tplot name such as 'rbspa_efw_eb2'.

 CATEGORIES:

 CALLING SEQUENCE:
   rbsp_btrange, tvar, btrange = btrange, nbursts = nbursts, tind = tind, $
                   tlen = tlen, structure = structure

 ARGUMENTS:
   tvar: (INPUT, REQUIRED). The name of a tplot variable. If keyword STRUCTURE
         is set, tvar should be a tplot data structure from get_data.

 KEYWORDS:
    btrange: (OUTPUT, OPTIONAL) A named variable to return a 2D array as
             [number_of_total_bursts, 2] which stores the the starting time and
             the ending time of each continuous burst.
    nbursts: (OUTPUT, OPTIONAL) A named variable to return the number of
           bursts.
    tind: (OUTPUT, OPTIONAL) A named variable to return a 2D array of the index
           of starting and ending time points with structure
           [[starting],[ending]]
    tlen: (OUTPUT, OPTIONAL) A named variable to return the time lengths of
          all bursts.
    /structure: If set, tvar should be a tplot data structure.

 COMMON BLOCKS:

 EXAMPLES:

 SEE ALSO:

 HISTORY:
   2012-08-23: Created by Jianbao Tao (JBT), SSL, UC Berkley.

(See ssl_general/missions/rbsp/efw/utils/rbsp_btrange.pro)


TPLOT_ZOOM (PROCEDURE)

[Previous Routine] [List of Routines]
 NAME:
   tplot_zoom (procedure)

 PURPOSE:
   This is basically a wrapper of some of the functions of tlimit and timebar.

   There are ten zooming buttons, one time-bar button, and one quit button
   in the widget. The behavior of each button is described below:
   ' + + ': Zoom in by 8 times.
   '  +  ': Zoom in by 2 times.
   ' - - ': Zoom out by 8 times.
   '  -  ': Zoom out by 2 times.
   'Click and Zoom': This equivalent to tlimit.
   ' < < ': Pan the tplot window backward by full.
   '  <  ': Pan the tplot window backward by half.
   ' > > ': Pan the tplot window forward by full.
   '  >  ': Pan the tplot window forward by half.
   'Full Time Span': Set tplot time range to the full time span as set by the
            routine TIMESPAN
   'Add Time Bar(s)': Add time bars. Right-click to return.
   'Quit': Quit the widget. It has no effect on the tplot variables in memory.

 CATEGORY:
   Widget

 CALLING SEQUENCE:
   tplot_zoom

 INPUTS:   
   None.

 SEE ALSO:
   tplot, tlimit, ctime, timebar

 MODIFICATION HISTORY:
   2011-09-06: Created by Jianbao Tao (JBT) at CU/LASP for REE, JBT's PhD
               advisor, to demo tplot capabilities in a MMS meeting.
   2012-06-15: JBT, CU/LASP. 
         1. Updated the documentation header.
         2. Cleaned the code.
   2012-06-26: JBT, CU/LASP. 
         1. Added more comments.
         2. Replaced 'Zoom In', 'Zoom Out', 'Pan Forward', and 'Pan Backward'
            buttons with ' + + ', '  +  ', '  -  ', ' - - ', ' < < ', '  <  ',
            '  >  ', and ' > > ' buttons.
         3. Added the 'Full Time Span' and 'Add Time Bar(s)' buttons.

(See ssl_general/missions/rbsp/efw/utils/tplot_zoom.pro)