This page was created by the IDL library routine mk_html_help2.

Last modified: Fri Feb 10 22:18:00 2012.


Directory Listing of Routines


Routine Descriptions

ERG_LOAD_SDFIT

[Next Routine] [List of Routines]
 PROCEDURE erg_load_sdfit

 PURPOSE:
    Load fitacf CDF files of SuperDARN as tplot variables.



 :KEYWORDS:
    sites: 3-letter code of SD radar name. 
           Currently only the following codes work: 
           'hok', 'ksr'  
    cdffn: File path of a CDF file if given explicitly. 
    get_support_data: Turn this on to load the supporting data 
    trange: time range for which data are loaded. 
            e.g., ['2008-10-01/00:00:00','2008-10-02/00:00:00'] 

 :AUTHOR: 
     Tomo Hori (E-mail: horit at stelab.nagoya-u.ac.jp)
 :HISTORY:
   2010/03/09: Created as a draft version
   2010/07/01: now work for hok and ksr
   2010/09/10: added some keywords

(See iugonet/erg_ground/radar/superdarn/erg_load_sdfit.pro)


GET_FIXED_PIXEL_GRAPH

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

 :DESCRIPTION:
 	Generate a tplot variable containing data values for 
 	a fixed pixel, with given beam number and range gate number. 

 :PARAMS:
   vn: name of the tplot variable from which values for a fixed pixel are extracted 
 
 :KEYWORDS:
   beam: beam number for a pixel to be extracted
   range_gate: range gate number for a pixel to be extracted
   newvn: if a string is set, the new tplot variable is generated with a name given by this keyword
    
 :EXAMPLES:
   get_fixed_pixel_graph, 'sd_hok_vlos_1', beam=3, range_gate=65

 :AUTHOR:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/06/22: Created

 $LastChangedBy: horit $
 $LastChangedDate: 2011-08-20 11:23:18 +0900 (Sat, 20 Aug 2011) $
 $LastChangedRevision: 146 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/get_fixed_pixel_graph.pro $

(See iugonet/erg_ground/radar/superdarn/get_fixed_pixel_graph.pro)


GET_SPHCNTR

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

 :DESCRIPTION:
    Calculate the center position on the spherical coordinate system
    from given points. The function returns a floating-point
    array [latitude, longitude] for the center position.

 :PARAMS:
    latarr, lonarr:
    Arrays containing latitudes and longitudes, respectively, of
    given points on the spherical coordinate system. Any dimension,
    size is acceptable as long as both arrays have the same
    dimension/size.

 :EXAMPLES:
   To get the center of points [lat1,lon1], [lat2,lon2], and
   [lat3,lon3],

   pos = get_sphcntr( [lat1,lat2,lat3], [lon1,lon2,lon3] )

 :AUTHOR:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/01/07: Created

 $LastChangedBy: horit $
 $LastChangedDate: 2011-01-13 16:53:19 +0900 (Thu, 13 Jan 2011) $
 $LastChangedRevision: 98 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/get_sphcntr.pro $

(See iugonet/erg_ground/radar/superdarn/get_sphcntr.pro)


LOADCT_SD

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE loadct_sd
 
 :DESCRIPTION:
 Basically this procedure is the same as loadct2.pro except for
 yellow (color=5) replaced with grey. In addition, if you run 
 this with an argument of 44 (e.g., loadct_sd, 44), then it 
 loads the Cutlass color table often used for SuperDARN data. 
 
 :AUTHOR:
   Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)
 :HISTORY:
   2010/11/20: created 
 
 $LastChangedBy: horit $
 $LastChangedDate: 2011-11-17 20:42:32 +0900 (Thu, 17 Nov 2011) $
 $LastChangedRevision: 160 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/loadct_sd.pro $

(See iugonet/erg_ground/radar/superdarn/loadct_sd.pro)


