This page was created by the IDL library routine `mk_html_help2`.

Last modified: Mon Nov 5 01:15:46 2012.

# Directory Listing of Routines

# ssl_general/missions/rbsp/efw/utils

- JBT_DATE2JDAY (FUNCTION)
  Convert a date string in format 'yyyy-mm-dd', such as '2012-10-16', into a
- JBT_FEXIST (FUNCTION)
  Check the existence of a local file. Return 1 if the file exists, or 0 if
- JBT_FILE_LATEST (FUNCTION)
  Return the path of the latest file within a folder.
- [6]
  Retrieve a list of files on a remote directory accessible via http.
- JBT_GET_LINES (FUNCTION)
  Get all lines of a text file.
- JBT_JDAY2DATE (FUNCTION)
  Convert a longword integer Julian day number into a date string in format
- JBT_TPLOT_POS (FUNCTION)
  Get the positions of tplot panels. The returned array has the form
- RBSP_BTRANGE (PROCEDURE)
  This routine is to find the starting time and ending time of each
- TPLOT_ZOOM (PROCEDURE)
  This is basically a wrapper of some of the functions of tlimit and timebar.

# Routine Descriptions

## JBT_DATE2JDAY (FUNCTION)

[Next Routine] [List of Routines]

     NAME:
       jbt_date2jday (function)

     PURPOSE:
       Convert a date string in format 'yyyy-mm-dd', such as '2012-10-16', into a
       longword integer Julian day number.

     CATEGORIES:
       Utilities

     CALLING SEQUENCE:
       result = jbt_date2jday(date)

     ARGUMENTS:
       date: (In, required) A date string in format 'yyyy-mm-dd', such as
             '2012-10-16'.

     KEYWORDS:

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2012-11-02: Created by Jianbao Tao (JBT), SSL, UC Berkley.
       2012-11-02: Initial release to TDAS. JBT, SSL/UCB.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_date2jday.pro $

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

## JBT_FEXIST (FUNCTION)

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       jbt_fexist (function)

     CATEGORY:

     PURPOSE:
       Check the existence of a local file. Return 1 if the file exists, or 0 if
       not.

     CALLING SEQUENCE:
       result = jbt_fexist(file)

     ARGUMENTS:
       file: (In, required) A string of a local file to be checked.

     KEYWORDS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2011-05-01: Created by Jianbao Tao (JBT), CU/LASP.
       2012-11-02: Initial release to TDAS. JBT, SSL/UCB.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_fexist.pro $

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

## JBT_FILE_LATEST (FUNCTION)

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       jbt_file_latest (function)

     PURPOSE:
       Return the path of the latest file within a folder.

     CATEGORIES:

     CALLING SEQUENCE:
       result = jbt_file_latest(dir)

     ARGUMENTS:
       dir: (In, required) A string of a local directory.

     KEYWORDS:

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2012-10-28: Created by Jianbao Tao (JBT), SSL, UC Berkley.
       2012-11-02: Initial release to TDAS. JBT, SSL/UCB.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_file_latest.pro $

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

## JBT_GET_LINES (FUNCTION)

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       jbt_get_lines (function)

     PURPOSE:
       Get all lines of a text file.

     CATEGORY:

     CALLING SEQUENCE:
       result = jbt_get_lines(file)

     ARGUMENTS:
       file: (In, required) A string of a local text file to load.

     KEYWORDS:

     COMMON BLOCKS:

     SIDE EFFECTS:

     RESTRICTIONS:

     EXAMPLE:

     SEE ALSO:

     MODIFICATION HISTORY:
       2011-05-27: Created by Jianbao Tao, CU/LASP.
       2012-11-02: Initial release to TDAS. JBT, SSL/UCB.

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

## JBT_JDAY2DATE (FUNCTION)

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       jbt_jday2date (function)

     PURPOSE:
       Convert a longword integer Julian day number into a date string in format
       'yyyy-mm-dd', such as '2012-10-16'.

     CATEGORIES:

     CALLING SEQUENCE:
       result = jbt_jday2date(jday)

     ARGUMENTS:
       jday: (In, required) A longword integer Julian day number.

     KEYWORDS:

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2012-11-02: Created by Jianbao Tao (JBT), SSL, UC Berkley.
       2012-11-02: Initial release to TDAS.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_jday2date.pro $

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

## JBT_TPLOT_POS (FUNCTION)

[Previous Routine] [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.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_tplot_pos.pro $

(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] [Next Routine] [List of Routines]

     NAME:
       tplot_zoom (procedure)

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

     CATEGORY:
       Widget

     CALLING SEQUENCE:
       tplot_zoom, reset = reset

       Use following calls to change the styles of time bars and y-bars (horizontal
       bars).

         tplot_zoom_set_ybar, linestyle = linestyle, color = color, $
           thick = thick, reset = reset
         tplot_zoom_set_tbar, linestyle = linestyle, color = color, $
           thick = thick, reset = reset

     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. (Obsolete comment. JBT, 2012-10-31)
             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.
       2012-10-31: JBT, SSL/UCB. Initial release in TDAS.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/tplot_zoom.pro $

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

## [6]

[Previous Routine] [List of Routines]

     NAME:

     PURPOSE:
       Retrieve a list of files on a remote directory accessible via http.

     CATEGORIES:
       Utilities

     CALLING SEQUENCE:
       result = jbt_fileurls(remote_dir, verbose = verbose)

         remote_dir must a valid http directory, such as:
         http://themis.ssl.berkeley.edu/data/rbsp/teams/spice/mk/

     ARGUMENTS:
       remote_dir: (In, required) See above.

     KEYWORDS:
       verbose: Set this keyword to 0 if one wants to suppress verbose screen
             output.

     COMMON BLOCKS:

     EXAMPLES:

     SEE ALSO:

     HISTORY:
       2012-10-27: Created by Jianbao Tao (JBT), SSL, UC Berkley.
       2012-11-02: Initial release to TDAS.

     VERSION:
     $LastChangedBy: jianbao_tao $
     $LastChangedDate: 2012-11-02 16:35:10 -0700 (Fri, 02 Nov 2012) $
     $LastChangedRevision: 11172 $
     $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/missions/rbsp/efw/utils/jbt_fileurls.pro $

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