matplotlib (version 1.0.0, $Date: 2010-07-06 08:56:31 -0500 (Tue, 06 Jul 2010) $)
index
/astro-wise/awehome/Linux-fedora-6-x86_64/AWBASE/common/lib/python2.7/site-packages/matplotlib/__init__.py

This is an object-orient plotting library.
 
A procedural interface is provided by the companion pyplot module,
which may be imported directly, e.g::
 
    from matplotlib.pyplot import *
 
To include numpy functions too, use::
 
    from pylab import *
 
or using ipython::
 
    ipython -pylab
 
For the most part, direct use of the object-oriented library is
encouraged when programming; pyplot is primarily for working
interactively.  The
exceptions are the pyplot commands :func:`~matplotlib.pyplot.figure`,
:func:`~matplotlib.pyplot.subplot`,
:func:`~matplotlib.pyplot.subplots`,
:func:`~matplotlib.backends.backend_qt4agg.show`, and
:func:`~pyplot.savefig`, which can greatly simplify scripting.
 
Modules include:
 
    :mod:`matplotlib.axes`
        defines the :class:`~matplotlib.axes.Axes` class.  Most pylab
        commands are wrappers for :class:`~matplotlib.axes.Axes`
        methods.  The axes module is the highest level of OO access to
        the library.
 
    :mod:`matplotlib.figure`
        defines the :class:`~matplotlib.figure.Figure` class.
 
    :mod:`matplotlib.artist`
        defines the :class:`~matplotlib.artist.Artist` base class for
        all classes that draw things.
 
    :mod:`matplotlib.lines`
        defines the :class:`~matplotlib.lines.Line2D` class for
        drawing lines and markers
 
    :mod:`matplotlib.patches`
        defines classes for drawing polygons
 
    :mod:`matplotlib.text`
        defines the :class:`~matplotlib.text.Text`,
        :class:`~matplotlib.text.TextWithDash`, and
        :class:`~matplotlib.text.Annotate` classes
 
    :mod:`matplotlib.image`
        defines the :class:`~matplotlib.image.AxesImage` and
        :class:`~matplotlib.image.FigureImage` classes
 
    :mod:`matplotlib.collections`
        classes for efficient drawing of groups of lines or polygons
 
    :mod:`matplotlib.colors`
        classes for interpreting color specifications and for making
        colormaps
 
    :mod:`matplotlib.cm`
        colormaps and the :class:`~matplotlib.image.ScalarMappable`
        mixin class for providing color mapping functionality to other
        classes
 
    :mod:`matplotlib.ticker`
        classes for calculating tick mark locations and for formatting
        tick labels
 
    :mod:`matplotlib.backends`
        a subpackage with modules for various gui libraries and output
        formats
 
The base matplotlib namespace includes:
 
    :data:`~matplotlib.rcParams`
        a global dictionary of default configuration settings.  It is
        initialized by code which may be overridded by a matplotlibrc
        file.
 
    :func:`~matplotlib.rc`
        a function for setting groups of rcParams values
 
    :func:`~matplotlib.use`
        a function for setting the matplotlib backend.  If used, this
        function must be called immediately after importing matplotlib
        for the first time.  In particular, it must be called
        **before** importing pylab (if pylab is imported).
 
matplotlib was initially written by John D. Hunter (jdh2358 at
gmail.com) and is now developed and maintained by a host of others.
 
Occasionally the internal documentation (python docstrings) will refer
to MATLAB®, a registered trademark of The MathWorks, Inc.

 
Package Contents
       
_cm
_cntr
_delaunay
_image
_mathtext_data
_path
_png
_pylab_helpers
_tri
afm
artist
axes
axis
backend_bases
backends (package)
bezier
blocking_input
cbook
cm
collections
colorbar
colors
contour
dates
delaunay (package)
docstring
dviread
figure
finance
font_manager
fontconfig_pattern
ft2font
gridspec
hatch
image
legend
lines
mathtext
mlab
mpl
numerix (package)
nxutils
offsetbox
patches
path
patheffects
projections (package)
pylab
pyparsing
pyplot
quiver
rcsetup
scale
sphinxext (package)
spines
table
testing (package)
tests (package)
texmanager
text
textpath
ticker
tight_bbox
transforms
tri (package)
ttconv
type1font
units
widgets

 
Classes
       
