This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Aug 6 12:53:14 2020.


Directory Listing of Routines


Routine Descriptions

CRIB_CALC

[Next Routine] [List of Routines]
procedure:  crib_calc.pro

purpose: demonstrate how to use the mini-language program 'calc'

usage:
 .run crib_calc


Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: pcruce $
 $LastChangedDate: 2016-06-16 16:39:01 -0700 (Thu, 16 Jun 2016) $
 $LastChangedRevision: 21333 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_calc.pro $

(See general/examples/crib_calc.pro)


CRIB_CLEAN_SPIKES

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE:
  crib_clean_spikes.pro

PURPOSE: 
  demonstrates some aspects of the clean_spikes procedure

USAGE:
 .run crib_clean_spikes


WARNING: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: jimm $
 $LastChangedDate: 2020-03-16 12:05:08 -0700 (Mon, 16 Mar 2020) $
 $LastChangedRevision: 28416 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_clean_spikes.pro $

(See general/examples/crib_clean_spikes.pro)


CRIB_COLORS

[Previous Routine] [Next Routine] [List of Routines]
 Name: crib_colors

 Purpose: Crib on how to set colors for line plots and spectrograms

 Notes: Run it by typing in IDL command line:
           .compile crib_colors
           .go
           .c
        or copy and paste.

 Colors in SPEDAS:

   To view the currently loaded color table, use: xpalette
   To retrieve a color index by its name, use the routine: spd_get_color (e.g., blue = spd_get_color('blue'))
       see the header of spd_get_color for supported colors
   To load the default color table for SPEDAS, type: init_crib_colors
   The procedure loadct2 loads a color table and changes 8 colors (the first 7 and the last) to these:
       [black, magenta, blue, cyan, green, yellow, red, white]
   The last color in the table is used as the plot background, and it is usually white.
   The first 7 colors are used in line plots, usually with the following order:
       [blue, green, red, black, yellow, magenta, cyan]
   The user can specify these 8 colors, using:
       loadct2, 65, line_clr=line_clr
       where line_clr is an array of 8 RGB colors: [[0,0,0],...,[255,255,255]]
   For tplot, you can pick which colors of the color table to use in line plots, with the command "options", ie:
       options, 'tplot_name', colors=[1,2,3]
   Directory general/misc/system contains the default color table 'colors1.tbl',
       and also 'cbcolors2.tbl' which is a copy of IDL color table 65.
   For IDL versions before IDL 8.6, the IDL colortable 65 can be loaded using:
       loadct2, 15, file='cbcolors2.tbl', line_clr=1
   Users can create their own color tables, and then save them in a file using:
       TVLCT, red, green, blue, /GET
       MODIFYCT, 14, 'My Table Name', red, green, blue, FILE='/path/to/file'
   and then load them using:
       loadct2, 14, file='/path/to/file', line_clr=1

 For a color picker with colorblind choices, see:
    http://colorbrewer2.org/#type=sequential&scheme=GnBu&n=6


Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib.

 $LastChangedBy:$
 $LastChangedDate:$
 $LastChangedRevision:$
 $URL:$

(See general/examples/crib_colors.pro)


CRIB_DPROC

[Previous Routine] [Next Routine] [List of Routines]
procedure:  crib_dproc.pro

purpose: demonstrate basic data processing operations

usage:
 .run crib_dproc


Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: nikos $
 $LastChangedDate: 2020-03-05 11:35:38 -0800 (Thu, 05 Mar 2020) $
 $LastChangedRevision: 28374 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_dproc.pro $

(See general/examples/crib_dproc.pro)


CRIB_HAPI

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_hapi

 PURPOSE:  
       Demonstrates how to query Heliophysics API (HAPI) servers and download, load and plot data from them

 NOTES:
       hapi_load_data requires IDL 8.3 or later due to usage of IDL's json_parse + orderedhash

 $LastChangedBy: egrimes $
 $LastChangedDate: 2018-11-19 09:13:20 -0800 (Mon, 19 Nov 2018) $
 $LastChangedRevision: 26148 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_hapi.pro $

(See general/examples/crib_hapi.pro)


CRIB_HASH_TABLES_BASIC

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

NAME:
  crib_hash_tables_basic

PURPOSE:
  This crib sheet shows how to work with the IDL data structures: hash and orderedhash


 Hash tables are very useful, efficient data structures that allow quick mapping of keys to values:
 
   https://www.harrisgeospatial.com/docs/HASH.html (added to IDL in 8.0)
   
   https://www.harrisgeospatial.com/docs/orderedhash.html (added to IDL in 8.4)
   
   

 $LastChangedBy: egrimes $
 $LastChangedDate: 2019-08-12 13:50:35 -0700 (Mon, 12 Aug 2019) $
 $LastChangedRevision: 27596 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_hash_tables_basic.pro $

(See general/examples/crib_hash_tables_basic.pro)


