map_plot

Syntax

map_plot --help
map_plot [options] cnvmapname [inxname]
map_plot -stdout [options] cnvmapname [inxname]
map_plot -png [options] cnvmapname [inxname]
map_plot -png -stdout [options] cnvmapname [inxname]
map_plot -ps [-xp xoff] [-yp yoff] [options] cnvmapname [inxname]
map_plot -ps -stdout [-xp xoff] [-yp yoff] [options] cnvmapname [inxname]
map_plot -ppm [options] cnvmapname [inxname]
map_plot -ppm -stdout [options] cnvmapname [inxname]
map_plot -ppmx [options] cnvmapname [inxname]
map_plot -ppmx -stdout [options] cnvmapname [inxname]
map_plot -xml [options] cnvmapname [inxname]
map_plot -xml -stdout [options] cnvmapname [inxname]
map_plot -x [-display display] [-xoff xoff] [-yoff yoff] [-delay delay] [options] cnvmapname [inxname]

Synopsis

Plot map and cnvmap format files.

Options

`--help`	print the help message and exit.
`--version`	print the RST version number and exit.
`-path pathname`	write the plots to the directory given by pathname.
`-cf cfname`	read command line options from the file cfname.
`-old`	the input file is a `map` format file instead of the default `cnvmap` format file.
`-def`	use a sensible set of default plot options
`-sd yyyymmdd`	plot starting from the date yyyymmdd.
`-st hr:mn`	plot starting from the time hr:mn.
`-ed yyyymmdd`	stop plotting at the date yyyymmdd.
`-et hr:mn`	stop plotting at the time hr:mn.
`-ex hr:mn`	plot an interval whose extent is hr:mn.
`-tn`	generate filenames of the form `hrmn.sc.xxx`.
`-dn`	generate filenames of the form `yyyymmdd.hrmn.sc.xxx`.
`-mn`	use the time of the midpoint of each record to generate the filename.
`-wdt width`	set the width of the plot to width.
`-hgt height`	set the height of the plot to height.
`-padpad`	set the padding around the edge of the plot to pad.
`-sf scale`	set the scale factor (magnification) to scale. The default scale factor is 1.
`-ortho`	use an orthographic projection.
`-lat lat`	center the plot on the latitude given by lat.
`-lon lon`	center the plot on the longitude given by lon.
`-latmin latmin`	adjust the scale factor so that the lowest visible latitude is latmin. Applies when the stereographic projection is used.
`-mag`	use magnetic coordinates.
`-old_aacgm`	use older AACGM magnetic coordinates instead of the default AACGM-v2 coordinates.
`-rotate`	rotate the plot so that the local noon is at the top of the plot.
`-flip`	flip the direction of the X-axis.
`-square`	force the use of a square bounding box around the plot.
`-coast`	plot coastlines.
`-fcoast`	plot filled coastlines.
`-bnd`	plot state boundaries.
`-grd`	plot a grid.
`-grdlat grdlat`	set the latitude spacing of the grid to grdlat degrees.
`-grdlon grdlon`	set the longitude spacing of the grid to grdlon degrees.
`-igrd`	plot the inverse grid, if the plot is in geographic coordinates, a geomagnetic grid is plotted, if the plot is in geomagnetic coordinates, a geographic grid is plotted.
`-igrdlat igrdlat`	set the latitude spacing of the inverse grid to grdlat degrees.
`-igrdlon igrdlon`	set the longitude spacing of the inverse grid to grdlon degrees.
`-igrdontop`	plot the inverse grid on top.
`-grdontop`	plot the grid on top.
`-tmk`	plot a clock-dial grid showing the time.
`-fov`	plot the radar field of view.
`-ffov`	plot the filled radar field of view.
`-gfov`	only plot fields of view of the radars contributing data (when using -fov and/or -ffov).
`-tmtick tick`	set the grid interval for the time clock-dial to tick hours.
`-lst`	use local solar time rather than local time.
`-term`	plot the terminator.
`-fterm`	plot a filled terminator.
`-tmlbl`	Label the time clock-dial.
`-lnewdt lnewdt`	set the line width to lnewdt.
`-bgcol aarrggbb`	set the background color to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-txtcol aarrggbb`	set the color of the text to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-grdcol aarrggbb`	set the color of the grid to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-igrdcol aarrggbb`	set the color of the inverse grid to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-cstcol aarrggbb`	set the color of the coastline to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-bndcol aarrggbb`	set the color of the state boundaries to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-lndcol aarrggbb`	set the color of the land to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-seacol aarrggbb`	set the color of the sea to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-tmkcol aarrggbb`	set the color of the time clock-dial to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-fovcol aarrggbb`	set the color of the field of view outline to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-ffovcol aarrggbb`	set the color of the filled field of view to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-vecccol aarrggbb`	if a colorkey is not used then set the color of vectors to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-ctrcol aarrggbb`	set the color of contours to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-polycol aarrggbb`	set the color of contour polygons to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-fpolycol aarrggbb`	set the color of filled contour polygons to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-hmbcol aarrggbb`	set the color of the Heppner-Maynard boundary to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-trmcol aarrggbb`	set the color of the terminator outline to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-ftrmcol aarrggbb`	set the color of the filled terminator outline to aarrggbb, specified as the hexadecimal value for the 32-bit alpha,red,green and blue component color.
`-vkey vkeyname`	load the velocity colorkey from the file vkeyname.
`-vkey_path vkey_path`	load the velocity colorkey from the custom path vkey_path.
`-pkey pkeyname`	load the colorkey used to contour polygons from the file pkeyname.
`-pkey_path pkey_path`	load the colorkey used to contour polygons from the custom path pkey_path.
`-xkey xkeyname`	load the extra colorkey (used to plot power or spectral width) from the file xkeyname.
`-xkey_path xkey_path`	load the extra colorkey from the custom path xkey_path.
`-fit`	plot the fitted two-dimensional velocity vectors.
`-raw`	plot raw line of sight velocity vectors.
`-mrg`	plot merged two-dimensional vectors.
`-mod`	plot the model vectors.
`-nopad`	combined with -mod will not show padding model zero vectors.
`-ctr`	plot potential contours.
`-poly`	plot contours as simple polygons.
`-fpoly`	plot contours as simple filled polygons.
`-maxmin`	plot the points of maximum and minimum potential.
`-hmb`	plot Heppner-Maynard boundary.
`-exc`	plot velocity vectors excluded from the fit.
`-pwr`	plot power.
`-swd`	plot spectral width.
`-avg`	if a cell contains more than one data point, plot the average power or spectral width.
`-max`	if a cell contains more than one data point, plot the maximum power or spectral width.
`-min`	if a cell contains more than one data point, plot the minimum power or spectral width.
`-modn`	plot the name of the statistical model.
`-imf`	plot the IMF clock-dial.
`-pot`	plot the cross polar cap potential.
`-extra`	plot extra diagnostic information.
`-source`	plot the source string.
`-vkeyp`	plot the color key for the velocity scale.
`-pkeyp`	plot the color key for the potential scale.
`-xkeyp`	plot the extra color key for the power or spectrral width scale.
`-vecp`	plot the example vector.
`-vsf vsf`	set the vector scale factor to vsf.
`-vrad vrad`	set the radius of the dot a the vector root to vrad.
`-logo`	plot the logo and credits.
`-time`	plot the time of the plotted data.
`-cmax cmax`	set the potential scale maximum to cmax (in units of Volts, not kV).
`-vmax vmax`	set the absolute velocity scale maximum to vmax.
`-pmax pmax`	set the power scale maximum to pmax.
`-wmax wmax`	set the spectral width scale maximum to wmax.
`-frame`	add a frame around the borders of the plot.
`-over`	the output plot will be overlaid on another plot, do not paint the background with the bacground color.
`mapname`	filename of the `map` or `cnvmap` format file to plot.
`inxname`	filename of the index file associated with the grid format file to plot.
`-stdout`	plot a single data record and write the plot to standard output.
`-d yyyymmdd`	plot the data on date yyyymmdd (when using -stdout).
`-t hr:mn`	plot the data at the time hr:mn (when using -stdout).
`-png`	produce a Portable Network Graphics (PNG) image as the output.
`-ps`	produce a PostScript plot as the output.
`-xp xoff`	set the X offset of the PostScript plot to xoff.
`-yp xoff`	set the Y offset of the PostScript plot to yoff.
`-ppm`	produce a Portable PixMap (PPM) image as the output.
`-ppmx`	produce an extended Portable PixMap (PPMX) image as the output.
`-xml`	produce an XML image representation as the output.
`-x`	plot the data on an X-terminal.
`-display display`	connect to the xterminal named display.
`-xoff xoff`	open the window, xoff pixels from the left edge of the screen.
`-yoff yoff`	open the window ypad pixels from the top edge of the screen.
`-delay delay`	set the delay between frames to delay milliseconds, a value of 0 will pause the frame until a mouse button is pressed. Default: 0
`-chisham`	draw radar fields of view using the Chisham virtual height model.

Description

Plot the map and cnvmapformat files.

The output can be to an X terminal, XML rplot file, Portable PixMap (PPM) file, extended Portable PixMap (PPMX) file, Portable Network Graphics (PNG), or PostScript file. The default output is PostScript.

The program usually steps through the convection map data and writes each plot to a file. The output filenames are of the form "nnnn.xxx", where nnnn is the frame number starting at 0000 and xxx is the suffix "xml","ps","ppm", or "ppmx". The options "-tn" and "-dn" can be used to change this format to one based on the time of each plot.

If the "-stdout" option is used then the program will just plot a single record from the file and the plot is written to standard output. The "-d" and "-t" options are used to select the time to plot.

The task only plots what it is instructed to plot on the command line which means that at least some of the options must be included if the plot is to show anything.

The default map projection is a stereographic projection.

A sensible set of default plot options can be invoked using the "-def" option. This will plot a stereographic projection of the fitted velocity vectors, equipotential contours and Hepner-Maynard boundary in geomagnetic coordinates. The plot is rotated so that magnetic noon is at the top.

The program usually plots the line of sight or fitted velocity vectors contained in the file. However the options "-pwr" and "-wdt" can be used to plot the power and spectral width information stored in extended grid files as an extra parameter.

The options "-vkey" and "-xkey" allows a user defined color key to be used to plot the velocity vectors or the extra parameters.

The color key file is a plain text file that defines the red green and blue components for each index in the color bar. Any line in the file beginning with a "#" is treated as a comment and ignored. The first line that is not a comment defines the number of entries in the table. The remaining lines in the file contain color values for each index, one value per line. The values are hexadecimal numbers of the form aarrggbb, where aa is the alpha component, rr is the red component, gg is the blue component and bb is the blue component.

The number and complexity of the command line options makes typing them a laborious process, especially when producing multiple plots. To solve this problem, command line options can be placed in plain text file that can be parsed by the program using the " -cf" option. This allows the user to create a set of configuration files for producing different plots.

Examples

map_plot -x -def -vkey superdarn.key -old 20040620.map

Plot convections maps from the file "20040620.map" on the X-terminal. Use the default set of options and the color key "superdarn.key".

map_plot -ps -dn -st 12:00 -mag -rotate -fcoast -coast -fterm -tmk -vecp -vkeyp -time -imf -modn -pot -fit -ctr -vkey superdarn.key 20021219.cnvmap

Generate PostScript plots of convections maps from the file "20021219.cnvmap". Store the plots in files named "yyyymmdd.hrmn.sc.ps", starting at 12:00UTC. Use a stereographic projection in magnetic coordinates, rotated so that magnetic local noon is at the top of the plot. Plot filled coastlines, terminator, a clockdial representing time, a labelled sample velocity vector, the velocity color bar, the time, IMF conditions, model used, Potential, fitted vectors and the potential contours. The velocity color bar is taken from the file "superdarn.key".

map_plot -stdout -xml -t 6:00 -pad 0 -mag -lat 78.4 -lon 16.00 -square -sf 2.00 -fcoast -coast -vecp -vkeyp -grd -time -hmb -fit -ctr -vkey superdarn.key 20021219.cnvmap > map.rp.xml

Generate a single rPlot XML plot of the convections map at 06:00UTC from the file "20021219.cnvmap". Use a stereographic projection in geomagnetic coordinates and center the plot on latitude 78.4 degrees and longitude 16.00 degrees. Plot filled coastlines, a labelled sample velocity vector, the velocity color bar, the time, fitted vectors, Heppner-Maynard boundary and the potential contours.The velocity color bar is taken from the file "superdarn.key". The plot is stored in the file "map.rp.xml".