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

SPD_EXTRACT_TVAR_METADATA

[Next Routine] [List of Routines]
 FUNCTION:
         spd_extract_tvar_metadata

 PURPOSE:
         Returns metadata extracted from a tplot variable; mostly for tplot2ap and tplot2cdf

 NOTES:
         prefers the following order:
         - limits structure (set by the user during the session)
         - dlimnits structure (set by the load routine)
         - dlimits.cdf structure (stored in the CDF file)

 $LastChangedBy: egrimes $
 $LastChangedDate: 2018-03-07 15:27:45 -0800 (Wed, 07 Mar 2018) $
 $LastChangedRevision: 24849 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/spedas_tools/spd_extract_tvar_metadata.pro $

(See general/spedas_tools/spd_extract_tvar_metadata.pro)


SPD_GET_COLOR

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION:
   spd_get_color
 
 PURPOSE:
   Return color index by name
 
 SUPPORTED COLORS:
   This function does a nearest neighbor search on your colorbar, so the actual colors 
   available depend on your current colorbar; the possible options are:
      Almond                              Linen
      Antique White                       Magenta
      Aquamarine                          Maroon
      Beige                               Medium Gray
      Bisque                              Medium Orchid
      Black                               Moccasin
      Blue                                Navy
      Blue Violet                         Olive
      Brown                               Olive Drab
      Burlywood                           Orange
      Charcoal                            Orange Red
      Chartreuse                          Orchid
      Chocolate                           Pale Goldenrod
      Coral                               Pale Green
      Cornsilk                            Papaya
      Cyan                                Peru
      Dark Goldenrod                      Pink
      Dark Gray                           Plum
      Dark Green                          Powder Blue
      Dark Khaki                          Purple
      Dark Orchid                         Red
      Dark Salmon                         Rose
      Deep Pink                           Rosy Brown
      Dodger Blue                         Royal Blue
      Firebrick                           Saddle Brown
      Forest Green                        Salmon
      Gold                                Sandy Brown
      Goldenrod                           Sea Green
      Gray                                Seashell
      Green                               Sienna
      Green Yellow                        Sky Blue
      Honeydew                            Slate Gray
      Hot Pink                            Snow
      Indian Red                          Spring Green
      Ivory                               Steel Blue
      Khaki                               Tan
      Lavender                            Thistle
      Lawn Green                          Tomato
      Light Coral                         Turquoise
      Light Cyan                          Violet
      Light Gray                          Violet Red
      Light Salmon                        Wheat
      Light Yellow                        White
      Lime Green                          Yellow
 
 NOTES:
   - spd_get_color_index was heisted from get_colors, and the color table was heisted from fsc_color

   - you can change your current color table with the loadct2 procedure
   
   - you can visualize the current color table with the xpalette procedure
   
 $LastChangedBy: egrimes $
 $LastChangedDate: 2019-03-23 08:22:15 -0700 (Sat, 23 Mar 2019) $
 $LastChangedRevision: 26886 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/spedas_tools/spd_get_color.pro $

(See general/spedas_tools/spd_get_color.pro)


SPD_GET_SPECTRA_UNITS

[Previous Routine] [Next Routine] [List of Routines]
 FUNCTION:
     spd_get_spectra_units
     
 PROCEDURE:
     Returns the y-axis and z-axis units from a spectra variable's CDF metadata
 
 INPUT:
     var: spectra variable
 
 OUTPUT:
     structure containing 'yunits' and 'zunits' tags
     
     -1 if no CDF metadata found


 $LastChangedBy: egrimes $
 $LastChangedDate: 2019-07-15 08:24:00 -0700 (Mon, 15 Jul 2019) $
 $LastChangedRevision: 27445 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/spedas_tools/spd_get_spectra_units.pro $

(See general/spedas_tools/spd_get_spectra_units.pro)


SPD_GET_SYM.PRO

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
        spd_get_sym.pro

 PURPOSE:
 
        This function provides a convenient way to utilize the
        USERSYM procedure to create an extended choice of plotting
        symbols, and is intended to be used directly with the PSYM
        keyword to PLOT, OPLOT, etc.

 CALLING SEQUENCE:
 
        Result=spd_get_sym(NUMBER)

 INPUTS:
 
        NUMBER - symbol number
 
               0 : dot
               1 : filled circle
               2 : filled upward triangle
               3 : filled downward triangle
               4 : filled diamond
               5 : filled square
               6 : open circle
               7 : open upward triangle
               8 : open downward triangle
               9 : open diamond
              10 : open square
              11 : plus
              12 : X
              13 : star
              14 : filled rightfacing triangle
              15 : filled leftfacing triangle
              16 : open rightfacing triangle
              17 : open leftfacing triangle

 OUTPUTS:
 
        The function returns the symbol number to be used with the
        PSYM keyword in the PLOT, OPLOT, etc. commands

 SIDE EFFECTS:
 
        The USERSYM procedure is used to create a symbol definition.

 EXAMPLE:

        To produce a plot using open circles as plotting symbols:
 
        PLOT,X,Y,PSYM=spd_get_sym(6)

 MODIFICATION HISTORY:
 
        Martin Schultz, Harvard University, 22 Aug 1997: VERSION 1.00
        
        (with some minor changes to the information in this header by
        D. Windt, windt@bell-labs.com)

       Forked, renamed for SPEDAS by egrimes on 30 Nov 2018

(See general/spedas_tools/spd_get_sym.pro)


SPD_READ_CURRENT_VERSION

[Previous Routine] [List of Routines]
 FUNCTION:
         spd_read_current_version

 PURPOSE:
         Reads and returns the current revision # from the file svn_version_info.txt



$LastChangedBy: egrimes $
$LastChangedDate: 2017-11-17 13:19:52 -0800 (Fri, 17 Nov 2017) $
$LastChangedRevision: 24305 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_4_0/general/spedas_tools/spd_read_current_version.pro $

(See general/spedas_tools/spd_read_current_version.pro)