CRIB_HIGHLIGHT_TIME_INTERVAL

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_fill_time_intv
 
 PURPOSE:  Crib to demonstrate thte fill_time_intv option for tplot
           You can run this crib by typing:
           IDL>.compile crib_fill_time_intv
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)

 NOTES:
  1.  As a rule of thumb, "tplot_options" controls settings that are global to any tplot
   "options" controls settings that are specific to a tplot variable
   
  2.  If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: jimm $
 $LastChangedDate: 2019-11-15 11:21:00 -0800 (Fri, 15 Nov 2019) $
 $LastChangedRevision: 28024 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_highlight_time_interval.pro $

(See general/examples/crib_highlight_time_interval.pro)


CRIB_PLOTXY

[Previous Routine] [Next Routine] [List of Routines]
 Name: crib_plotxy

 Purpose: crib to demonstrate capabilities of plotxy

 Notes: run it by compiling in idl and then typing ".go"
        or copy and paste.

Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: adrozdov $
 $LastChangedDate: 2018-01-23 20:38:14 -0800 (Tue, 23 Jan 2018) $
 $LastChangedRevision: 24575 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_plotxy.pro $

(See general/examples/crib_plotxy.pro)


CRIB_PLOTXYVEC

[Previous Routine] [Next Routine] [List of Routines]
 Name: crib_plotxyvec

 Purpose:crib to demonstrate capabilities of plotxyvec

 Notes: run it by compiling in idl and then typing ".go"
        or copy and paste.

 The options:  hsize,color,hthick,solid, & thick from the arrow
    routine are usable in this routine.

;Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib



 $LastChangedBy: pcruce $
 $LastChangedDate: 2013-12-16 17:46:48 -0800 (Mon, 16 Dec 2013) $
 $LastChangedRevision: 13689 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_plotxyvec.pro $

(See general/examples/crib_plotxyvec.pro)


CRIB_PLOTXYZ

[Previous Routine] [Next Routine] [List of Routines]
 Name: crib_plotxyz

 Purpose:crib to demonstrate capabilities of plotxyz

 Notes: run it by compiling in idl and then typing ".go"
        or copy and paste.

 SEE ALSO: bin1d.pro,bin2d.pro,plotxyz.pro

Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: adrozdov $
 $LastChangedDate: 2018-01-23 20:38:14 -0800 (Tue, 23 Jan 2018) $
 $LastChangedRevision: 24575 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_plotxyz.pro $

(See general/examples/crib_plotxyz.pro)


CRIB_TPLOT

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot
 
 PURPOSE:  Updated crib to demonstrate tplot basics. 
           You can run this crib by typing:
           IDL>.compile crib_tplot
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line
           
           


 SEE ALSO: crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: jimm $
 $LastChangedDate: 2019-03-25 14:31:57 -0700 (Mon, 25 Mar 2019) $
 $LastChangedRevision: 26896 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot.pro $

(See general/examples/crib_tplot.pro)


CRIB_TPLOTXY

[Previous Routine] [Next Routine] [List of Routines]
 Name: crib_tplotxy

 Purpose:crib to demonstrate capabilities of tplotxy

 Notes: run it by compiling in idl and then typing ".go"
        or copy and paste.
        
Warning: this crib uses some data from the THEMIS branch.  You'll require those routines to run this crib

 $LastChangedBy: adrozdov $
 $LastChangedDate: 2018-01-23 20:38:14 -0800 (Tue, 23 Jan 2018) $
 $LastChangedRevision: 24575 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplotxy.pro $

(See general/examples/crib_tplotxy.pro)


CRIB_TPLOT_ANNOTATION

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_annotation
 
 PURPOSE:  Crib to demonstrate tplot annotation commands  
           You can run this crib by typing:
           IDL>.compile crib_tplot_annotation
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)


 NOTES:
  1.  As a rule of thumb, "tplot_options" controls settings that are global to any tplot
   "options" controls settings that are specific to a tplot variable
   
  2.  If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: crussell $
 $LastChangedDate: 2019-06-18 13:18:02 -0700 (Tue, 18 Jun 2019) $
 $LastChangedRevision: 27357 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_annotation.pro $

(See general/examples/crib_tplot_annotation.pro)


CRIB_TPLOT_EXPORT_PRINT

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_export_print
 
 PURPOSE:  Crib to demonstrate tplot export commands
           You can run this crib by typing:
           IDL>.compile crib_tplot_export
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: egrimes $
 $LastChangedDate: 2018-02-08 09:11:39 -0800 (Thu, 08 Feb 2018) $
 $LastChangedRevision: 24671 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_export_print.pro $

(See general/examples/crib_tplot_export_print.pro)


CRIB_TPLOT_LAYOUT

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_layout
 
 PURPOSE:  Crib to demonstrate tplot layout commands  
           You can run this crib by typing:
           IDL>.compile crib_tplot_layout
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)
           crib_tplot_overlay.pro(how to overlay spectral plots)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: pcruce $
 $LastChangedDate: 2013-12-16 14:43:09 -0800 (Mon, 16 Dec 2013) $
 $LastChangedRevision: 13679 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_layout.pro $

(See general/examples/crib_tplot_layout.pro)


