@header@
 
 
matplotlib.lines
index
/usr/lib/python2.4/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.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)
xdata is a sequence of x data
ydata is a sequence of y data
linewidth is the width of the line in points
linestyle is one of lineStyles
marker is one of lineMarkers or None
markersize is the size of the marker in points
markeredgecolor  and markerfacecolor can be any color arg
markeredgewidth is the size of the markter edge in points
dash_capstyle set the capstyle for dashed line
solid_capstyle set the capstyle for solid line
dash_joinstyle set the joinstyle for dashed line
solid_joinstyle set the joinstyle for solid line
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, valid_only=False)
get_ydata(self, valid_only=False)
is_dashed(self)
return True if line is dashstyle
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_c(self, val)
alias for set_color
set_color(self, color)
Set the color of the line
 
ACCEPTS: any matplotlib color - see help(colors)
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
 
ACCEPTS: sequence of on/off ink in points
set_data(self, *args)
Set the x and y data
 
ACCEPTS: (array xdata, array ydata)
set_data_clipping(self, b)
b is a boolean that sets whether data clipping is on
 
ACCEPTS: [True | False]
set_linestyle(self, s)
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' | '|' ]
set_markeredgecolor(self, ec)
Set the marker edge color
 
ACCEPTS: any matplotlib color - see help(colors)
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 - see help(colors)
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_xclip(self, *args)
Set the x clipping range for data clipping to xmin, xmax
 
ACCEPTS: (xmin, xmax)
set_xdata(self, x)
Set the data array for x
 
ACCEPTS: array
set_yclip(self, *args)
Set the y clipping range for data clipping to ymin, ymax
 
ACCEPTS: (ymin, ymax)
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:
validCap = ('butt', 'round', 'projecting')
validJoin = ('miter', 'round', 'bevel')
zorder = 2

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_clip_box(self)
Return artist clipbox
get_clip_on(self)
Return whether artist uses clipping
get_figure(self)
return the figure instance
get_label(self)
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
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_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_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_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
       
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.
searchsorted = binarysearch(...)
binarysearch(a,v)
take(...)
take(a, indices, axis=0).  Selects the elements in indices from array a along the given axis.
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.
In either case, an empty array is returned if there are no
unmasked values.
 
Example:
 
y = ma.array(arange(5), mask = [0,0,1,0,0])
ii = unmasked_index_ranges(y.mask())
    # 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)
    # returns [[0,3,] [2,5,]]
 
y.filled()[ii[1,0]:ii[1,1]]
    # returns array [3,4,]
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
        Float = 'd'
LOG10 = 1
TICKDOWN = 3
TICKLEFT = 0
TICKRIGHT = 1
TICKUP = 2
colorConverter = <matplotlib.colors.ColorConverter instance>
cos = <ufunc 'cos'>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
greater = <ufunc 'greater'>
less = <ufunc 'less'>
lineMarkers = {0: 1, 1: 1, 2: 1, 3: 1, '+': 1, ',': 1, '.': 1, '1': 1, '2': 1, '3': 1, ...}
lineStyles = {'-': 1, '--': 1, '-.': 1, ':': 1, 'None': 1, 'steps': 1}
logical_and = <ufunc 'logical_and'>
pi = 3.1415926535897931
rcParams = {'axes.edgecolor': 'black', 'axes.facecolor': 'white', 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'black', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'GTKAgg', 'datapath': '/usr/share/matplotlib', ...}
sin = <ufunc 'sin'>
verbose = <matplotlib.Verbose instance>
@footer@