matplotlib.axis3d
index
/astro-wise/AWEHOME/x86_64/AWBASE/common/lib/python2.5/site-packages/matplotlib/axis3d.py

# axis3d.py
#
# Created: 23 Sep 2005

 
Modules
       
matplotlib.art3d
matplotlib.axis
matplotlib.lines
math
matplotlib.patches
matplotlib.proj3d
matplotlib.text

 
Classes
       
matplotlib.axis.XAxis(matplotlib.axis.Axis)
Axis

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

Methods defined here:
__init__(self, adir, v_intervalx, d_intervalx, axes, *args, **kwargs)
draw(self, renderer)
get_data_interval(self)
return the Interval instance for this axis data limits
get_major_ticks(self)
get_tick_positions(self)
get_view_interval(self)
return the Interval instance for this axis view limits
set_pane_bg(self, xys)
set_pane_fg(self, xys)

Methods inherited from matplotlib.axis.XAxis:
get_label_position(self)
Return the label position (top or bottom)
get_ticks_position(self)
Return the ticks position (top, bottom, default or unknown)
set_label_position(self, position)
Set the label position (top or bottom)
 
ACCEPTS: [ 'top' | 'bottom' ]
set_ticks_position(self, position)
Set the ticks position (top, bottom, both or default)
both sets the ticks to appear on both positions, but
does not change the tick labels.
default resets the tick positions to the default:
ticks on both positions, labels at bottom.
 
ACCEPTS: [ 'top' | 'bottom' | 'both' | 'default' ]
tick_bottom(self)
use ticks only on bottom
tick_top(self)
use ticks only on top

Methods inherited from matplotlib.axis.Axis:
cla(self)
clear the current axis
convert_units(self, x)
get_children(self)
get_gridlines(self)
Return the grid lines as a list of Line2D instance
get_label(self)
Return the axis label as a Text instance
get_major_formatter(self)
Get the formatter of the major ticker
get_major_locator(self)
Get the locator of the major ticker
get_minor_formatter(self)
Get the formatter of the minor ticker
get_minor_locator(self)
Get the locator of the minor ticker
get_minor_ticks(self)
get the minor tick instances; grow as necessary
get_offset_text(self)
Return the axis offsetText as a Text instance
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_units(self)
return the units for axis
grid(self, b=None, which='major', **kwargs)
Set the axis grid on or off; b is a boolean use which =
'major' | 'minor' to set the grid for major or minor ticks
 
if b is None and len(kwargs)==0, toggle the grid state.  If
kwargs are supplied, it is assumed you want the grid on and b
will be set to True
 
kwargs are used to set the line properties of the grids, eg,
 
  xax.grid(color='r', linestyle='-', linewidth=2)
have_units(self)
pan(self, numsteps)
Pan numticks (can be positive or negative)
pick(self, mouseevent)
pick(mouseevent)
 
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
set_major_formatter(self, formatter)
Set the formatter of the major ticker
 
ACCEPTS: A Formatter instance
set_major_locator(self, locator)
Set the locator of the major ticker
 
ACCEPTS: a Locator instance
set_minor_formatter(self, formatter)
Set the formatter of the minor ticker
 
ACCEPTS: A Formatter instance
set_minor_locator(self, locator)
Set the locator of the minor ticker
 
ACCEPTS: a Locator instance
set_ticklabels(self, ticklabels, *args, **kwargs)
Set the text values of the tick labels. Return a list of Text
instances.
 
ACCEPTS: sequence of strings
set_ticks(self, ticks)
Set the locations of the tick marks from sequence ticks
 
ACCEPTS: sequence of floats
set_units(self, u)
set the units for axis
 
ACCEPTS: a units tag
update_units(self, data)
introspect data for units converter and update the
axis.converter instance if necessary. Return true is data is
registered for unit conversion
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out

Data and other attributes inherited from matplotlib.axis.Axis:
LABELPAD = 5
OFFSETTEXTPAD = 3

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
convert_xunits(self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits(self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_axes(self)
return the axes instance the artist resides in, or None
get_clip_box(self)
Return artist clipbox
get_clip_on(self)
Return whether artist uses clipping
get_clip_path(self)
Return artist clip path
get_figure(self)
return the figure instance
get_picker(self)
return the Pickeration instance used by this artist
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
get_zorder(self)
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
pchanged(self)
fire event when property changed
pickable(self)
return True if self is pickable
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
set_axes(self, axes)
set the axes instance the artist resides in, if any
 
ACCEPTS: an axes instance
set_clip_box(self, clipbox)
Set the artist's clip Bbox
 
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on(self, b)
Set  whether artist uses clipping
 
ACCEPTS: [True | False]
set_clip_path(self, path)
Set the artist's clip path
 
ACCEPTS: an agg.path_storage instance
set_figure(self, fig)
Set the figure instance the artist belong to
 
ACCEPTS: a matplotlib.figure.Figure instance
set_label(self, s)
Set the line label to s for auto legend
 
ACCEPTS: any string
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
 
ACCEPTS: [True | False]
set_picker(self, picker)
set the epsilon for picking used by this artist
 
picker can be one of the following:
 
  None -  picking is disabled for this artist (default)
 
  boolean - if True then picking will be enabled and the
    artist will fire a pick event if the mouse event is over
    the artist
 
  float - if picker is a number it is interpreted as an
    epsilon tolerance in points and the the artist will fire
    off an event if it's data is within epsilon of the mouse
    event.  For some artists like lines and patch collections,
    the artist may provide additional data to the pick event
    that is generated, eg the indices of the data within
    epsilon of the pick event
 
  function - if picker is callable, it is a user supplied
    function which determines whether the artist is hit by the
    mouse event.
 
      hit, props = picker(artist, mouseevent)
 
    to determine the hit test.  if the mouse event is over the
    artist, return hit=True and props is a dictionary of
    properties you want added to the PickEvent attributes
 
ACCEPTS: [None|float|boolean|callable]
set_transform(self, t)
set the Transformation instance used by this artist
 
ACCEPTS: a matplotlib.transform transformation instance
set_visible(self, b)
set the artist's visiblity
 
ACCEPTS: [True | False]
set_zorder(self, level)
Set the zorder for the artist
 
ACCEPTS: any number
update(self, props)
update_from(self, other)
copy properties from other to self

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

 
Functions
       
dot(...)
norm_angle(a)
Return angle between -180 and +180
text_update_coords(self, renderer)
Modified method update_coords from TextWithDash
 
I could not understand the original text offset calculations and
it gave bad results for the angles I was using.  This looks
better, although the text bounding boxes look a little
inconsistent
tick_update_position(tick, x, y, z, angle)

 
Data
        cos = <ufunc 'cos'>
equal = <ufunc 'equal'>
pi = 3.1415926535897931
sin = <ufunc 'sin'>
sqrt = <ufunc 'sqrt'>