__builtin__.dict(__builtin__.object)
RcParams
Verbose

 
class RcParams(__builtin__.dict)
    A dictionary object including validation
 
validating functions are defined and associated with rc parameters in
:mod:`matplotlib.rcsetup`
 
 
Method resolution order:
RcParams
__builtin__.dict
__builtin__.object

Methods defined here:
__setitem__(self, key, val)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
converter = <type 'str'>
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
default = 'upper'
key = 'image.origin'
validate = {'agg.path.chunksize': <function validate_int>, 'axes.axisbelow': <function validate_bool>, 'axes.color_cycle': <function validate_colorlist>, 'axes.edgecolor': <function validate_color>, 'axes.facecolor': <function validate_color>, 'axes.formatter.limits': <matplotlib.rcsetup.validate_nseq_int instance>, 'axes.grid': <function validate_bool>, 'axes.hold': <function validate_bool>, 'axes.labelcolor': <function validate_color>, 'axes.labelsize': <function validate_fontsize>, ...}

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__gt__(...)
x.__gt__(y) <==> x>y
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty.
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from dict/iterable E and F.
If E has a .keys() method, does:     for k in E: D[k] = E[k]
If E lacks .keys() method, does:     for (k, v) in E: D[k] = v
In either case, this is followed by: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values
viewitems(...)
D.viewitems() -> a set-like object providing a view on D's items
viewkeys(...)
D.viewkeys() -> a set-like object providing a view on D's keys
viewvalues(...)
D.viewvalues() -> an object providing a view on D's values

Data and other attributes inherited from __builtin__.dict:
__hash__ = None
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class Verbose
    A class to handle reporting.  Set the fileo attribute to any file
instance to handle the output.  Default is sys.stdout
 
  Methods defined here:
__init__(self)
ge(self, level)
return true if self.level is >= level
report(self, s, level='helpful')
print message s to self.fileo if self.level>=level.  Return
value indicates whether a message was issued
set_fileo(self, fname)
set_level(self, level)
set the verbosity to one of the Verbose.levels strings
wrap(self, fmt, func, level='helpful', always=True)
return a callable function that wraps func and reports it
output through the verbose handler if current verbosity level
is higher than level
 
if always is True, the report will occur on every function
call; otherwise only on the first time the function is called

Data and other attributes defined here:
i = 3
level = 'debug-annoying'
levels = ('silent', 'helpful', 'debug', 'debug-annoying')
vald = {'debug': 2, 'debug-annoying': 3, 'helpful': 1, 'silent': 0}

 
Functions
       
checkdep_dvipng()
checkdep_ghostscript()
checkdep_inkscape()
checkdep_pdftops()
checkdep_ps_distiller(s)
checkdep_tex()
checkdep_usetex(s)
checkdep_xmllint()
compare_versions(a, b)
return True if a is greater than or equal to b
get_backend()
Returns the current backend
get_configdir = wrapper(*args, **kwargs)
Return the string representing the configuration dir.
 
default is HOME/.matplotlib.  you can override this with the
MPLCONFIGDIR environment variable
get_data_path = wrapper(*args, **kwargs)
get_example_data(fname)
get_example_data is deprecated -- use matplotlib.cbook.get_sample_data instead
get_home = wrapper(*args, **kwargs)
Find user's home directory if possible.
Otherwise raise error.
 
:see:  http://mail.python.org/pipermail/python-list/2005-February/263921.html
get_py2exe_datafiles()
interactive(b)
Set interactive mode to boolean b.
 
If b is True, then draw after every plotting command, eg, after xlabel
is_interactive()
Return true if plot mode is interactive
is_string_like(obj)
matplotlib_fname()
Return the path to the rc file
 
Search order:
 
 * current working dir
 * environ var MATPLOTLIBRC
 * HOME/.matplotlib/matplotlibrc
 * MATPLOTLIBDATA/matplotlibrc
rc(group, **kwargs)
Set the current rc params.  Group is the grouping for the rc, eg.
for ``lines.linewidth`` the group is ``lines``, for
``axes.facecolor``, the group is ``axes``, and so on.  Group may
also be a list or tuple of group names, eg. (*xtick*, *ytick*).
*kwargs* is a dictionary attribute name/value pairs, eg::
 
  rc('lines', linewidth=2, color='r')
 