OVERLAY_MAP_COAST

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

 :Description:
		Draw the world map on the plot window set up by map_set. 


	:Keywords:
    fill:      Set to fill the continents
    col:       Set the color index to draw the coast lines with 
                 (Usually the time should be set by sd_time)
    static:    Set to plot on the MLAT-MLON grid, not the MLAT-MLT. 
               This keyword does nothing when keyword geo_plot is set. 
    time:      Set the time (in UNIX time) to calculate the AACGM coords 
               of the map for. Do nothing with keyword geo_plot on.  
    geo_plot:  Set to draw in geographical coordinates
    position:  Set to draw the map at the designated position in the plot window

 :EXAMPLES:
   overlay_map_coast     (to draw the world map in AACGM)

 :Author:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/11/10: Created
 	2011/06/15: renamed to overlay_map_coast

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

(See iugonet/erg_ground/radar/superdarn/overlay_map_coast.pro)


OVERLAY_MAP_SDFIT

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

 :DESCRIPTION:
    Plot a 2-D scan data of a SD radar on the plot window set up by map_set.

 :PARAMS:
    datvn:   tplot variable names (as strings) to be plotted

 :KEYWORDS:
    time:    Set the time (UNIX time) to plot a 2-D scan for
    position:  Set the location of the plot frame in the plot window
    erase:   Set to forcibly erase the plot window before plotting data
    clip:    Set to scale in to get a magnified map
    geo_plot:  Set to plot in the geographical coordinates
    nogscat: Set to prevent the ground scatter data from appearing on the plot
    notimelabel: Set to prevent the time label from appearing on the plot
    nocolorscale: Set to surpress drawing the color scale 
    colorscalepos: Set the position of the color scale in the noraml 
                   coordinates. Default: [0.85, 0.1, 0.87, 0.45] 

 :AUTHOR:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/01/11: Created
 	2011/06/15: renamed to overlay_map_sdfit

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

(See iugonet/erg_ground/radar/superdarn/overlay_map_sdfit.pro)


PLOT_MAP_SDFIT

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

 PURPOSE:
		Draw a fan plot of SD data on the world map

	:Params:
    var:   tplot variable to be plotted

	:Keywords:
    noerase:     Set to plot data without erasing the screen 
    clip:        Set to scale in to get a magnified map
    position:    Set the location of the plot frame in the plot window
    center_glat: geographical latitude at which a plot region is centered
    center_glon: geographical longitude at which a plot region is centered
    mltlabel:    Set to draw the MLT labels every 2 hour
    lonlab:      a latitude from which (toward the poles) the MLT labels are drawn
    force_scale: Forcibly put a given value in "scale" of map_set
    geo_plot:    Set to plot in the geographical coordinates
    coast:      Set to superpose the world map on the plot
    nocolorscale: Set to surpress drawing the color scale 
    colorscalepos: Set the position of the color scale in the noraml 
                   coordinates. Default: [0.85, 0.1, 0.87, 0.45] 

 :EXAMPLES:
   plot_map_sdfit, 'sd_hok_vlos_bothscat'
   plot_map_sdfit, 'sd_hok_vlos_bothscat', center_glat=70., center_glon=180. 
   
 :Author:
 	Tomo Hori (E-mail: horit at stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/03/11: Created
 	2011/06/15: Renamed to plot_map_sdfit

(See iugonet/erg_ground/radar/superdarn/plot_map_sdfit.pro)


SD_INIT

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE sd_init
 
 :DESCRIPTION:
    Initialize the environment for drawing SD data 

 :NOTE:
    This procedure is called automatically on executing most of 
    sd_*.pro.   
    

 :AUTHOR: 
   Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)
 :HISTORY: 
   2010/03/10: Created
 
 $LastChangedBy: horit $
 $LastChangedDate: 2011-10-06 19:21:38 +0900 (Thu, 06 Oct 2011) $
 $LastChangedRevision: 155 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/sd_init.pro $

(See iugonet/erg_ground/radar/superdarn/sd_init.pro)


