@header@
 
 
matplotlib.lines
index
/usr/local/lib/python2.5/site-packages/matplotlib/lines.py

This module contains all the 2D line class which can draw with a
variety of line styles, markers and colors

 
Modules
       
matplotlib.agg
matplotlib.artist
matplotlib.numerix.ma
math
sys
warnings

 
Classes
       
matplotlib.artist.Artist
Line2D

 
class Line2D(matplotlib.artist.Artist)
     Methods defined here:
__init__(self, xdata, ydata, linewidth=None, linestyle=None, color=None, marker=None, markersize=None, markeredgewidth=None, markeredgecolor=None, markerfacecolor=None, antialiased=None, dash_capstyle=None, solid_capstyle=None, dash_joinstyle=None, solid_joinstyle=None, **kwargs)
Create a Line2D instance with x and y data in sequences xdata,
ydata
 
The kwargs are Line2D properties:
  alpha: float
  animated: [True | False]
  antialiased or aa: [True | False]
  clip_box: a matplotlib.transform.Bbox instance
  clip_on: [True | False]
  color or c: any matplotlib color
  dash_capstyle: ['butt' | 'round' | 'projecting']
  dash_joinstyle: ['miter' | 'round' | 'bevel']
  dashes: sequence of on/off ink in points
  data: (array xdata, array ydata)
  figure: a matplotlib.figure.Figure instance
  label: any string
  linestyle or ls: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]
  linewidth or lw: float value in points
  lod: [True | False]
  marker: [ '+' | ',' | '.' | '1' | '2' | '3' | '4'
  markeredgecolor or mec: any matplotlib color
  markeredgewidth or mew: float value in points
  markerfacecolor or mfc: any matplotlib color
  markersize or ms: float
  solid_capstyle: ['butt' | 'round' |  'projecting']
  solid_joinstyle: ['miter' | 'round' | 'bevel']
  transform: a matplotlib.transform transformation instance
  visible: [True | False]
  xdata: array
  ydata: array
  zorder: any number
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_c(self)
alias for get_color
get_color(self)
get_dash_capstyle(self)
Get the cap style for dashed linestyles
get_dash_joinstyle(self)
Get the join style for dashed linestyles
get_linestyle(self)
get_linewidth(self)
get_ls(self)
alias for get_linestyle
get_lw(self)
alias for get_linewidth
get_marker(self)
get_markeredgecolor(self)
get_markeredgewidth(self)
get_markerfacecolor(self)
get_markersize(self)
get_mec(self)
alias for get_markeredgecolor
get_mew(self)
alias for get_markeredgewidth
get_mfc(self)
alias for get_markerfacecolor
get_ms(self)
alias for get_markersize
get_solid_capstyle(self)
Get the cap style for solid linestyles
get_solid_joinstyle(self)
Get the join style for solid linestyles
get_window_extent(self, renderer)
get_xdata(self, orig=True)
return the xdata; if orig is true return the original data,
else the processed data
get_ydata(self, orig=True)
return the ydata; if orig is true return the original data,
else the processed data
is_dashed(self)
return True if line is dashstyle
pick(self, mouseevent)
If mouseevent is over data that satisifies the picker, fire
off a backend_bases.PickEvent with the additional attribute"ind"
which is a sequence of indices into the data that meet the criteria
recache(self)
set_aa(self, val)
alias for set_antialiased
set_antialiased(self, b)
True if line should be drawin with antialiased rendering
 
ACCEPTS: [True | False]
set_axes(self, ax)
set_c(self, val)
alias for set_color
set_color(self, color)
Set the color of the line
 
ACCEPTS: any matplotlib color
set_dash_capstyle(self, s)
Set the cap style for dashed linestyles
ACCEPTS: ['butt' | 'round' | 'projecting']
set_dash_joinstyle(self, s)
Set the join style for dashed linestyles
ACCEPTS: ['miter' | 'round' | 'bevel']
set_dashes(self, seq)
Set the dash sequence, sequence of dashes with on off ink in
points.  If seq is empty or if seq = (None, None), the
linestyle will be set to solid.
 
ACCEPTS: sequence of on/off ink in points
set_data(self, *args)
Set the x and y data
 
ACCEPTS: (array xdata, array ydata)
set_linestyle(self, linestyle)
Set the linestyle of the line
 
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]
set_linewidth(self, w)
Set the line width in points
 
ACCEPTS: float value in points
set_ls(self, val)
alias for set_linestyle
set_lw(self, val)
alias for set_linewidth
set_marker(self, marker)
Set the line marker
 
