This page was created by the IDL library routine mk_html_help2.

Last modified: Tue May 7 11:36:21 2013.

Directory Listing of Routines

ssl_general/missions/rbsp/efw/utils

EXPAND_TILDE()
Expand tilde in UNIX directory names
JBT_DATE2JDAY (FUNCTION)
Convert a date string in format 'yyyy-mm-dd', such as '2012-10-16', into a
JBT_EXTREMA (FUNCTION)
Find extrema in a numerical array and return their indices.
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.
[5]
Retrieve a list of files on a remote directory accessible via http.
JBT_GET_LINES (FUNCTION)
Get all lines of a text file.
JBT_ICONSEC (FUNCTION)
Given an array of indices, find consecutive sections in the array, and
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
RBSP_DECIMATE (PROCEDURE)
Decimate a tplot variable. Be default, the routine only decimate the input
TPLOT_ZOOM (PROCEDURE)
This is basically a wrapper of some of the functions of tlimit and timebar.
TPLOT_ZOOM_COM

Routine Descriptions

EXPAND_TILDE()

 NAME:
      EXPAND_TILDE()
               
 PURPOSE: 
       Expand tilde in UNIX directory names
               
 CALLING SEQUENCE: 
       IDL> output=expand_tilde(input)
    
 INPUTS: 
       INPUT = input file or directory name, scalar string

 OUTPUT:
       Returns expanded filename, scalar string
               
 EXAMPLES: 
       output=expand_tilde('~zarro/test.doc')
               ---> output='/usr/users/zarro'

 NOTES:
       This version of EXPAND_TILDE differs from the version in the Solar
       Library in that it does not call the functions EXIST and IDL_RELEASE.
       However, it should work identically.
 PROCEDURE CALLS:
       None.
 REVISION HISTORY: 
       Version 1,  17-Feb-1997,  D M Zarro.  Written
       Transfered from Solar Library   W. Landsman   Sep. 1997
       Made more robust  D. Zarro/W. Landsman  Sep. 2000
       Made even more robust (since things like ~zarro weren't being expanded)
       Zarro (EITI/GSFC, Mar 2001)

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

JBT_DATE2JDAY (FUNCTION)

[Previous Routine] [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/tags/tdas_8_00/missions/rbsp/efw/utils/jbt_date2jday.pro $

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

JBT_EXTREMA (FUNCTION)

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

 NAME:
   jbt_extrema (function)

 PURPOSE:
   Find extrema in a numerical array and return their indices.

 CATEGORIES:

 CALLING SEQUENCE:
   result = jbt_extrema(array, interp_nan = interp_nan, min_only = min_only, $
     max_only = max_only, threshold = threshold)

 ARGUMENTS:
   array: (In, required) The array to find extrema in.

 KEYWORDS:
   /interp_nan: If set, remove NaNs by linear interpolation before searching
         for extrema.
   /min_only: If set, only return minima.
   /max_only: If set, only return maxima.
   threshold: (In, optional) Threshold for changing sense. For example, if
         threshold is 10 and A[i] and A[i+1] are two adjacent points in a local
         segment that generally has positive slope, then the segment will be
         treated as a full positive-slope segment if A[i+1]-A[i] > -10.
         Default = 0.

 COMMON BLOCKS:

 EXAMPLES:
     ; IDL code example
     npt = 100
     a = randomn(seed, npt)
     x = findgen(npt)
     ind = jbt_extrema(a)
     plot, x, a
     oplot, x[ind], a[ind], psym = 2, color = 6

 SEE ALSO:

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

 VERSION:
 $LastChangedBy: jianbao_tao $
 $LastChangedDate: 2012-11-12 08:36:20 -0800 (Mon, 12 Nov 2012) $
 $LastChangedRevision: 11219 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_8_00/missions/rbsp/efw/utils/jbt_extrema.pro $

(See ssl_general/missions/rbsp/efw/utils/jbt_extrema.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/tags/tdas_8_00/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/tags/tdas_8_00/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_ICONSEC (FUNCTION)

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

 NAME:
   jbt_iconsec (function)

 CATEGORY:

 PURPOSE:
   Given an array of indices, find consecutive sections in the array, and
   return the starting and ending indices of each section. The returned value
   has dimension [nsec, 2]

 CALLING SEQUENCE:
   result = jbt_iconsec(indarr, nsec = nsec, npt = npt)

 ARGUMENTS:
   indarr: (In, required) An index array.

 KEYWORDS:
   nsec: (Out, optional) Number of consective sections in indarr.
   npt: (Out, optional) Number of points in each section.

 EXAMPLES:

 SEE ALSO:

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

 VERSION:
 $LastChangedBy: jianbao_tao $
 $LastChangedDate: 2012-11-12 08:36:20 -0800 (Mon, 12 Nov 2012) $
 $LastChangedRevision: 11219 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_8_00/missions/rbsp/efw/utils/jbt_iconsec.pro $

(See ssl_general/missions/rbsp/efw/utils/jbt_iconsec.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/tags/tdas_8_00/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/tags/tdas_8_00/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)

RBSP_DECIMATE (PROCEDURE)

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

 NAME:
   rbsp_decimate (procedure)

 PURPOSE:
   Decimate a tplot variable. Be default, the routine only decimate the input
   data by one level, i.e., sample rate reduced by half.

 CATEGORIES:

 CALLING SEQUENCE:
   rbsp_decimate, tvar, upper = upper, level = level, newname = newname

 ARGUMENTS:
   tvar: (In, required) Tplot variable to be decimated.

 KEYWORDS:
   upper: (In, optional) If set, the output data's sample rate is no higher
         than the value of upper.
   level: (In, optional) Decimation level. Default = 1.
   newname: (In, optional) A tplot name for the output data. Default = tvar.

 COMMON BLOCKS:

 EXAMPLES:

 SEE ALSO:

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


 VERSION:
 $LastChangedBy: jianbao_tao $
 $LastChangedDate: 2013-03-22 15:08:33 -0700 (Fri, 22 Mar 2013) $
 $LastChangedRevision: 11874 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_8_00/missions/rbsp/efw/utils/rbsp_decimate.pro $

(See ssl_general/missions/rbsp/efw/utils/rbsp_decimate.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, horizontal = horizontal

   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

 KEYWORDS:
   /reset: In, optional
         If set, the common block tplot_zoom_com will be reset.
   /horizontal: In, optional
         If set, the shape of the widget will be a horizontal bar.

 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-28 17:48:13 -0800 (Wed, 28 Nov 2012) $
 $LastChangedRevision: 11309 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_8_00/missions/rbsp/efw/utils/tplot_zoom.pro $

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

TPLOT_ZOOM_COM

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

 NAME:
   tplot_zoom_com

 PURPOSE:


; Below is IDL code
ommon tplot_zoom_com, tbar, ybar, trange_stack, yzoom_vars, base

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

[5]

[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: jimm $
 $LastChangedDate: 2013-02-05 18:56:56 -0800 (Tue, 05 Feb 2013) $
 $LastChangedRevision: 11532 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_8_00/missions/rbsp/efw/utils/jbt_fileurls.pro $

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