SD_MAP_SET

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE/FUNCTION sd_map_set

 :DESCRIPTION:
		A wrapper routine for the IDL original "map_set" enabling some
		annotations regarding the visualization of SD data.

	:PARAMS:
    time:   time (in double Unix time) for which the magnetic local time for the
            world map is calculated. In AACGM plots, the magnetic local noon comes
            on top in plot.

	:KEYWORDS:
    erase:   set to erase pre-existing graphics on the plot window.
    clip:    set to zoom in roughly to a region encompassing a field of view of one radar.
             Actually 30e+6 (clip is on) or 50e+6 (off) is put is "scale" keyword of map_set.
    position:  gives the position of a plot panel on the plot window as the normal coordinates.
    center_glat: geographical latitude at which a plot region is centered.
    center_glon: geographical longitude at which a plot region is centered.
                 (both center_glat and center_glon should be given, otherwise ignored)
    mltlabel:    set to draw the MLT labels every 2 hour.
    lonlab:      a latitude from which (toward the poles) the MLT labels are drawn.
    force_scale:   Forcibly put a given value in "scale" of map_set.
    stereo: Use the stereographic mapping, instead of satellite mapping (default)

 :EXAMPLES:
    sd_map_set
    sd_map_set, /clip, center_glat=70., center_glon=180., /mltlabel, lonlab=74.

 :AUTHOR:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/01/11: Created

 $LastChangedBy: horit $
 $LastChangedDate: 2011-11-17 20:42:32 +0900 (Thu, 17 Nov 2011) $
 $LastChangedRevision: 160 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/sd_map_set.pro $

(See iugonet/erg_ground/radar/superdarn/sd_map_set.pro)


SD_TIME

[Previous Routine] [Next Routine] [List of Routines]
 PROCEDURE/FUNCTION sd_time

 :Description:
		Describe the procedure/function.

	:Params:
    time:  Set the time for which a 2-D scan data is plotted

	:Keywords:
    quiet:   If not set, then the plot time is shown in the command-line console

 :EXAMPLES:
   sd_time, '2007-03-24/14:24' 
   sd_time, 1424 

 :Author:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2011/01/11: Created
 	
 $LastChangedBy: horit $
 $LastChangedDate: 2011-01-13 16:53:19 +0900 (Thu, 13 Jan 2011) $
 $LastChangedRevision: 98 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/sd_time.pro $

(See iugonet/erg_ground/radar/superdarn/sd_time.pro)


SET_COORDS

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

 :DESCRIPTION:
   Transform the coordinate system of SD RTI-plot-type tplot 
   variables.

 :PARAMS:
   tplot_vars: tplot variables to be transformed
   coord:      the coordinate system to which tplot variables 
               are transformed to. 
               Options currently available are:
               'mlat', 'gate', 'glat'

 :EXAMPLES:
   set_coords, 'sd_hok_vlos_1', 'mlat'

 :AUTHOR:
 	Tomo Hori (E-mail: horit@stelab.nagoya-u.ac.jp)

 :HISTORY:
 	2010/11/18: Created
   2011/01/07: added glat to coordinate option
 
 $LastChangedBy: horit $
 $LastChangedDate: 2011-06-20 22:42:07 +0900 (Mon, 20 Jun 2011) $
 $LastChangedRevision: 135 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/set_coords.pro $

(See iugonet/erg_ground/radar/superdarn/set_coords.pro)


SPECPLOT

[Previous Routine] [Next Routine] [List of Routines]
PROCEDURE specplot,x,y,z
NAME:
   specplot
PURPOSE:
   Creates a spectrogram plot.
   All plot limits and plot positions are handled by the keyword LIMITS.
INPUT:
   x:  xaxis values:  dimension N.
   y:  yaxis values:  dimension M.  (Future update will allow (N,M))
   Z:  color axis values:  dimension (N,M).

   All options are passed in through a single structure.