ACCEPTS: [ '+' | ',' | '.' | '1' | '2' | '3' | '4'
         | '<' | '>' | 'D' | 'H' | '^' | '_' | 'd'
         | 'h' | 'o' | 'p' | 's' | 'v' | 'x' | '|'
         | TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT
         | 'None' | ' ' | '' ]
set_markeredgecolor(self, ec)
Set the marker edge color
 
ACCEPTS: any matplotlib color
set_markeredgewidth(self, ew)
Set the marker edge width in points
 
ACCEPTS: float value in points
set_markerfacecolor(self, fc)
Set the marker face color
 
ACCEPTS: any matplotlib color
set_markersize(self, sz)
Set the marker size in points
 
ACCEPTS: float
set_mec(self, val)
alias for set_markeredgecolor
set_mew(self, val)
alias for set_markeredgewidth
set_mfc(self, val)
alias for set_markerfacecolor
set_ms(self, val)
alias for set_markersize
set_solid_capstyle(self, s)
Set the cap style for solid linestyles
ACCEPTS: ['butt' | 'round' |  'projecting']
set_solid_joinstyle(self, s)
Set the join style for solid linestyles
ACCEPTS: ['miter' | 'round' | 'bevel']
set_xdata(self, x)
Set the data array for x
 
ACCEPTS: array
set_ydata(self, y)
Set the data array for y
 
ACCEPTS: array
update_from(self, other)
copy properties from other to self

Data and other attributes defined here:
filled_markers = ('o', '^', 'v', '<', '>', 's', 'd', 'D', 'h', 'H', 'p')
validCap = ('butt', 'round', 'projecting')
validJoin = ('miter', 'round', 'bevel')
zorder = 2

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_label(self)
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)
have_units(self)
return True if units are set on the x or y axes
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_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)

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

 
Functions
       
concatenate(...)
concatenate((a1, a2, ...), axis=0)
 
Join arrays together.
 
The tuple of sequences (a1, a2, ...) are joined along the given axis
(default is the first one) into a single numpy array.
 
Example:
 
>>> concatenate( ([0,1,2], [5,6,7]) )
array([0, 1, 2, 5, 6, 7])
unmasked_index_ranges(mask, compressed=True)
Calculate the good data ranges in a masked 1-D array, based on mask.
 
Returns Nx2 array with each row the start and stop indices
for slices of the compressed array corresponding to each of N
uninterrupted runs of unmasked values.
If optional argument compressed is False, it returns the
start and stop indices into the original array, not the
compressed array.
Returns None if there are no unmasked values.
 
Example:
 
y = ma.array(arange(5), mask = [0,0,1,0,0])
#ii = unmasked_index_ranges(y.mask())
ii = unmasked_index_ranges(ma.getmask(y))
    # returns [[0,2,] [2,4,]]
 
y.compressed().filled()[ii[1,0]:ii[1,1]]
    # returns array [3,4,]
    # (The 'filled()' method converts the masked array to a numerix array.)
 
#i0, i1 = unmasked_index_ranges(y.mask(), compressed=False)
i0, i1 = unmasked_index_ranges(ma.getmask(y), compressed=False)
    # returns [[0,3,] [2,5,]]
 
y.filled()[ii[1,0]:ii[1,1]]
    # returns array [3,4,]

 
Data
        Float = 'd'
LOG10 = 1
NewAxis = None
TICKDOWN = 3
TICKLEFT = 0
TICKRIGHT = 1
TICKUP = 2
colorConverter = <matplotlib.colors.ColorConverter instance at 0x84b6aac>
cos = <ufunc 'cos'>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
greater = <ufunc 'greater'>
less = <ufunc 'less'>
less_equal = <ufunc 'less_equal'>
lineMarkers = {0: '_draw_tickleft', 1: '_draw_tickright', 2: '_draw_tickup', 3: '_draw_tickdown', '': '_draw_nothing', ' ': '_draw_nothing', '+': '_draw_plus', ',': '_draw_pixel', '.': '_draw_point', '1': '_draw_tri_down', ...}
lineStyles = {'': '_draw_nothing', ' ': '_draw_nothing', '-': '_draw_solid', '--': '_draw_dashed', '-.': '_draw_dash_dot', ':': '_draw_dotted', 'None': '_draw_nothing', 'steps': '_draw_steps'}
logical_and = <ufunc 'logical_and'>
pi = 3.1415926535897931
rcParams = {'axes.axisbelow': False, 'axes.edgecolor': 'k', 'axes.facecolor': 'w', 'axes.formatter.limits': (-7, 7), 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'k', 'axes.labelsize': 12, 'axes.linewidth': 1.0, 'axes.titlesize': 14, ...}
sin = <ufunc 'sin'>
sqrt = <ufunc 'sqrt'>
verbose = <matplotlib.Verbose instance at 0x82528ec>
@footer@