pydarn.plotting.mapOverlay

Module: pydarn.plotting.mapOverlay

Overlay information on maps

Functions:

• overlayRadar(): Overlay radar position and name on a map
• overlayFov(): Overlay field(s)-of-view on a map

pydarn.plotting.mapOverlay.overlayFov(Basemap, codes=None, ids=None, names=None, dateTime=None, all=False, maxGate=None, fovColor=None, fovAlpha=0.2, beams=None, beamsColors=None, hemi=None, fovObj=None, zorder=2, lineColor='k', lineWidth=1)

Overlay FoV position(s) on map

Args:

• Basemap: a python Basemap object on which to overplot the radar position(s)
• [codes]: a list of radar 3-letter codes to plot
• [ids]: a list of radar IDs to plot
• [names]: a list of radar names to plot
• [dateTime]: the date and time as a python datetime object
• [all]: set to true to plot all the radars (active ones)
• [maxGate]: Maximum number of gates to be plotted. Defaults to hdw.dat information.
• [zorder]: the overlay order number
• [lineColor]: FoV contour line color
• [lineWidth]: FoV contour line width
• [fovColor]: field of view fill color
• [fovAlpha]: field of view fill color transparency
• [fovObj]: a fov object. See pydarn.radar.radFov.fov
• [hemi]: ‘north’ or ‘south’, ignore radars from the other hemisphere
• [beams]: hightlight specified beams
• [beamsColors]: colors of the hightlighted beams

Returns:

• None

Example:

import pydarn, utils
width = 111e3*40
m = utils.plotUtils.mapObj(width=width, height=width, lat_0=50., lon_0=-95.)
# Plot radar position and code
pydarn.plot.overlayRadar(m, fontSize=12, codes='bks')
# Plot radar fov
pydarn.plot.overlayFov(m, codes='bks', maxGate=75, beams=[0,4,7,8,23])

written by Sebastien, 2012-09

pydarn.plotting.mapOverlay.overlayRadar(Basemap, codes=None, ids=None, names=None, dateTime=None, annotate=True, all=False, hemi=None, zorder=2, markerColor='k', markerSize=10, fontSize=10, xOffset=None)

Overlay radar position(s) and name(s) on map

Args:

• Basemap: a python Basemap object on which to overplot the radar position(s)
• [codes]: a list of radar 3-letter codes to plot
• [ids]: a list of radar IDs to plot
• [names]: a list of radar names to plot
• [dateTime]: the date and time as a python datetime object
• [annotate]: wether or not to show the radar(s) name(s)
• [all]: set to true to plot all the radars (active ones)
• [hemi]: ‘north’ or ‘south’, ignore radars from the other hemisphere
• [zorder]: the overlay order number
• [markerColor]:
• [markerSize]: [point]
• [fontSize]: [point]
• [xOffset]: x-Offset of the annotation in points

Returns:

• None

Example:

import pydarn, utils
m1 = utils.plotUtils.mapObj(boundinglat=30., gridLabels=True, coords='mag')
pydarn.plot.overlayRadar(m1, fontSize=8, all=True, markerSize=5)

written by Sebastien, 2012-08

pydarn.plotting.mapOverlay

alias of pydarn.plotting.mapOverlay