API reference¶
Top-level functions¶
Primary functions used to interactively work with figures. Modeled after the
pyplot
versions.
|
Pass the input arguments to |
|
Call |
|
Analogous to |
Figure classes¶
The figure class and a couple related classes.
|
List subclass and pseudo-2D array that is used as a container for the list of axes returned by |
|
|
|
|
|
Adds two helper methods to |
Axes classes¶
The axes classes used for all ProPlot figures.
|
Lowest-level axes subclass. |
|
Axes subclass for plotting |
|
Axes subclass for plotting cartopy projections. |
|
|
|
Intermediate class, shared by |
|
Axes subclass for ordinary 2D cartesian coordinates. |
Plotting wrappers¶
Wrapper functions applied to various Axes
plotting methods.
In a future version these features will be documented on the individual
plotting methods, but for now they are documented separately.
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps methods that take a |
|
Wraps methods that use the property cycler ( |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
|
Wraps |
Projection tools¶
New cartopy projection classes and a projection constructor function
for generating Basemap
and cartopy
Projection
classes.
Variables
Default keyword args for |
|
Mapping of “projection names” to cartopy |
Functions
|
Returns a |
Classes
|
The Aitoff projection. |
|
The Hammer projection. |
|
The Kavrayskiy VII projection. |
Analogous to |
|
|
Analogous to |
Analogous to |
|
Analogous to |
|
|
Analogous to |
Analogous to |
|
|
The Winkel tripel (Winkel III) projection. |
Axis tools¶
Various axis Formatter
and ScaleBase
classes. Includes constructor functions so that these classes can be selected
with with a shorthand syntax.
Variables
Mapping of strings to |
|
Mapping of strings to |
|
The registered scale names and their associated |
Functions
|
Returns a |
|
Returns a |
|
Returns a |
|
Returns a |
|
Replicates features of |
Classes
|
The new default formatter, a simple wrapper around |
|
Axis scale with arbitrary successive thresholds between which are discrete jumps, “accelerations”, or “decelerations”. |
|
An “exponential scale”. |
|
Arbitrary scale with user-supplied forward and inverse functions and arbitrary additional transform applied thereafter. |
|
Scales axis to be linear in the inverse of x. |
|
As with |
|
As with |
|
As with |
|
Scales axis as with latitude in the Mercator projection. |
|
Returns a “power scale” that performs the transformation |
Scales axis to be linear in the sine of x in degrees. |
|
|
As with |
Color and font tools¶
Tools for registering and visualizing colormaps, color cycles, color string names, and fonts. Defines new colormap classes, new colormap normalizer classes, and new constructor functions for generating instances of these classes. Includes related utilities for manipulating colors. See Colormaps, Color cycles, and Colors and fonts for details.
Variables
List of registered colormap names. |
|
Lists of registered color names by category. |
|
List of registered color cycle names. |
|
Registered font names. |
Functions
|
Mostly a copy of |
Add colormaps packaged with ProPlot or saved to the |
|
|
Add color names packaged with ProPlot or saved to the |
Add color cycles packaged with ProPlot or saved to the |
|
Adds fonts packaged with ProPlot or saved to the |
|
|
Scale the saturation channel of the input color. |
|
Scale the luminance channel of the input color. |
|
Visualize all registered colormaps, or the list of colormap names if positional arguments are passed. |
|
Show how arbitrary colormap(s) vary with respect to the hue, chroma, luminance, HSL saturation, and HPL saturation channels, and optionally the red, blue and green channels. |
|
Visualize the registered color names in two figures. |
|
Generate hue-saturation, hue-luminance, and luminance-saturation cross-sections for the HCL, HSLuv, and HPLuv colorspaces. |
|
Visualize all registered color cycles, or the list of cycle names if positional arguments are passed. |
|
Visualize the available fonts. |
|
Translate color in any format and from any colorspace to an RGB tuple. |
|
Translate color in any format to a tuple of channel values in any colorspace. |
|
Generate or retrieve colormaps and optionally merge and manipulate them in a variety of ways. |
|
Identical to |
|
Generate and merge |
|
Returns an arbitrary |
Classes
|
This normalizer is used for all colormap plots. |
|
Dictionary subclass used to replace the |
This class overrides the builtin matplotlib color cache, allowing users to draw colors from named colormaps and color cycles for any plotting command that accepts a |
|
|
This is the default normalizer paired with |
|
New base class for all |
|
New base class for all |
|
Ensures a “midpoint” always lies at the central colormap color. |
|
Similar to |
Rc configuration tools¶
Utilities for configuring matplotlib and ProPlot global settings. See Configuring proplot for details.
Instance of |
|
Magical abstract class for managing matplotlib rcParams settings, ProPlot rcParamsLong settings, and rcParamsShort “global” settings. |
|
|
Set up the ipython autosave utility by running the following ipython magic. |
|
Set up the ipython autoreload utility by running the following ipython magic. |
|
Set up the matplotlib backend for ipython sessions and apply the following |
Miscellaneous tools¶
Simple tools used in various places across this package.
|
Identical to |
|
Calculate approximate “edge” values given “center” values. |
|
Like |
|
Convert values and lists of values between arbitrary physical units. |