@header@
 
 
matplotlib.axis
index
/matplotlib/axis.py

Classes for the ticks and x and y axis

 
Modules
       
math
re
sys

 
Classes
       
matplotlib.artist.Artist
Axis
XAxis
YAxis
Tick
XTick
YTick

 
class Axis(matplotlib.artist.Artist)
     Methods defined here:
__init__(self, axes)
Init the axis with the parent Axes instance
autoscale_view(self)
Try to choose the view limits intelligently
build_artists(self)
Call only after xaxis and yaxis have been initialized in axes
since the trasnforms require both
format_tickval(self, x)
Format the number x as a string
get_child_artists(self)
Return a list of all Artist instances contained by Axis
get_cm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val cm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_inches_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val inches to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_label(self)
Return the axis label as an Text instance
get_mm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val mm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_numticks(self)
get_pts_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val points to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
get_ticks(self)
grid(self, b)
Set the axis grid on or off; b is a boolean
is_log(self)
Return true if log scaling is on
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_scale(self, value)
Set the axis scale; either 'linear' or 'log'
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes defined here:
LABELPAD = -0.01

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class Tick(matplotlib.artist.Artist)
    Abstract base class for the axis ticks, grid lines and labels
 
Publicly accessible attributes
 
  tick1line  : a Line2D instance
  tick2line  : a Line2D instance
  gridline   : a Line2D instance
  label      : an Text instance
  gridOn     : a boolean which determines whether to draw the tickline
  tick1On    : a boolean which determines whether to draw the 1st tickline
               (left for xtick and bottom for yticks)
  tick2On    : a boolean which determines whether to draw the 2nd tickline
               (left for xtick and bottom for yticks)
  labelOn    : a boolean which determines whether to draw tick label
 
  Methods defined here:
__init__(self, axes, loc, label, size=4.0, gridOn=False, tick1On=True, tick2On=True, labelOn=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
get_child_artists(self)
get_loc(self)
Return the tick location (data coords) as a scalar
set_label(self, s)
Set the text of ticklabel in with string s
set_loc(self, loc)
Set the location of tick in data coords with scalar loc
set_transform(self, trans)
Set the transform for the dimension the ticks vary along.  Eg,
for xticks, this is the x dimension and for y ticks this is
the y dimension.  All the child artists transforms will be ste

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class XAxis(Axis)
    
Method resolution order:
XAxis
Axis
matplotlib.artist.Artist

Methods inherited from Axis:
__init__(self, axes)
Init the axis with the parent Axes instance
autoscale_view(self)
Try to choose the view limits intelligently
build_artists(self)
Call only after xaxis and yaxis have been initialized in axes
since the trasnforms require both
format_tickval(self, x)
Format the number x as a string
get_child_artists(self)
Return a list of all Artist instances contained by Axis
get_cm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val cm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_inches_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val inches to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_label(self)
Return the axis label as an Text instance
get_mm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val mm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_numticks(self)
get_pts_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val points to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
get_ticks(self)
grid(self, b)
Set the axis grid on or off; b is a boolean
is_log(self)
Return true if log scaling is on
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_scale(self, value)
Set the axis scale; either 'linear' or 'log'
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes inherited from Axis:
LABELPAD = -0.01

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class XTick(Tick)
    Contains all the Artists needed to make an x tick - the tick line,
the label text and the grid line
 
 
Method resolution order:
XTick
Tick
matplotlib.artist.Artist

Methods defined here:
set_loc(self, loc)
Set the location of tick in data coords with scalar loc
set_transform(self, trans)
Set the transform for the x dimension the ticks vary along.  e

Methods inherited from Tick:
__init__(self, axes, loc, label, size=4.0, gridOn=False, tick1On=True, tick2On=True, labelOn=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
get_child_artists(self)
get_loc(self)
Return the tick location (data coords) as a scalar
set_label(self, s)
Set the text of ticklabel in with string s

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class YAxis(Axis)
    
Method resolution order:
YAxis
Axis
matplotlib.artist.Artist

Methods inherited from Axis:
__init__(self, axes)
Init the axis with the parent Axes instance
autoscale_view(self)
Try to choose the view limits intelligently
build_artists(self)
Call only after xaxis and yaxis have been initialized in axes
since the trasnforms require both
format_tickval(self, x)
Format the number x as a string
get_child_artists(self)
Return a list of all Artist instances contained by Axis
get_cm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val cm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_inches_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val inches to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_label(self)
Return the axis label as an Text instance
get_mm_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val mm to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_numticks(self)
get_pts_transform(self, offset=None, transOffset=Transform: Bound1D: 0 1 to Bound1D: 0 1)
Transform val points to dots
 
offset is a RRef instance for TransformSize.  if None, use
displaylim min.  transOffset is a transform to transform the
offset to display coords
get_ticklabels(self)
Return a list of Text instances for ticklabels
get_ticklines(self)
Return the ticklines lines as a list of Line2D instance
get_ticklocs(self)
Get the tick locations in data coordinates as a Numeric array
get_ticks(self)
grid(self, b)
Set the axis grid on or off; b is a boolean
is_log(self)
Return true if log scaling is on
pan(self, numsteps)
Pan numticks (can be positive or negative)
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_scale(self, value)
Set the axis scale; either 'linear' or 'log'
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels.  ticklabels is a
sequence of strings.  Return a list of Text instances
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes inherited from Axis:
LABELPAD = -0.01

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class YTick(Tick)
    Contains all the Artists needed to make a Y tick - the tick line,
the label text and the grid line
 
 
Method resolution order:
YTick
Tick
matplotlib.artist.Artist

Methods defined here:
set_loc(self, loc)
Set the location of tick in data coords with scalar loc
set_transform(self, trans)
Set the transform for the y dimension the ticks vary along.  e

Methods inherited from Tick:
__init__(self, axes, loc, label, size=4.0, gridOn=False, tick1On=True, tick2On=True, labelOn=True)
bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in relative, axes coords
get_child_artists(self)
get_loc(self)
Return the tick location (data coords) as a scalar
set_label(self, s)
Set the text of ticklabel in with string s

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
Functions
       
arange(...)
arange(start, stop=None, step=1, typecode=None)
 
 Just like range() except it returns an array whose type can be
specified by the keyword argument typecode.
array(...)
array(sequence, typecode=None, copy=1, savespace=0) will return a new array formed from the given (potentially nested) sequence with type given by typecode.  If no typecode is given, then the type will be determined as the minimum type required to hold the objects in sequence.  If copy is zero and sequence is already an array, a reference will be returned.  If savespace is nonzero, the new array will maintain its precision in operations.
decade_down(x)
floor x to the nearest lower decade
decade_up(x)
ceil x to the nearest higher decade
take(...)
take(a, indices, axis=0).  Selects the elements in indices from array a along the given axis.
zeros(...)
zeros((d1,...,dn),typecode='l',savespace=0) will return a new array of shape (d1,...,dn) and type typecode with all it's entries initialized to zero.  If savespace is nonzero the array will be a spacesaver array.

 
Data
        False = False
Float = 'd'
True = True
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
log10 = <ufunc 'log10'>
rcParams = {'axes.edgecolor': 'k', 'axes.facecolor': 'w', 'axes.grid': False, 'axes.labelcolor': 'k', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'GTKAgg', 'datapath': '/usr/local/share/matplotlib', 'figure.dpi': 80.0, ...}
@footer@