KEYWORDS:
   LIMITS:  A structure that may contain any combination of the following
       elements:
       X_NO_INTERP:   Prevents interpolation along the x-axis.
       Y_NO_INTERP:   Prevents interpolation along the y-axis.
       NO_INTERP:     Prevents interpolation along either axis
       NO_COLOR_SCALE: Prevents drawing of color bar scale.
       BOTTOM, TOP:   Sets the bottom and top colors for byte-scaling
       ALL plot keywords such as:
       XLOG,   YLOG,   ZLOG,
       XRANGE, YRANGE, ZRANGE,
       XTITLE, YTITLE,
       TITLE, POSITION, REGION  etc. (see IDL documentation for a description)
         The following elements can be included in LIMITS to effect DRAW_COLOR_SCALE:
       ZTICKS, ZRANGE, ZTITLE, ZPOSITION, ZOFFSET
   DATA:  A structure that provides an alternate means of supplying
       the data and options.  This is the method used by "TPLOT".
   X_NO_INTERP:   Prevents interpolation along the x-axis.
   Y_NO_INTERP:   Prevents interpolation along the y-axis.
   OVERPLOT:      If non-zero then data is plotted over last plot.
   OVERLAY:       If non-zero then data is plotted on top of data from last
        last plot.
   PS_RESOLUTION: Post Script resolution.  Default is 150.
   NO_INTERP:     If set, do no x or y interpolation.
   IGNORE_NAN:    If nonzero, ignore data points that are not finite.
   DX_GAP_SIZE = Maximum time gap over which to interpolate the plot. Use this
     keyword when overlaying spectra plots, allowing the underlying spectra to
     be shown in the data gaps of the overlying spectra.  Overrides value set
     by DATAGAP in dlimits.  Note: if either DX_GAP_SIZE or DATAGAP is set to
     less than zero, then the 20 times the smallest delta x is used.

Notes:
  - The arrays x and y MUST be monotonic!  (increasing or decreasing)
  - The default is to interpolate in both the x and y dimensions.
  - Data gaps can be included by setting the z values to NAN  (!values.f_nan).
  - If ZLOG is set then non-positive zvalues are treated as missing data.

See Also:  "XLIM", "YLIM", "ZLIM",  "OPTIONS",  "TPLOT", "DRAW_COLOR_SCALE"
Author:  Davin Larson,  Space Sciences Lab
 $LastChangedBy: horit $
 $LastChangedDate: 2011-01-13 16:53:19 +0900 (Thu, 13 Jan 2011) $
 $LastChangedRevision: 98 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/specplot.pro $
 
 This procedure (the original version is included in TDAS) has been modified 
 by Tomo Hori, STE lab. (E-mail: horit@stelab.nagoya-u.ac.jp) to support a 
 function of painting pixels with a fixed color given as "fill_color" 
 attribute stored in the dlimit structure in a tplot variable. 
 This function is to be incorporated into the "official" specplot.pro in the 
 TDAS distribution in near future (maybe in TDAS ver 6.0).  

(See iugonet/erg_ground/radar/superdarn/specplot.pro)


SPLITBEAM

[Previous Routine] [List of Routines]
 :DESCRIPTION:
    Divide tplot variables including all beams into that for each beam.

 :EXAMPLE:
    splitbeam, 'sd_hok_vlos_0'

 :Author:
    Tomoaki Hori (E-mail: horit@stelab.nagoya-u.ac.jp)
 :HISTORY:
    2010/03/02: Created

 $LastChangedBy: horit $
 $LastChangedDate: 2011-06-10 04:24:38 +0900 (Fri, 10 Jun 2011) $
 $LastChangedRevision: 131 $
 $URL: http://gemsissc.stelab.nagoya-u.ac.jp/svn/ergsc/trunk/erg/ground/radar/superdarn/splitbeam.pro $

(See iugonet/erg_ground/radar/superdarn/splitbeam.pro)