__init__(self, template=None, nancolor=(255, 255, 255), headerfontsize=18, labelfontsize=12, latmin=-90, latmax=90, lonmin=0, lonmax=360, proj='cyl', longrdinc=None, latgrdinc=None, xsize=6.5, ysize=6.5, xyunits='i', xshift=0, yshift=0, centerlon=0, centerlat=0, lonframeinc=None, latframeinc=None, lonlabelinc=None, latlabelinc=None, axisfontsize=16, verbose=False, standardpar1=None, standardpar2=None, rectbounds=False, reverseyaxis=False, basemaptype='plain')
(Constructor)

Keyword Parameters:

nancolor - (255,255,255) | color to fill NaN regions (default is white).

headerfontsize - 18 | default fontsize for main, right and left titles.

labelfontsize - 12 | fontsize for axis value labels.

axisfontsize - 16 | fontsize for axis name labels.

xsize - 6.5 | width of plot (in units given by xyunits).

ysize - 6.5 | height of plot (in units given by xyunits).

xyunits - "i" | page measurement units (can be cm ('c'), inch ('i'), meter ('m'), or point ('p')).

xshift - 0 | offset plot in horizontal (units given by xyunits)

yshift - xsize/4 | offset plot in vertical (units given byxyunits)

proj - 'cyl' | map projection (valid choices 'linear','loglinear', 'loglog','cyl' - cylindrical equidistant, 'npst' - North Polar Stereographic, 'spst' - South Polar Stereographic, 'lc' - Lambert Conformal Conic, 'la' - Lambert Azimuthal, 'merc'- Mercator, 'ortho' - Orthographic, 'gst' - general stereographic).

template - None | Previously defined class instance to use as a template. If a class instance is provided as a template, the other keyword arguments to __init__ are ignored.

latmin - -90 | minimum latitude (or y axis value).

latmax - 90 | maximum latitude (or y axis value).

lonmin - 0 | miniumum longitude (or x axis value).

lonmax - 360 | maximum longitude (or x axis value). Hint - to plot longitudes between 60 degrees west and 60 degrees east, use lonmin=300 and lonmax=420.

rectbounds - False | if true latmin,lonmin is interpreted as lower left corner of rectangular map, latmax,lonmax upper right.

longrdinc - getcint(latmin,latmax,6) | grid increment for longitude axis. Default is to choose approx. 6 "nice" levels. If < 0, no grid lines drawn for longitude axis.

latgrdinc - getcint(latmin,latmax,6) | grid increment for latitude axis. Default is to choose approx. 6 "nice" levels. If < 0, no grid lines drawn for latitude axis.

lonframeinc - 3 (if proj in ['loglinear','loglog']), longrdinc otherwise | Increment for ticks on longitude axis. For log axes, default value of 3 means ticks will be drawn for 1,2,3,4...,9.

latframeinc - 3 (if proj in ['loglinear','loglog']), latgrdinc otherwise | Increment for ticks on latitude axis. For log axes, default value of 3 means ticks will be drawn for 1,2,3,4...,9.

lonlabelinc - 2 (if proj in ['loglinear','loglog']), longrdinc otherwise | Increment for longitude axis labels. For log axes, default value of 2 means labels will be drawn for 1,2,5.

latlabelinc - 2 (if proj in ['loglinear','loglog']), latgrdinc otherwise | Increment for latitude axis labels. For log axes, default value of 2 means labels will be drawn for 1,2,5.

centerlon - 0 only used if proj = "ortho" or rectbounds: True, set to 0.5*(lonmin+lonmax) otherwise | longitude of projection center.

centerlat - 0 only used if proj in ['ortho','la','merc','gst'] or rectbounds: True, set to 0.5*(latmin+latmax) otherwise | latitude of projection center.

reverseyaxis - False | reverse direction of y-axis for non-geographic map projections so that values decrease upwards (useful when depth or pressure is y-axis).

verbose - False | if true, print all GMT commands.

standardpar1 - lonmin + (1/6)*(lonmax-lonmin) | 1st standard parallel (only relevant if proj = 'lc').

standardpar2 - lonmin + (5/6)*(lonmax-lonmin) | 2nd standard parallel (only relevant if proj = 'lc').

basemaptype - plain | basemap type ('plain' or 'fancy').

basemap(self)

draw basemap, grid lines and titles.

close(self, fixbb=True, addtrailer=True, psfilename=None, view=False)

Keyword Parameters:

fixbb - True | Fixup bounding box.

addtrailer - True | Add trailer to postscript file.

psfilename - None | Save postscript to file, otherwise return the postscript in a StringIO instance.

view - False | render postscript using command specified by psview instance variable.

Returns:

postscript - If psfilename=None, returns StringIO instance containing postscript.

command(self, gmt_command_string, force_command=False)

Parameters:

gmt_command_string - raw GMT commandline string without -R and -J options