sets the current rc params and is equivalent to::
 
  rcParams['lines.linewidth'] = 2
  rcParams['lines.color'] = 'r'
 
The following aliases are available to save typing for interactive
users:
 
=====   =================
Alias   Property
=====   =================
'lw'    'linewidth'
'ls'    'linestyle'
'c'     'color'
'fc'    'facecolor'
'ec'    'edgecolor'
'mew'   'markeredgewidth'
'aa'    'antialiased'
=====   =================
 
Thus you could abbreviate the above rc command as::
 
      rc('lines', lw=2, c='r')
 
 
Note you can use python's kwargs dictionary facility to store
dictionaries of default parameters.  Eg, you can customize the
font rc as follows::
 
  font = {'family' : 'monospace',
          'weight' : 'bold',
          'size'   : 'larger'}
 
  rc('font', **font)  # pass in the font dict as kwargs
 
This enables you to easily switch between several configurations.
Use :func:`~matplotlib.pyplot.rcdefaults` to restore the default
rc params after changes.
rc_params(fail_on_error=False)
Return the default params updated from the values in the rc file
rcdefaults()
Restore the default rc params - the ones that were created at
matplotlib load time.
test(verbosity=0)
run the matplotlib test suite
tk_window_focus()
Return true if focus maintenance under TkAgg on win32 is on.
This currently works only for python.exe and IPython.exe.
Both IDLE and Pythonwin.exe fail badly when tk_window_focus is on.
use(arg, warn=True)
Set the matplotlib backend to one of the known backends.
 
The argument is case-insensitive.  For the Cairo backend,
the argument can have an extension to indicate the type of
output.  Example:
 
    use('cairo.pdf')
 
will specify a default of pdf output generated by Cairo.
 
Note: this function must be called *before* importing pylab for
the first time; or, if you are not using pylab, it must be called
before importing matplotlib.backends.  If warn is True, a warning
is issued if you try and callthis after pylab or pyplot have been
loaded.  In certain black magic use cases, eg
pyplot.switch_backends, we are doing the reloading necessary to
make the backend switch work (in some cases, eg pure image
backends) so one can set warn=False to supporess the warnings

 
Data
        __date__ = '$Date: 2010-07-06 08:56:31 -0500 (Tue, 06 Jul 2010) $'
__revision__ = '$Revision: 8503 $'
__version__ = '1.0.0'
default = 'upper'
defaultParams = {'agg.path.chunksize': [0, <function validate_int>], 'axes.axisbelow': [False, <function validate_bool>], 'axes.color_cycle': [['b', 'g', 'r', 'c', 'm', 'y', 'k'], <function validate_colorlist>], 'axes.edgecolor': ['k', <function validate_color>], 'axes.facecolor': ['w', <function validate_color>], 'axes.formatter.limits': [[-7, 7], <matplotlib.rcsetup.validate_nseq_int instance>], 'axes.grid': [False, <function validate_bool>], 'axes.hold': [True, <function validate_bool>], 'axes.labelcolor': ['k', <function validate_color>], 'axes.labelsize': ['medium', <function validate_fontsize>], ...}
default_test_modules = ['matplotlib.tests.test_agg', 'matplotlib.tests.test_backend_svg', 'matplotlib.tests.test_basic', 'matplotlib.tests.test_cbook', 'matplotlib.tests.test_mlab', 'matplotlib.tests.test_transforms', 'matplotlib.tests.test_axes', 'matplotlib.tests.test_dates', 'matplotlib.tests.test_spines', 'matplotlib.tests.test_image', 'matplotlib.tests.test_simplification', 'matplotlib.tests.test_mathtext']
generators = _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 0)
key = 'image.origin'
major = 2
minor1 = 7
minor2 = 1
n = '5'
nmajor = 1
nminor = 5
rcParams = {'figure.subplot.right': 0.9, 'mathtext.cal': 'c... True, 'keymap.back': ['left', 'c', 'backspace']}
rcParamsDefault = {'figure.subplot.right': 0.9, 'mathtext.cal': 'c... True, 'keymap.back': ['left', 'c', 'backspace']}
s = 'final'
tmp = 0
validate_cairo_format = <matplotlib.rcsetup.ValidateInStrings instance>
validate_toolbar = <matplotlib.rcsetup.ValidateInStrings instance>
verbose = <matplotlib.Verbose instance>