CRIB_TPLOT_MULTIAXIS

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_multiaxis
 
 PURPOSE:  Demonstrate how to create plots with two y axes.

           You can run this crib by typing:
           IDL>.compile crib_tplot_multiaxis
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro             (basic tplot commands)
           crib_tplot_range.pro       (how to control the range and scaling of plots)
           crib_tplot_layout.pro      (how to arrange plots within a window, and data within a plot)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)
           crib_tplot_overlay.pro     (how to overlay spectral plots)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.



$LastChangedBy: aaflores $
$LastChangedDate: 2016-05-25 16:37:13 -0700 (Wed, 25 May 2016) $
$LastChangedRevision: 21212 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_multiaxis.pro $

(See general/examples/crib_tplot_multiaxis.pro)


CRIB_TPLOT_RANGE

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_range
 
 PURPOSE:  Crib to demonstrate tplot range commands  
           You can run this crib by typing:
           IDL>.compile crib_tplot_range
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.


 $LastChangedBy: pcruce $
 $LastChangedDate: 2013-12-16 14:43:09 -0800 (Mon, 16 Dec 2013) $
 $LastChangedRevision: 13679 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_range.pro $

(See general/examples/crib_tplot_range.pro)


CRIB_TPLOT_TICKS

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_ticks
 
 PURPOSE:  Crib to demonstrate tplot annotation commands  
           You can run this crib by typing:
           IDL>.compile crib_tplot_ticks
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)
           crib_tplot_ticks.pro (how to control plot tick settings, thickness,length, number, etc...)


 NOTES:
  1.  As a rule of thumb, "tplot_options" controls settings that are global to any tplot
   "options" controls settings that are specific to a tplot variable
   
  2.  If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: pcruce $
 $LastChangedDate: 2013-12-16 14:43:09 -0800 (Mon, 16 Dec 2013) $
 $LastChangedRevision: 13679 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_ticks.pro $

(See general/examples/crib_tplot_ticks.pro)


CRIB_TPLOT_TIMEBAR_DATABAR

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_timebar_databar
 
 PURPOSE:  Crib to demonstrate tplot timebar and databar commands  
           You can run this crib by typing:
           IDL>.compile crib_tplot_timebar_databar
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot.pro  (basic tplot commands)
           crib_tplot_layout.pro  (how to arrange plots within a window, and data within a plot)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)

 NOTES:
  1.  As a rule of thumb, "tplot_options" controls settings that are global to any tplot
   "options" controls settings that are specific to a tplot variable
   
  2.  If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: jimm $
 $LastChangedDate: 2016-08-29 12:56:08 -0700 (Mon, 29 Aug 2016) $
 $LastChangedRevision: 21765 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_timebar_databar.pro $

(See general/examples/crib_tplot_timebar_databar.pro)


CRIB_TPLOT_WINDOW

[Previous Routine] [Next Routine] [List of Routines]
 NAME: crib_tplot_window
 
 PURPOSE:  Crib to demonstrate tplot layout commands, using
           tplot_window instead of tplot
           You can run this crib by typing:
           IDL>.compile crib_tplot_window
           IDL>.go
           
           When you reach a stop, press
           IDL>.c
           to continue
           
           Or you can copy and paste commands directly onto the command line

 SEE ALSO: crib_tplot_window.pro  (basic tplot commands)
           crib_tplot_range.pro   (how to control the range and scaling of plots)
           crib_tplot_annotation.pro  (how to control labels, titles, and colors of plots)
           crib_tplot_export_print.pro (how to export images of plots into pngs and postscripts)
           crib_tplot_overlay.pro(how to overlay spectral plots)

 NOTES:
   If you see any useful commands missing from these cribs, please let us know.
   these cribs can help double as documentation for tplot.

 $LastChangedBy: jimm $
 $LastChangedDate: 2016-10-21 11:06:02 -0700 (Fri, 21 Oct 2016) $
 $LastChangedRevision: 22186 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/examples/crib_tplot_window.pro $

(See general/examples/crib_tplot_window.pro)


INIT_CRIB_COLORS

[Previous Routine] [Next Routine] [List of Routines]
NAME: init_crib_colors

PURPOSE: Sets default plotting colors.

        *This is not a crib sheet*
        
        Defaults to black pen on white background, rainbow color scheme.

ARGUMENTS:   
   color_table: Index specifying the desired color table to be passed to LOADCT2

(See general/examples/init_crib_colors.pro)


TIME_CORRELATE_CRIB.PRO

[Previous Routine] [List of Routines]
 NAME:
       time_correlate_crib.pro 

 PURPOSE:
       crib sheet demonstrating the use of:
       ssl_general/misc/ssl_correlate_tplot
      


 CATEGORY:
       THEMIS-SOC

 CALLING SEQUENCE:
       .run time_correlate_crib.pro

 OUTPUTS:
       
 KEYWORDS:

 COMMENTS: 


 PROCEDURE:

 EXAMPLE:

 MODIFICATION HISTORY:
       Written by: Patrick Cruce(pcruce@gmail.com) 2007-05-24 V1.0

 KNOWN BUGS:

(See general/examples/time_correlate_crib.pro)