Keyword Parameters:

force_command - boolean used to override tests and apply exactly the raw command (default=False)

contour(self, grdfile)

draw contours and optional labelbar.

drawcurve(self, lats, lons, thickness=2.0, color=(0, 0, 0))

Parameters:

lats - list or rank 1 Numeric array of latitudes defining curve.

lons - list or rank 1 Numeric array of longitudes defining curve.

Keyword Parameters:

thickness - 2 | thicknes of curve (in points).

color - (0,0,0) | color of curve (rgb tuple).

drawline(self, latbegin, lonbegin, latend, lonend, thickness=2.0, color=(0, 0, 0), greatcircle=True)

Parameters:

latbegin - latitude coordinate for beginning of line.

lonbegin - longitude coordinate for end of line.

latend - latitude coordinate for end of line.

lonend - longitude coordinate for end of line.

Keyword Parameters:

thickness - 2 | thicknes of line (in points).

color - (0,0,0) | color of line (rgb tuple).

greatcircle - True | draw line along great circle.

drawpolygon(self, lats, lons, linethickness=2.0, linecolor=(0, 0, 0), fillcolor=None)

Parameters:

lats - list or rank 1 Numeric array of latitudes defining polygon vertices.

lons - list or rank 1 Numeric array of longitudes defining polygon vertices.

Keyword Parameters:

linethickness - 2 | thicknes of line (in points) - no line if None.

linecolor - (0,0,0) | color of line (rgb tuple).

fillcolor - None | color to fill polygon (rgb tuple) - no fill if None.

drawsymbol(self, lat, lon, symbol='c', size=0.20000000000000001, color=(0, 0, 0))

Parameters:

lat - latitude coordinate to draw symbol.

lon - longitude coordinate to draw symbol.

Keyword Parameters:

symbol - 'c' | symbol code (see psxy man page under -S for options).

size - 0.2 | size of symbol (in xyunits).

color - (0,0,0) | color of symbol (rgb tuple).

drawtext(self, textstring, x, y, offset=0, fontsize=14, justify='CM', angle=0, font=0, color=(0, 0, 0), clip=False)

Parameters:

textstring - text string to draw.

x - x coordinate to locate textstring (in xyunits).

y - y coordinate to locate textstring (in xyunits).

Keyword Parameters:

offset - 0 | offset textstring from (x,y) by this amount (in xyunits).

fontsize - 14 | font size (points).

justify - 'CM' | text is justified using this two-letter string, which can be a combination of L, C, R (for left, center, or right) and T, M, B (for top, middle, or bottom).

angle - 0 | draw textstring at a angle (degrees).

font - 0 | draw texstring with this font. If font is not an integer, it is taken to be a text string containing the font name (run 'pstext -L' for a list of font names and numbers)

latlontoxy(self, lat, lon)

Parameters:

lat - latitude coordinate.

lon - longitude coordinate.

Returns:

x,y - x and y (in xyunits) of desired point.

setmapparms(self)

set up GMT map parameters for projection, grid lines etc. Called by __init__, but may be called again to reset. This is useful if you are plotting data on a native projection grid (initialize the class instance with proj='linear', draw the contours, reset the basemap instance variables for the desired projection then call the setmapparms prior to calling the basemap method).

windbarbs(self, ugrd, vgrd)

draw wind barbs on map.

wrtgrd(self, data, x, y, title='', scale=1.0, offset=0, addcyclicpt=False, xunit='degrees longitude', yunit='degrees latitude', zunit='', node_offset=0, zname='')

Parameters:

data - rank 2 Numeric Float array defining an evenly space grid of values to plot. Should have shape (nlats,nlons), i.e. first dimension should be latitudes, second should be longitudes. If data has shape (lons,lats) a transpose if performed before writing to grd file.

x - rank 1 Numeric Float array containing longitudes of grid. Should be in increasing order, if not data is reversed along x-axis before writing to grd file.

y - rank 1 Numeric Float array containing latitudes of grid. Should be in decreasing order, if not data is reversed along y-axis before writing to grd file.

Keyword Parameters:

title - "" | title describing dataset.

scale - 1 | factor to multiply data.

offset - 0 | offset to add to data values.

addcyclicpt - False | Add an extra "wraparound" longitude of data, identical to the first longitude (using the addcyclicpt function).

xunit - "degrees longitude" | units of x.

yunit - "degrees latitude" | units of y.

zunit - "" | units of data.

node_offset - 0 | 0 for grid-line registration (data points represent grid line intersections), 1 for pixel registration (data points represent average in grid cell).

zname - "" | data long_name.

Returns:

grdfile - dictionary containing grd file metadata.

xytolatlon(self, x, y)

Parameters:

x - x coordinate (in xyunits).

y - y coordinate (in xyunits).

Returns:

lat,lon - latitude and longitude of desired point.