The mapping module¶
A brief description of the module¶
The mapping module is a helper function to the reflexible
module. Primarily it is designed to perform a few tasks relating to
using the matplotlib Basemap
module. I haven’t confirmed whether how I pass the figures around or
not is a good idea, and would welcome suggestions.
Warning
This module is not fully prepared for public use. There are a lot of custom functions, not written in a generic sense. Use with caution.
Purpose¶
The purpose of this module is to ease create some basic mapping routines using
the basemap module. These are called directly from the reflexible for
example in the plot_sensitivity() routine. The core idea is that a
“FIGURE” object is created using the get_FIGURE() function which has some
key attributes. In general, this is transparent to the user, just intialize
a FIG object as NONE, then pass it to the functions with the FIGURE argument
set to your ‘FIG’ object.:
> FIG = None
> FIG = mp.plot_function(data,FIGURE=FIG)
>
The ‘FIG’ object can then be passed around and reused saving time and resources. In general, the FIGURE object has the following attributes:
| attribute / key | description |
|---|---|
| fig | A fig object, use plt.figure(FIG.fig.number) to make it active |
| m | A basemap instance for the plot |
| ax | The primary axis instance |
| indices | See the get_FIGURE() which
describes the indices. |
Regions¶
Another commonly used paradigm is the passing of a ‘map_region’ keyword to the
functions. Regions are defined manually at present. You’ll have to edit the
mapping.py and specifically, the map_regions(). Following the
instructions for the Basemap
toolkit you can define your own unique region. See other regions as examples.
Warning¶
This is a module in active development, and there are no guarantees for backward compatability. Constructive input is sought, but don’t complain if something breaks!
The mapping API¶
Release: 1.0 Date: Jun 01, 2018