matplotlib-checkins Mailing List for matplotlib (Page 15)

Revision: 5351
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5351&view=rev
Author: dsdale
Date: 2008年06月01日 14:36:50 -0700 (2008年6月01日)
Log Message:
-----------
continue conversion of docstrings to restructured text
Modified Paths:
--------------
 trunk/matplotlib/boilerplate.py
 trunk/matplotlib/lib/matplotlib/__init__.py
 trunk/matplotlib/lib/matplotlib/artist.py
 trunk/matplotlib/lib/matplotlib/axes.py
 trunk/matplotlib/lib/matplotlib/figure.py
 trunk/matplotlib/lib/matplotlib/pyplot.py
 trunk/matplotlib/lib/matplotlib/quiver.py
Modified: trunk/matplotlib/boilerplate.py
===================================================================
--- trunk/matplotlib/boilerplate.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/boilerplate.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -28,6 +28,7 @@
 return ret
 if Axes.%(func)s.__doc__ is not None:
 %(func)s.__doc__ = dedent(Axes.%(func)s.__doc__) + \"\"\"
+
 Additional kwargs: hold = [True|False] overrides default hold state\"\"\"
 """
 
Modified: trunk/matplotlib/lib/matplotlib/__init__.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/__init__.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/lib/matplotlib/__init__.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -653,38 +653,42 @@
 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 list of
- attribute name/value pairs, eg
+ attribute name/value pairs, eg::
 
 rc('lines', linewidth=2, color='r')
 
- sets the current rc params and is equivalent to
+ 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
- 'lw' : 'linewidth'
- 'ls' : 'linestyle'
- 'c' : 'color'
- 'fc' : 'facecolor'
- 'ec' : 'edgecolor'
- 'mew' : 'markeredgewidth'
- 'aa' : 'antialiased'
+ users:
 
- Thus you could abbreviate the above rc command as
+ ===== =================
+ 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 rc as follows::
 
 font = {'family' : 'monospace',
 'weight' : 'bold',
- 'size' : 'larger',
- }
+ 'size' : 'larger'}
 
 rc('font', **font) # pass in the font dict as kwargs
 
Modified: trunk/matplotlib/lib/matplotlib/artist.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/artist.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/lib/matplotlib/artist.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -724,9 +724,8 @@
 If you want to see all the properties that can be set, and their
 possible values, you can do
 
-
 >>> setp(line)
- ... long output listing omitted'
+ ... long output listing omitted
 
 setp operates on a single instance or a list of instances. If you
 are in query mode introspecting the possible values, only the first
@@ -734,17 +733,18 @@
 all the instances will be set. Eg, suppose you have a list of two
 lines, the following will make both lines thicker and red
 
- >>> x = arange(0,1.0,0.01)
- >>> y1 = sin(2*pi*x)
- >>> y2 = sin(4*pi*x)
- >>> lines = plot(x, y1, x, y2)
- >>> setp(lines, linewidth=2, color='r')
+ >>> x = arange(0,1.0,0.01)
+ >>> y1 = sin(2*pi*x)
+ >>> y2 = sin(4*pi*x)
+ >>> lines = plot(x, y1, x, y2)
+ >>> setp(lines, linewidth=2, color='r')
 
 setp works with the matlab(TM) style string/value pairs or with
 python kwargs. For example, the following are equivalent
 
- >>> setp(lines, 'linewidth', 2, 'color', r') # matlab style
- >>> setp(lines, linewidth=2, color='r') # python style
+ >>> setp(lines, 'linewidth', 2, 'color', r') # matlab style
+ >>> setp(lines, linewidth=2, color='r') # python style
+
 """
 
 insp = ArtistInspector(h)
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -2419,38 +2419,40 @@
 def text(self, x, y, s, fontdict=None,
 withdash=False, **kwargs):
 """
- TEXT(x, y, s, fontdict=None, **kwargs)
+ call signature::
 
+ text(x, y, s, fontdict=None, **kwargs)
+
 Add text in string s to axis at location x,y (data coords)
 
- fontdict is a dictionary to override the default text properties.
- If fontdict is None, the defaults are determined by your rc
- parameters.
+ Keyword arguments:
 
- withdash=True will create a TextWithDash instance instead
- of a Text instance.
+ fontdict:
+ a dictionary to override the default text properties.
+ If fontdict is None, the defaults are determined by your rc
+ parameters.
+ withdash: [ False | True ]
+ creates a TextWithDash instance instead of a Text instance.
 
 Individual keyword arguments can be used to override any given
- parameter
+ parameter::
 
 text(x, y, s, fontsize=12)
 
 The default transform specifies that text is in data coords,
 alternatively, you can specify text in axis coords (0,0 lower left and
 1,1 upper right). The example below places text in the center of the
- axes
+ axes::
 
 text(0.5, 0.5,'matplotlib',
 horizontalalignment='center',
 verticalalignment='center',
- transform = ax.transAxes,
- )
+ transform = ax.transAxes)
 
-
 You can put a rectangular box around the text instance (eg to
 set a background color) by using the keyword bbox. bbox is a
 dictionary of patches.Rectangle properties (see help
- for Rectangle for a list of these). For example
+ for Rectangle for a list of these). For example::
 
 text(x, y, s, bbox=dict(facecolor='red', alpha=0.5))
 
@@ -2946,22 +2948,31 @@
 def plot_date(self, x, y, fmt='bo', tz=None, xdate=True, ydate=False,
 **kwargs):
 """
- PLOT_DATE(x, y, fmt='bo', tz=None, xdate=True, ydate=False, **kwargs)
+ call signature::
 
+ plot_date(x, y, fmt='bo', tz=None, xdate=True, ydate=False, **kwargs)
+
 Similar to the plot() command, except the x or y (or both) data
 is considered to be dates, and the axis is labeled accordingly.
 
- x or y (or both) can be a sequence of dates represented as
- float days since 0001年01月01日 UTC.
+ x and/or y can be a sequence of dates represented as float days since
+ 0001年01月01日 UTC.
 
- fmt is a plot format string.
+ See dates for helper functions date2num, num2date
+ and drange for help on creating the required floating point dates
 
- tz is the time zone to use in labelling dates. Defaults to rc value.
+ Keyword arguments:
 
- If xdate is True, the x-axis will be labeled with dates.
+ fmt: string
+ The plot format string.
+ tz: [ None | timezone string ]
+ The time zone to use in labeling dates. If None, defaults to rc
+ value.
+ xdate: [ True | False ]
+ If True, the x-axis will be labeled with dates.
+ ydate: [ False | True ]
+ If True, the y-axis will be labeled with dates.
 
- If ydate is True, the y-axis will be labeled with dates.
-
 Note if you are using custom date tickers and formatters, it
 may be necessary to set the formatters/locators after the call
 to plot_date since plot_date will set the default tick locator
@@ -2973,9 +2984,6 @@
 Valid kwargs are Line2D properties:
 %(Line2D)s
 
-
- See dates for helper functions date2num, num2date
- and drange for help on creating the required floating point dates
 """
 
 if not self._hold: self.cla()
@@ -2999,10 +3007,10 @@
 
 loglog(*args, **kwargs)
 
- Make a plot with log scaling on the a and y axis. The args to loglog
- are the same as the args to ``plot``. See ``plot`` for more info.
+ Make a plot with log scaling on the x and y axis. The args to loglog
+ are the same as the args to plot. See plot for more info.
 
- loglog supports all the keyword arguments of ``plot`` and
+ loglog supports all the keyword arguments of plot and
 Axes.set_xscale/Axes.set_yscale.
 
 Notable keyword arguments:
@@ -3039,21 +3047,26 @@
 
 def semilogx(self, *args, **kwargs):
 """
- SEMILOGX(*args, **kwargs)
+ call signature::
 
- Make a semilog plot with log scaling on the x axis. The args to
- semilog x are the same as the args to plot. See help plot for more
- info.
+ semilogx(*args, **kwargs)
 
- Optional keyword args supported are any of the kwargs supported by
- plot or set_xscale. Notable, for log scaling:
+ Make a plot with log scaling on the x axis. The args to
+ semilogx are the same as the args to plot. See plot for
+ more info.
 
- * basex: base of the logarithm
+ semilogx supports all the keyword arguments of plot and
+ Axes.set_xscale.
 
- * subsx: the location of the minor ticks; None defaults to
- autosubs, which depend on the number of decades in the
- plot; see set_xscale for details
+ Notable keyword arguments:
 
+ basex: scalar > 1
+ base of the x logarithm
+ subsx: [ None | sequence ]
+ the location of the minor xticks; None defaults to
+ autosubs, which depend on the number of decades in the
+ plot; see set_xscale for details
+
 The remaining valid kwargs are Line2D properties:
 %(Line2D)s
 """
@@ -3072,24 +3085,28 @@
 
 def semilogy(self, *args, **kwargs):
 """
- SEMILOGY(*args, **kwargs):
+ call signature::
 
- Make a semilog plot with log scaling on the y axis. The args to
- semilogy are the same as the args to plot. See help plot for more
- info.
+ semilogy(*args, **kwargs)
 
- Optional keyword args supported are any of the kwargs supported by
- plot or set_yscale. Notable, for log scaling:
+ Make a plot with log scaling on the y axis. The args to
+ semilogy are the same as the args to plot. See plot for
+ more info.
 
- * basey: base of the logarithm
+ semilogy supports all the keyword arguments of plot and
+ Axes.set_yscale.
 
- * subsy: a sequence of the location of the minor ticks;
- None defaults to autosubs, which depend on the number of
- decades in the plot; see set_yscale for details
+ Notable keyword arguments:
 
+ basey: scalar > 1
+ base of the y logarithm
+ subsy: [ None | sequence ]
+ the location of the minor yticks; None defaults to
+ autosubs, which depend on the number of decades in the
+ plot; see set_yscale for details
+
 The remaining valid kwargs are Line2D properties:
 %(Line2D)s
-
 """
 if not self._hold: self.cla()
 d = {'basey': kwargs.pop('basey', 10),
@@ -3352,21 +3369,25 @@
 
 def step(self, x, y, *args, **kwargs):
 '''
- step(x, y, *args, **kwargs)
+ call signature::
 
+ step(x, y, *args, **kwargs)
+
 x and y must be 1-D sequences, and it is assumed, but not checked,
 that x is uniformly increasing.
 
- Make a step plot. The args and keyword args to step are the same
- as the args to plot. See help plot for more info.
+ Keyword arguments:
 
- Additional keyword args for step:
+ where: [ 'pre' | 'post' | 'mid' ]
+ if 'pre', the interval from x[i] to x[i+1] has level y[i]
 
- * where: can be 'pre', 'post' or 'mid'; if 'pre', the
- interval from x[i] to x[i+1] has level y[i];
- if 'post', that interval has level y[i+1];
- and if 'mid', the jumps in y occur half-way
- between the x-values. Default is 'pre'.
+ if 'post', that interval has level y[i+1]
+
+ if 'mid', the jumps in y occur half-way between the x-values.
+
+ Make a step plot. Additional keyword args to step are the same
+ as those for plot. See plot for more info.
+
 '''
 
 where = kwargs.pop('where', 'pre')
@@ -3733,8 +3754,10 @@
 
 def stem(self, x, y, linefmt='b-', markerfmt='bo', basefmt='r-'):
 """
- STEM(x, y, linefmt='b-', markerfmt='bo', basefmt='r-')
+ call signature::
 
+ stem(x, y, linefmt='b-', markerfmt='bo', basefmt='r-')
+
 A stem plot plots vertical lines (using linefmt) at each x location
 from the baseline to y, and places a marker there using markerfmt. A
 horizontal line at 0 is is plotted using basefmt
@@ -3763,51 +3786,51 @@
 return markerline, stemlines, baseline
 
 
- def pie(self, x, explode=None, labels=None,
- colors=None,
- autopct=None,
- pctdistance=0.6,
- shadow=False,
- labeldistance=1.1,
- ):
+ def pie(self, x, explode=None, labels=None, colors=None,
+ autopct=None, pctdistance=0.6, shadow=False,
+ labeldistance=1.1):
 """
- PIE(x, explode=None, labels=None,
- colors=('b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'),
- autopct=None, pctdistance=0.6, labeldistance=1.1, shadow=False)
+ call signature::
 
+ pie(x, explode=None, labels=None,
+ colors=('b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'),
+ autopct=None, pctdistance=0.6, labeldistance=1.1, shadow=False)
+
 Make a pie chart of array x. The fractional area of each wedge is
 given by x/sum(x). If sum(x)<=1, then the values of x give the
 fractional area directly and the array will not be normalized.
 
- - explode, if not None, is a len(x) array which specifies the
- fraction of the radius to offset that wedge.
+ Keyword arguments:
 
- - colors is a sequence of matplotlib color args that the pie chart
+ explode: [ None | len(x) sequence ]
+ If not None, is a len(x) array which specifies the
+ fraction of the radius with which to offset each wedge.
+ colors: [ None | color sequence ]
+ A sequence of matplotlib color args through which the pie chart
 will cycle.
-
- - labels, if not None, is a len(x) list of labels.
-
- - autopct, if not None, is a string or function used to label the
+ labels: [ None | len(x) sequence of strings ]
+ A sequence of strings providing the labels for each wedge
+ autopct: [ None | format string | format function ]
+ If not None, is a string or function used to label the
 wedges with their numeric value. The label will be placed inside
 the wedge. If it is a format string, the label will be fmt%pct.
 If it is a function, it will be called
+ pctdistance: scalar
+ The ratio between the center of each pie slice and the start of the
+ text generated by autopct. Ignored if autopct is None; default is
+ 0.6.
+ labeldistance: scalar
+ The radial distance at which the pie labels are drawn
+ shadow: [ False | True ]
+ Draw a shadow beneath the pie.
 
- - pctdistance is the ratio between the center of each pie slice
- and the start of the text generated by autopct. Ignored if autopct
- is None; default is 0.6.
-
- - labeldistance is the radial distance at which the pie labels are drawn
-
- - shadow, if True, will draw a shadow beneath the pie.
-
 The pie chart will probably look best if the figure and axes are
- square. Eg,
+ square. Eg::
 
 figure(figsize=(8,8))
 ax = axes([0.1, 0.1, 0.8, 0.8])
 
 Return value:
-
 If autopct is None, return a list of (patches, texts), where patches
 is a sequence of mpatches.Wedge instances and texts is a
 list of the label Text instnaces
@@ -3815,6 +3838,7 @@
 If autopct is not None, return (patches, texts, autotexts), where
 patches and texts are as above, and autotexts is a list of text
 instances for the numeric labels
+
 """
 self.set_frame_on(False)
 
@@ -4314,97 +4338,109 @@
 faceted=True, verts=None,
 **kwargs):
 """
- SCATTER(x, y, s=20, c='b', marker='o', cmap=None, norm=None,
- vmin=None, vmax=None, alpha=1.0, linewidths=None,
- verts=None, **kwargs)
- Supported function signatures:
+ call signatures::
 
- SCATTER(x, y, **kwargs)
- SCATTER(x, y, s, **kwargs)
- SCATTER(x, y, s, c, **kwargs)
+ scatter(x, y, s=20, c='b', marker='o', cmap=None, norm=None,
+ vmin=None, vmax=None, alpha=1.0, linewidths=None,
+ verts=None, **kwargs)
 
 Make a scatter plot of x versus y, where x, y are 1-D sequences
 of the same length, N.
 
- Arguments s and c can also be given as kwargs; this is encouraged
- for readability.
+ Keyword arguments:
 
- s is a size in points^2. It is a scalar
- or an array of the same length as x and y.
+ s:
+ size in points^2. It is a scalar or an array of the same
+ length as x and y.
+ c:
+ a color. c can be a single color format string, or a
+ sequence of color specifications of length N, or a sequence
+ of N numbers to be mapped to colors using the cmap and norm
+ specified via kwargs (see below). Note that c should not be
+ a single numeric RGB or RGBA sequence because that is
+ indistinguishable from an array of values to be colormapped.
+ c can be a 2-D array in which the rows are RGB or RGBA,
+ however.
+ marker:
+ can be one of:
 
- c is a color and can be a single color format string,
- or a sequence of color specifications of length N,
- or a sequence of N numbers to be mapped to colors
- using the cmap and norm specified via kwargs (see below).
- Note that c should not be a single numeric RGB or RGBA
- sequence because that is indistinguishable from an array
- of values to be colormapped. c can be a 2-D array in which
- the rows are RGB or RGBA, however.
+ ===== ==============
+ Value Description
+ ===== ==============
+ 's' square
+ 'o' circle
+ '^' triangle up
+ '>' triangle right
+ 'v' triangle down
+ '<' triangle left
+ 'd' diamond
+ 'p' pentagram
+ 'h' hexagon
+ '8' octagon
+ '+' plus
+ 'x' cross
+ ===== ==============
 
- The marker can be one of
+ The marker can also be a tuple (numsides, style, angle), which will
+ create a custom, regular symbol.
 
- 's' : square
- 'o' : circle
- '^' : triangle up
- '>' : triangle right
- 'v' : triangle down
- '<' : triangle left
- 'd' : diamond
- 'p' : pentagram
- 'h' : hexagon
- '8' : octagon
- '+' : plus
- 'x' : cross
+ numsides:
+ the number of sides
+ style:
+ the style of the regular symbol:
 
- The marker can also be a tuple (numsides, style, angle), which will
- create a custom, regular symbol.
+ ===== ==================
+ Value Description
+ ===== ==================
+ 0 a regular polygon
+ 1 a star-like symbol
+ 2 an asterisk
+ ===== ==================
 
- numsides is the number of sides
+ angle:
+ the angle of rotation of the symbol
 
- style is the style of the regular symbol:
- 0 : a regular polygon
- 1 : a star-like symbol
- 2 : an asterisk
+ Finally, marker can be (verts, 0), verts is a sequence of (x,y)
+ vertices for a custom scatter symbol. Alternatively, use the
+ kwarg combination marker=None, verts=verts.
 
- angle is the angle of rotation of the symbol
-
- Finally, marker can be (verts, 0), verts is a sequence of (x,y)
- vertices for a custom scatter symbol. Alternatively, use the
- kwarg combination marker=None,verts=verts.
-
 Any or all of x, y, s, and c may be masked arrays, in which
 case all masks will be combined and only unmasked points
 will be plotted.
 
- Other keyword args; the color mapping and normalization arguments will
- be used only if c is an array of floats
+ Other keyword arguments: the color mapping and normalization
+ arguments will be used only if c is an array of floats.
 
- * cmap = cm.jet : a colors.Colormap instance from cm.
- defaults to rc image.cmap
-
- * norm = colors.Normalize() : colors.Normalize instance
- is used to scale luminance data to 0,1.
-
- * vmin=None and vmax=None : vmin and vmax are used in conjunction
- with norm to normalize luminance data. If either are None, the
- min and max of the color array C is used. Note if you pass a norm
- instance, your settings for vmin and vmax will be ignored
-
- * alpha =1.0 : the alpha value for the patches
-
- * linewidths, if None, defaults to (lines.linewidth,). Note
+ cmap: [ None | Colormap ]
+ a colors.Colormap instance from cm. If None, defaults to rc
+ image.cmap. cmap is only used if c is an array of floats.
+ norm: [ None | Normalize ]
+ a colors.Normalize instance is used to scale luminance data
+ to 0,1. If None, use the default normalize(). norm is only
+ used if c is an array of floats.
+ vmin/vmax:
+ vmin and vmax are used in conjunction with norm to normalize
+ luminance data. If either are None, the min and max of the
+ color array C is used. Note if you pass a norm instance, your
+ settings for vmin and vmax will be ignored.
+ alpha: 0 <= scalar <= 1
+ the alpha value for the patches
+ linewidths: [ None | scalar | sequence ]
+ if None, defaults to (lines.linewidth,). Note
 that this is a tuple, and if you set the linewidths
 argument you must set it as a sequence of floats, as
 required by RegularPolyCollection -- see
 collections.RegularPolyCollection for details
 
- Optional kwargs control the Collection properties; in
- particular:
+ Optional kwargs control the Collection properties; in
+ particular:
 
- edgecolors='none' : to plot faces with no outlines
- facecolors='none' : to plot unfilled outlines
+ edgecolors:
+ 'none' to plot faces with no outlines
+ facecolors:
+ 'none' to plot unfilled outlines
 
- Here are the standard descriptions of all the Collection kwargs:
+ Here are the standard descriptions of all the Collection kwargs:
 %(Collection)s
 
 A Collection instance is returned
@@ -4829,9 +4865,6 @@
 quiverkey.__doc__ = mquiver.QuiverKey.quiverkey_doc
 
 def quiver(self, *args, **kw):
- """
- TODO: Document me
- """
 q = mquiver.Quiver(self, *args, **kw)
 self.add_collection(q, False)
 self.update_datalim(q.XY)
@@ -5026,9 +5059,9 @@
 
 def pcolor(self, *args, **kwargs):
 """
- pcolor(*args, **kwargs): pseudocolor plot of a 2-D array
+ Create a pseudocolor plot of a 2-D array
 
- Function signatures
+ call signatures::
 
 pcolor(C, **kwargs)
 pcolor(X, Y, C, **kwargs)
@@ -5054,72 +5087,73 @@
 of the vertices surrounding C[i,j] (X or Y at [i,j],[i+1,j],
 [i,j+1],[i=1,j+1]) is masked, nothing is plotted.
 
- Optional keyword args are shown with their defaults below (you must
- use kwargs for these):
+ Keyword arguments:
 
- * cmap = cm.jet : a cm Colormap instance from cm
+ cmap: [ None | Colormap ]
+ A cm Colormap instance from cm. If None, use rc settings.
+ norm: [ None | Normalize ]
+ An mcolors.Normalize instance is used to scale luminance data to
+ 0,1. If None, defaults to normalize()
+ vmin/vmax: [ None | scalar ]
+ vmin and vmax are used in conjunction with norm to normalize
+ luminance data. If either are None, the min and max of the color
+ array C is used. If you pass a norm instance, vmin and vmax will
+ be None.
+ shading: [ 'flat' | 'faceted' ]
+ If 'faceted', a black grid is drawn around each rectangle; if
+ 'flat', edges are not drawn. Default is 'flat', contrary to
+ Matlab(TM).
 
- * norm = Normalize() : mcolors.Normalize instance
- is used to scale luminance data to 0,1.
+ This kwarg is deprecated; please use 'edgecolors' instead:
+ * shading='flat' -- edgecolors='None'
+ * shading='faceted -- edgecolors='k'
+ edgecolors: [ None | 'None' | color | color sequence]
+ If None, the rc setting is used by default.
+ If 'None', edges will not be visible.
+ An mpl color or sequence of colors will set the edge color
+ alpha: 0 <= scalar <= 1
+ the alpha blending value
 
- * vmin=None and vmax=None : vmin and vmax are used in conjunction
- with norm to normalize luminance data. If either are None, the
- min and max of the color array C is used. If you pass a norm
- instance, vmin and vmax will be None
+ Return value is a matplotlib.collection.Collection object
 
- * shading = 'flat' : or 'faceted'. If 'faceted', a black grid is
- drawn around each rectangle; if 'flat', edges are not drawn.
- Default is 'flat', contrary to Matlab(TM).
- This kwarg is deprecated;
- please use the edgecolors kwarg instead:
- shading='flat' --> edgecolors='None'
- shading='faceted --> edgecolors='k'
- edgecolors can also be None to specify the rcParams
- default, or any mpl color or sequence of colors.
+ The grid orientation follows the Matlab(TM) convention: an
+ array C with shape (nrows, ncolumns) is plotted with
+ the column number as X and the row number as Y, increasing
+ up; hence it is plotted the way the array would be printed,
+ except that the Y axis is reversed. That is, C is taken
+ as C(y,x).
 
- * alpha=1.0 : the alpha blending value
+ Similarly for meshgrid::
 
- Return value is a mcoll.Collection
- object
+ x = np.arange(5)
+ y = np.arange(3)
+ X, Y = meshgrid(x,y)
 
- Grid Orientation
+ is equivalent to:
 
- The orientation follows the Matlab(TM) convention: an
- array C with shape (nrows, ncolumns) is plotted with
- the column number as X and the row number as Y, increasing
- up; hence it is plotted the way the array would be printed,
- except that the Y axis is reversed. That is, C is taken
- as C(y,x).
+ X = array([[0, 1, 2, 3, 4],
+ [0, 1, 2, 3, 4],
+ [0, 1, 2, 3, 4]])
 
- Similarly for meshgrid:
+ Y = array([[0, 0, 0, 0, 0],
+ [1, 1, 1, 1, 1],
+ [2, 2, 2, 2, 2]])
 
- x = np.arange(5)
- y = np.arange(3)
- X, Y = meshgrid(x,y)
+ so if you have::
 
- is equivalent to
+ C = rand( len(x), len(y))
 
- X = array([[0, 1, 2, 3, 4],
- [0, 1, 2, 3, 4],
- [0, 1, 2, 3, 4]])
+ then you need::
 
- Y = array([[0, 0, 0, 0, 0],
- [1, 1, 1, 1, 1],
- [2, 2, 2, 2, 2]])
+ pcolor(X, Y, C.T)
 
- so if you have
- C = rand( len(x), len(y))
- then you need
- pcolor(X, Y, C.T)
- or
- pcolor(C.T)
+ or::
 
- Dimensions
+ pcolor(C.T)
 
- Matlab pcolor always discards
- the last row and column of C, but matplotlib displays
- the last row and column if X and Y are not specified, or
- if X and Y have one more row and column than C.
+ Matlab pcolor always discards the last row and column of C, but
+ matplotlib displays the last row and column if X and Y are not
+ specified, or if X and Y have one more row and column than C.
 
 
 kwargs can be used to control the PolyCollection properties:
@@ -5214,49 +5248,45 @@
 
 def pcolormesh(self, *args, **kwargs):
 """
- PCOLORMESH(*args, **kwargs)
+ call signatures::
 
- Function signatures
+ pcolormesh(C)
+ pcolormesh(X, Y, C)
+ pcolormesh(C, **kwargs)
 
- PCOLORMESH(C) - make a pseudocolor plot of matrix C
-
- PCOLORMESH(X, Y, C) - a pseudo color plot of C on the matrices X and Y
-
- PCOLORMESH(C, **kwargs) - Use keyword args to control colormapping and
- scaling; see below
-
 C may be a masked array, but X and Y may not. Masked array support
 is implemented via cmap and norm; in contrast, pcolor simply does
 not draw quadrilaterals with masked colors or vertices.
 
- Optional keyword args are shown with their defaults below (you must
- use kwargs for these):
+ Keyword arguments:
 
- * cmap = cm.jet : a cm Colormap instance from cm.
+ cmap: [ None | Colormap ]
+ A cm Colormap instance from cm. If None, use rc settings.
+ norm: [ None | Normalize ]
+ An mcolors.Normalize instance is used to scale luminance data to
+ 0,1. If None, defaults to normalize()
+ vmin/vmax: [ None | scalar ]
+ vmin and vmax are used in conjunction with norm to normalize
+ luminance data. If either are None, the min and max of the color
+ array C is used. If you pass a norm instance, vmin and vmax will
+ be None.
+ shading: [ 'flat' | 'faceted' ]
+ If 'faceted', a black grid is drawn around each rectangle; if
+ 'flat', edges are not drawn. Default is 'flat', contrary to
+ Matlab(TM).
 
- * norm = Normalize() : colors.Normalize instance
- is used to scale luminance data to 0,1. Instantiate it
- with clip=False if C is a masked array.
+ This kwarg is deprecated; please use 'edgecolors' instead:
+ * shading='flat' -- edgecolors='None'
+ * shading='faceted -- edgecolors='k'
+ edgecolors: [ None | 'None' | color | color sequence]
+ If None, the rc setting is used by default.
+ If 'None', edges will not be visible.
+ An mpl color or sequence of colors will set the edge color
+ alpha: 0 <= scalar <= 1
+ the alpha blending value
 
- * vmin=None and vmax=None : vmin and vmax are used in conjunction
- with norm to normalize luminance data. If either are None, the
- min and max of the color array C is used.
+ Return value is a matplotlib.collection.Collection object
 
- * shading = 'flat' : or 'faceted'. If 'faceted', a black grid is
- drawn around each rectangle; if 'flat', edges are not drawn.
- Default is 'flat', contrary to Matlab(TM).
- This kwarg is deprecated;
- please use the edgecolors kwarg instead:
- shading='flat' --> edgecolors='None'
- shading='faceted --> edgecolors='k'
- More flexible specification of edgecolors, as in pcolor,
- is not presently supported.
-
- * alpha=1.0 : the alpha blending value
-
- Return value is a collections.Collection
- object
-
 See pcolor for an explantion of the grid orientation and the
 expansion of 1-D X and/or Y to 2-D arrays.
 
@@ -5754,9 +5784,11 @@
 def psd(self, x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
 window=mlab.window_hanning, noverlap=0, **kwargs):
 """
- PSD(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
- window=mlab.window_hanning, noverlap=0, **kwargs)
+ call signature::
 
+ psd(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
+ window=mlab.window_hanning, noverlap=0, **kwargs)
+
 The power spectral density by Welches average periodogram method. The
 vector x is divided into NFFT length segments. Each segment is
 detrended by function detrend and windowed by function window.
@@ -5765,35 +5797,37 @@
 with a scaling to correct for power loss due to windowing. Fs is the
 sampling frequency.
 
- * NFFT is the length of the fft segment; must be a power of 2
+ Keyword arguments::
 
- * Fs is the sampling frequency.
+ NFFT: integer
+ The length of the fft segment, must be a power of 2
+ Fs: integer
+ The sampling frequency.
+ Fc: integer
+ The center frequency of x (defaults to 0), which offsets
+ the yextents of the image to reflect the frequency range used
+ when a signal is acquired and then filtered and downsampled to
+ baseband.
+ detrend:
+ The function applied to each segment before fft-ing,
+ designed to remove the mean or linear trend. Unlike in matlab,
+ where the detrend parameter is a vector, in matplotlib is it a
+ function. The mlab module defines detrend_none, detrend_mean,
+ detrend_linear, but you can use a custom function as well.
+ window:
+ The function used to window the segments. window is a
+ function, unlike in matlab where it is a vector. mlab defines
+ window_none, window_hanning, but you can use a custom function
+ as well.
+ noverlap: integer
+ Gives the length of the overlap between segments.
 
- * Fc is the center frequency of x (defaults to 0), which offsets
- the yextents of the image to reflect the frequency range used
- when a signal is acquired and then filtered and downsampled to
- baseband.
-
- * detrend - the function applied to each segment before fft-ing,
- designed to remove the mean or linear trend. Unlike in matlab,
- where the detrend parameter is a vector, in matplotlib is it a
- function. The mlab module defines detrend_none, detrend_mean,
- detrend_linear, but you can use a custom function as well.
-
- * window - the function used to window the segments. window is a
- function, unlike in matlab(TM) where it is a vector. mlab defines
- window_none, window_hanning, but you can use a custom function
- as well.
-
- * noverlap gives the length of the overlap between segments.
-
 Returns the tuple Pxx, freqs
 
 For plotting, the power is plotted as 10*np.log10(pxx) for decibels,
 though pxx itself is returned
 
- Refs:
-
+ References:
 Bendat & Piersol -- Random Data: Analysis and Measurement
 Procedures, John Wiley & Sons (1986)
 
@@ -5917,35 +5951,35 @@
 window=mlab.window_hanning, noverlap=128,
 cmap = None, xextent=None):
 """
- SPECGRAM(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
- window = mlab.window_hanning, noverlap=128,
- cmap=None, xextent=None)
+ call signature::
 
+ specgram(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
+ window = mlab.window_hanning, noverlap=128,
+ cmap=None, xextent=None)
+
 Compute a spectrogram of data in x. Data are split into NFFT length
 segements and the PSD of each section is computed. The windowing
 function window is applied to each segment, and the amount of overlap
 of each segment is specified with noverlap.
 
- * cmap is a colormap; if None use default determined by rc
+ Keyword arguments:
 
- * xextent is the image extent in the xaxes xextent=xmin, xmax -
- default 0, max(bins), 0, max(freqs) where bins is the return
- value from mlab.specgram
+ cmap:
+ a colormap; if None use default determined by rc
+ xextent:
+ the image extent in the xaxes xextent=xmin, xmax
+ default 0, max(bins), 0, max(freqs) where bins is the return
+ value from mlab.specgram
 
- * See help(psd) for information on the other keyword arguments.
+ See help(psd) for information on the other keyword arguments.
 
- Return value is (Pxx, freqs, bins, im), where
+ Return value is (Pxx, freqs, bins, im), where bins are the time
+ points the spectrogram is calculated over, freqs is an array of
+ frequencies, Pxx is a len(times) x len(freqs) array of power, and
+ im is a image.AxesImage.
 
- bins are the time points the spectrogram is calculated over
-
- freqs is an array of frequencies
-
- Pxx is a len(times) x len(freqs) array of power
-
- im is a image.AxesImage.
-
- Note: If x is real (i.e. non-complex) only the positive spectrum is
- shown. If x is complex both positive and negative parts of the
+ Note: If x is real (i.e. non-complex), only the positive spectrum
+ is shown. If x is complex both positive and negative parts of the
 spectrum are shown.
 """
 if not self._hold: self.cla()
@@ -5967,8 +6001,13 @@
 return Pxx, freqs, bins, im
 
 def spy(self, Z, precision=None, marker=None, markersize=None,
- aspect='equal', **kwargs):
+ aspect='equal', **kwargs):
 """
+ call signature::
+
+ spy(Z, precision=None, marker=None, markersize=None,
+ aspect='equal', **kwargs)
+
 spy(Z) plots the sparsity pattern of the 2-D array Z
 
 If precision is None, any non-zero value will be plotted;
@@ -5995,24 +6034,32 @@
 kwargs passed to the axes plot method.
 
 If marker and markersize are None, useful kwargs include:
- cmap
- alpha
+
+ * cmap
+ * alpha
+
 See documentation for imshow() for details.
- For controlling colors, e.g. cyan background and red marks, use:
- cmap = mcolors.ListedColormap(['c','r'])
 
+ For controlling colors, e.g. cyan background and red marks,
+ use::
+
+ cmap = mcolors.ListedColormap(['c','r'])
+
 If marker or markersize is not None, useful kwargs include:
- marker
- markersize
- color
+
+ * marker
+ * markersize
+ * color
+
 See documentation for plot() for details.
 
 Useful values for marker include:
- 's' square (default)
- 'o' circle
- '.' point
- ',' pixel
 
+ * 's' square (default)
+ * 'o' circle
+ * '.' point
+ * ',' pixel
+
 """
 if marker is None and markersize is None:
 if hasattr(Z, 'tocoo'):
Modified: trunk/matplotlib/lib/matplotlib/figure.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/figure.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/lib/matplotlib/figure.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -917,32 +917,37 @@
 
 def savefig(self, *args, **kwargs):
 """
- SAVEFIG(fname, dpi=None, facecolor='w', edgecolor='w',
- orientation='portrait', papertype=None, format=None):
+ call signature::
 
+ savefig(fname, dpi=None, facecolor='w', edgecolor='w',
+ orientation='portrait', papertype=None, format=None):
+
 Save the current figure.
 
- fname - the filename to save the current figure to. The
- output formats supported depend on the backend being
- used. and are deduced by the extension to fname.
- Possibilities are eps, jpeg, pdf, png, ps, svg. fname
- can also be a file or file-like object - cairo backend
- only.
+ Arguments:
 
- dpi - is the resolution in dots per inch. If
- None it will default to the value savefig.dpi in the
- matplotlibrc file
+ fname:
+ the filename to save the current figure to. The output
+ formats supported depend on the backend being used. and
+ are deduced by the extension to fname. Possibilities are eps,
+ jpeg, pdf, png, ps, svg. fname can also be a file or file-like
+ object - cairo backend only.
 
- facecolor and edgecolor are the colors of the figure rectangle
+ Keyword arguments:
 
- orientation is either 'landscape' or 'portrait' - not supported on
- all backends; currently only on postscript output
-
- papertype is is one of 'letter', 'legal', 'executive', 'ledger', 'a0'
- through 'a10', or 'b0' through 'b10' - only supported for postscript
- output
-
- format - one of the file extensions supported by the active backend.
+ dpi: [ None | scalar > 0 ]
+ The resolution in dots per inch. If None it will default to
+ the value savefig.dpi in the matplotlibrc file.
+ facecolor, edgecolor:
+ the colors of the figure rectangle
+ orientation: [ 'landscape' | 'portrait' ]
+ not supported on all backends; currently only on postscript output
+ papertype:
+ One of 'letter', 'legal', 'executive', 'ledger', 'a0' through
+ 'a10', 'b0' through 'b10'. Only supported for postscript
+ output
+ format:
+ one of the file extensions supported by the active backend.
 """
 
 for key in ('dpi', 'facecolor', 'edgecolor'):
Modified: trunk/matplotlib/lib/matplotlib/pyplot.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 15:37:48 UTC (rev 5350)
+++ trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 21:36:50 UTC (rev 5351)
@@ -374,7 +374,11 @@
 
 def over(func, *args, **kwargs):
 """
- Call func(*args, **kwargs) with hold(True) and then restore the hold state
+ over calls::
+
+ func(*args, **kwargs)
+
+ with hold(True) and then restores the hold state.
 """
 h = ishold()
 hold(True)
@@ -607,13 +611,12 @@
 """
 Set the title of the current axis to s
 
- Default font override is:
- override = {
- 'fontsize' : 'medium',
- 'verticalalignment' : 'bottom',
- 'horizontalalignment' : 'center'
- }
+ Default font override is::
 
+ override = {'fontsize': 'medium',
+ 'verticalalignment': 'bottom',
+ 'horizontalalignment': 'center'}
+
 See the text docstring for information of how override and the
 optional args work
 
@@ -891,29 +894,24 @@
 """
 Set/Get the radial locations of the gridlines and ticklabels
 
- With no args, simply return lines, labels where lines is an
- array of radial gridlines (Line2D instances) and labels is an
- array of tick labels (Text instances).
+ call signatures::
 
 lines, labels = rgrids()
-
- With arguments, the syntax is
-
 lines, labels = RGRIDS(radii, labels=None, angle=22.5, **kwargs)
 
- The labels will appear at radial distances radii at angle
+ When called with no arguments, rgrid simply returns (lines, labels),
+ where lines is an array of radial gridlines (Line2D instances) and
+ labels is an array of tick labels (Text instances). When called
+ with arguments, the labels will appear at the specified radial
+ distances and angles.
 
- labels, if not None, is a len(radii) list of strings of the
- labels to use at each angle.
+ labels, if not None, is a len(radii) list of strings of the
+ labels to use at each angle.
 
- if labels is None, the self.rformatter will be used
+ if labels is None, the self.rformatter will be used
 
- Return value is a list of lines, labels where the lines are
- matplotlib.Line2D instances and the labels are matplotlib.Text
- instances. Note that on input the labels argument is a list of
- strings, and on output it is a list of Text instances
+ Examples::
 
- Examples
 # set the locations of the radial gridlines and labels
 lines, labels = rgrids( (0.25, 0.5, 1.0) )
 
@@ -993,74 +991,81 @@
 def plotting():
 """
 Plotting commands
- axes - Create a new axes
- axis - Set or return the current axis limits
- bar - make a bar chart
- boxplot - make a box and whiskers chart
- cla - clear current axes
- clabel - label a contour plot
- clf - clear a figure window
- close - close a figure window
- colorbar - add a colorbar to the current figure
- cohere - make a plot of coherence
- contour - make a contour plot
- contourf - make a filled contour plot
- csd - make a plot of cross spectral density
- draw - force a redraw of the current figure
- errorbar - make an errorbar graph
- figlegend - add a legend to the figure
- figimage - add an image to the figure, w/o resampling
- figtext - add text in figure coords
- figure - create or change active figure
- fill - make filled polygons
- gca - return the current axes
- gcf - return the current figure
- gci - get the current image, or None
- getp - get a handle graphics property
- hist - make a histogram
- hold - set the hold state on current axes
- legend - add a legend to the axes
- loglog - a log log plot
- imread - load image file into array
- imshow - plot image data
- matshow - display a matrix in a new figure preserving aspect
- pcolor - make a pseudocolor plot
- plot - make a line plot
- plotfile - plot data from a flat file
- psd - make a plot of power spectral density
- quiver - make a direction field (arrows) plot
- rc - control the default params
- savefig - save the current figure
- scatter - make a scatter plot
- setp - set a handle graphics property
- semilogx - log x axis
- semilogy - log y axis
- show - show the figures
- specgram - a spectrogram plot
- stem - make a stem plot
- subplot - make a subplot (numrows, numcols, axesnum)
- table - add a table to the axes
- text - add some text at location x,y to the current axes
- title - add a title to the current axes
- xlabel - add an xlabel to the current axes
- ylabel - add a ylabel to the current axes
 
- autumn - set the default colormap to autumn
- bone - set the default colormap to bone
- cool - set the default colormap to cool
- copper - set the default colormap to copper
- flag - set the default colormap to flag
- gray - set the default colormap to gray
- hot - set the default colormap to hot
- hsv - set the default colormap to hsv
- jet - set the default colormap to jet
- pink - set the default colormap to pink
- prism - set the default colormap to prism
- spring - set the default colormap to spring
- summer - set the default colormap to summer
- winter - set the default colormap to winter
- spectral - set the default colormap to spectral
+ ========= =================================================
+ Command Description
+ ========= =================================================
+ axes Create a new axes
+ axis Set or return the current axis limits
+ bar make a bar chart
+ boxplot make a box and whiskers chart
+ cla clear current axes
+ clabel label a contour plot
+ clf clear a figure window
+ close close a figure window
+ colorbar add a colorbar to the current figure
+ cohere make a plot of coherence
+ contour make a contour plot
+ contourf make a filled contour plot
+ csd make a plot of cross spectral density
+ draw force a redraw of the current figure
+ errorbar make an errorbar graph
+ figlegend add a legend to the figure
+ figimage add an image to the figure, w/o resampling
+ figtext add text in figure coords
+ figure create or change active figure
+ fill make filled polygons
+ gca return the current axes
+ gcf return the current figure
+ gci get the current image, or None
+ getp get a handle graphics property
+ hist make a histogram
+ hold set the hold state on current axes
+ legend add a legend to the axes
+ loglog a log log plot
+ imread load image file into array
+ imshow plot image data
+ matshow display a matrix in a new figure preserving aspect
+ pcolor make a pseudocolor plot
+ plot make a line plot
+ plotfile plot data from a flat file
+ psd make a plot of power spectral density
+ quiver make a direction field (arrows) plot
+ rc control the default params
+ savefig save the current figure
+ scatter make a scatter plot
+ setp set a handle graphics property
+ semilogx log x axis
+ semilogy log y axis
+ show show the figures
+ specgram a spectrogram plot
+ stem make a stem plot
+ subplot make a subplot (numrows, numcols, axesnum)
+ table add a table to the axes
+ text add some text at location x,y to the current axes
+ title add a title to the current axes
+ xlabel add an xlabel to the current axes
+ ylabel add a ylabel to the current axes
+ ========= =================================================
 
+ The following commands will set the default colormap accordingly:
+
+ * autumn
+ * bone
+ * cool
+ * copper
+ * flag
+ * gray
+ * hot
+ * hsv
+ * jet
+ * pink
+ * prism
+ * spring
+ * summer
+ * winter
+ * spectral
+
 """
 pass
 
@@ -1248,8 +1253,10 @@
 
 def polar(*args, **kwargs):
 """
- POLAR(theta, r)
+ call signature::
 
+ polar(theta, r, **kwargs)
+
 Make a polar plot. Multiple theta, r arguments are supported,
 with format strings, as in plot.
 """
@@ -1378,6 +1385,7 @@
 return ret
 if Axes.acorr.__doc__ is not None:
 acorr.__doc__ = dedent(Axes.acorr.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1399,6 +1407,7 @@
 return ret
 if Axes.arrow.__doc__ is not None:
 arrow.__doc__ = dedent(Axes.arrow.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1420,6 +1429,7 @@
 return ret
 if Axes.axhline.__doc__ is not None:
 axhline.__doc__ = dedent(Axes.axhline.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1441,6 +1451,7 @@
 return ret
 if Axes.axhspan.__doc__ is not None:
 axhspan.__doc__ = dedent(Axes.axhspan.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1462,6 +1473,7 @@
 return ret
 if Axes.axvline.__doc__ is not None:
 axvline.__doc__ = dedent(Axes.axvline.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1483,6 +1495,7 @@
 return ret
 if Axes.axvspan.__doc__ is not None:
 axvspan.__doc__ = dedent(Axes.axvspan.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1504,6 +1517,7 @@
 return ret
 if Axes.bar.__doc__ is not None:
 bar.__doc__ = dedent(Axes.bar.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1525,6 +1539,7 @@
 return ret
 if Axes.barh.__doc__ is not None:
 barh.__doc__ = dedent(Axes.barh.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1568,6 +1583,7 @@
 return ret
 if Axes.boxplot.__doc__ is not None:
 boxplot.__doc__ = dedent(Axes.boxplot.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1677,6 +1693,7 @@
 return ret
 if Axes.csd.__doc__ is not None:
 csd.__doc__ = dedent(Axes.csd.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1698,6 +1715,7 @@
 return ret
 if Axes.errorbar.__doc__ is not None:
 errorbar.__doc__ = dedent(Axes.errorbar.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1719,6 +1737,7 @@
 return ret
 if Axes.fill.__doc__ is not None:
 fill.__doc__ = dedent(Axes.fill.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1740,6 +1759,7 @@
 return ret
 if Axes.hist.__doc__ is not None:
 hist.__doc__ = dedent(Axes.hist.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1783,6 +1803,7 @@
 return ret
 if Axes.imshow.__doc__ is not None:
 imshow.__doc__ = dedent(Axes.imshow.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1804,6 +1825,7 @@
 return ret
 if Axes.loglog.__doc__ is not None:
 loglog.__doc__ = dedent(Axes.loglog.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1825,6 +1847,7 @@
 return ret
 if Axes.pcolor.__doc__ is not None:
 pcolor.__doc__ = dedent(Axes.pcolor.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1846,6 +1869,7 @@
 return ret
 if Axes.pcolormesh.__doc__ is not None:
 pcolormesh.__doc__ = dedent(Axes.pcolormesh.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1867,6 +1891,7 @@
 return ret
 if Axes.pie.__doc__ is not None:
 pie.__doc__ = dedent(Axes.pie.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1888,6 +1913,7 @@
 return ret
 if Axes.plot.__doc__ is not None:
 plot.__doc__ = dedent(Axes.plot.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1909,6 +1935,7 @@
 return ret
 if Axes.plot_date.__doc__ is not None:
 plot_date.__doc__ = dedent(Axes.plot_date.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1930,6 +1957,7 @@
 return ret
 if Axes.psd.__doc__ is not None:
 psd.__doc__ = dedent(Axes.psd.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1951,6 +1979,7 @@
 return ret
 if Axes.quiver.__doc__ is not None:
 quiver.__doc__ = dedent(Axes.quiver.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1972,6 +2001,7 @@
 return ret
 if Axes.quiverkey.__doc__ is not None:
 quiverkey.__doc__ = dedent(Axes.quiverkey.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -1993,6 +2023,7 @@
 return ret
 if Axes.scatter.__doc__ is not None:
 scatter.__doc__ = dedent(Axes.scatter.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -2014,6 +2045,7 @@
 return ret
 if Axes.hexbin.__doc__ is not None:
 hexbin.__doc__ = dedent(Axes.hexbin.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
 # This function was autogenerated by boilerplate.py. Do not edit as
@@ -2035,6 +2067,7 @@
 return ret
 if Axes.semilogx.__doc__ is not None:
 semilogx.__doc__ = dedent(Axes.semilogx.__doc__) + """
+
 Additional kwargs: hold = [True|False] overrides default hold state""...
 
[truncated message content]

Revision: 5350
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5350&view=rev
Author: dsdale
Date: 2008年06月01日 08:37:48 -0700 (2008年6月01日)
Log Message:
-----------
continued docstring conversion
Modified Paths:
--------------
 trunk/matplotlib/lib/matplotlib/axes.py
 trunk/matplotlib/lib/matplotlib/pyplot.py
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 13:15:36 UTC (rev 5349)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 15:37:48 UTC (rev 5350)
@@ -2995,27 +2995,24 @@
 
 def loglog(self, *args, **kwargs):
 """
- LOGLOG(*args, **kwargs)
+ call signature::
 
- Make a loglog plot with log scaling on the a and y axis. The args
- to semilog x are the same as the args to plot. See help plot for
- more info.
+ loglog(*args, **kwargs)
 
- Optional keyword args supported are any of the kwargs
- supported by plot or set_xscale or set_yscale. Notable, for
- log scaling:
+ Make a plot with log scaling on the a and y axis. The args to loglog
+ are the same as the args to ``plot``. See ``plot`` for more info.
 
- * basex: base of the x logarithm
+ loglog supports all the keyword arguments of ``plot`` and
+ Axes.set_xscale/Axes.set_yscale.
 
- * subsx: the location of the minor ticks; None defaults to
- autosubs, which depend on the number of decades in the
- plot; see set_xscale for details
+ Notable keyword arguments:
 
- * basey: base of the y logarithm
-
- * subsy: the location of the minor yticks; None defaults to
+ basex/basey: scalar > 1
+ base of the x/y logarithm
+ subsx/subsy: [ None | sequence ]
+ the location of the minor x/yticks; None defaults to
 autosubs, which depend on the number of decades in the
- plot; see set_yscale for details
+ plot; see set_xscale/set_yscale for details
 
 The remaining valid kwargs are Line2D properties:
 %(Line2D)s
@@ -3214,68 +3211,92 @@
 
 def legend(self, *args, **kwargs):
 """
- LEGEND(*args, **kwargs)
+ call signature::
 
+ legend(*args, **kwargs)
+
 Place a legend on the current axes at location loc. Labels are a
 sequence of strings and loc can be a string or an integer specifying
 the legend location
 
- USAGE:
+ To make a legend with existing lines::
 
- Make a legend with existing lines
+ legend()
 
- >>> legend()
+ legend by itself will try and build a legend using the label
+ property of the lines/patches/collections. You can set the label of
+ a line by doing plot(x, y, label='my data') or line.set_label('my
+ data'). If label is set to '_nolegend_', the item will not be shown
+ in legend.
 
- legend by itself will try and build a legend using the label
- property of the lines/patches/collections. You can set the label of
- a line by doing plot(x, y, label='my data') or line.set_label('my
- data'). If label is set to '_nolegend_', the item will not be shown
- in legend.
+ To automatically generate the legend from labels::
 
- # automatically generate the legend from labels
- legend( ('label1', 'label2', 'label3') )
+ legend( ('label1', 'label2', 'label3') )
 
- # Make a legend for a list of lines and labels
- legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
+ To make a legend for a list of lines and labels::
 
- # Make a legend at a given location, using a location argument
- # legend( LABELS, LOC ) or
- # legend( LINES, LABELS, LOC )
- legend( ('label1', 'label2', 'label3'), loc='upper left')
- legend( (line1, line2, line3), ('label1', 'label2', 'label3'), loc=2)
+ legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
 
+ To make a legend at a given location, using a location argument::
+
+ legend( ('label1', 'label2', 'label3'), loc='upper left')
+
+ or::
+
+ legend( (line1, line2, line3), ('label1', 'label2', 'label3'), loc=2)
+
 The location codes are
 
- 'best' : 0,
- 'upper right' : 1,
- 'upper left' : 2,
- 'lower left' : 3,
- 'lower right' : 4,
- 'right' : 5,
- 'center left' : 6,
- 'center right' : 7,
- 'lower center' : 8,
- 'upper center' : 9,
- 'center' : 10,
+ =============== =============
+ Location String Location Code
+ =============== =============
+ 'best' 0
+ 'upper right' 1
+ 'upper left' 2
+ 'lower left' 3
+ 'lower right' 4
+ 'right' 5
+ 'center left' 6
+ 'center right' 7
+ 'lower center' 8
+ 'upper center' 9
+ 'center' 10
+ =============== =============
 
- If none of these are suitable, loc can be a 2-tuple giving x,y
- in axes coords, ie,
+ If none of these are locations are suitable, loc can be a 2-tuple
+ giving x,y in axes coords, ie::
 
- loc = 0, 1 is left top
- loc = 0.5, 0.5 is center, center
+ loc = 0, 1 # left top
+ loc = 0.5, 0.5 # center
 
- and so on. The following kwargs are supported:
+ Keyword arguments:
 
- isaxes=True # whether this is an axes legend
- numpoints = 4 # the number of points in the legend line
- prop = FontProperties(size='smaller') # the font property
- pad = 0.2 # the fractional whitespace inside the legend border
- markerscale = 0.6 # the relative size of legend markers vs. original
- shadow # if True, draw a shadow behind legend
- labelsep = 0.005 # the vertical space between the legend entries
- handlelen = 0.05 # the length of the legend lines
- handletextsep = 0.02 # the space between the legend line and legend text
- axespad = 0.02 # the border between the axes and legend edge
+ isaxes: [ True | False ]
+ Indicates that this is an axes legend
+ numpoints: integer
+ The number of points in the legend line, default is 4
+ prop: [ None | FontProperties ]
+ A FontProperties instance, or None to use rc settings.
+ see :class:`~matplotlib.font_manager.FontProperties`
+ pad: [ None | scalar ]
+ The fractional whitespace inside the legend border, between 0 and 1.
+ If None, use rc settings
+ markerscale: [ None | scalar ]
+ The relative size of legend markers vs. original. If None, use rc
+ settings
+ shadow: [ None | False | True ]
+ If True, draw a shadow behind legend. If None, use rc settings.
+ labelsep: [ None | scalar ]
+ The vertical space between the legend entries. If None, use rc
+ settings
+ handlelen: [ None | scalar ]
+ The length of the legend lines. If None, use rc settings.
+ handletextsep: [ None | scalar ]
+ The space between the legend line and legend text. If None, use rc
+ settings.
+ axespad: [ None | scalar ]
+ The border between the axes and legend edge. If None, use rc
+ settings.
 """
 
 def get_handles():
@@ -4863,102 +4884,86 @@
 #### plotting z(x,y): imshow, pcolor and relatives, contour
 
 
- def imshow(self, X,
- cmap = None,
- norm = None,
- aspect=None,
- interpolation=None,
- alpha=1.0,
- vmin = None,
- vmax = None,
- origin=None,
- extent=None,
- shape=None,
- filternorm=1,
- filterrad=4.0,
- imlim=None,
- **kwargs):
+ def imshow(self, X, cmap=None, norm=None, aspect=None,
+ interpolation=None, alpha=1.0, vmin=None, vmax=None,
+ origin=None, extent=None, shape=None, filternorm=1,
+ filterrad=4.0, imlim=None, **kwargs):
 """
+ call signature::
 
- IMSHOW(X, cmap=None, norm=None, aspect=None, interpolation=None,
- alpha=1.0, vmin=None, vmax=None, origin=None, extent=None)
+ imshow(X, cmap=None, norm=None, aspect=None, interpolation=None,
+ alpha=1.0, vmin=None, vmax=None, origin=None, extent=None,
+ **kwargs)
 
- IMSHOW(X) - plot image X to current axes, resampling to scale to axes
- size (X may be numarray/Numeric array or PIL image)
-
- IMSHOW(X, **kwargs) - Use keyword args to control image scaling,
- colormapping etc. See below for details
-
-
 Display the image in X to current axes. X may be a float array, a
 uint8 array or a PIL image. If X is an array, X can have the following
 shapes:
 
- MxN : luminance (grayscale, float array only)
+ * MxN -- luminance (grayscale, float array only)
+ * MxNx3 -- RGB (float or uint8 array)
+ * MxNx4 -- RGBA (float or uint8 array)
 
- MxNx3 : RGB (float or uint8 array)
-
- MxNx4 : RGBA (float or uint8 array)
-
 The value for each component of MxNx3 and MxNx4 float arrays should be
 in the range 0.0 to 1.0; MxN float arrays may be normalised.
 
- A image.AxesImage instance is returned
+ An image.AxesImage instance is returned.
 
- The following kwargs are allowed:
+ Keyword arguments:
 
- * cmap is a cm colormap instance, eg cm.jet. If None, default to rc
- image.cmap value (Ignored when X has RGB(A) information)
+ cmap: [ None | Colormap ]
+ A cm colormap instance, eg cm.jet. If None, default to rc
+ image.cmap value
 
- * aspect is one of: auto, equal, or a number. If None, default to rc
- image.aspect value
+ cmap is ignored when X has RGB(A) information
+ aspect: [ None | 'auto' | 'equal' | scalar ]
+ If 'auto', changes the image aspect ratio to match that of the axes
 
- * interpolation is one of:
+ If 'equal', and extent is None, changes the axes aspect ratio to
+ match that of the image. If extent is not None, the axes aspect
+ ratio is changed to match that of the extent.
 
- 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36',
- 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric',
- 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc',
+ If None, default to rc image.aspect value.
+ interpolation:
+ Acceptable values are None, 'nearest', 'bilinear', 'bicubic',
+ 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser',
+ 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc',
 'lanczos', 'blackman'
 
- if interpolation is None, default to rc
- image.interpolation. See also th the filternorm and
- filterrad parameters
+ If interpolation is None, default to rc image.interpolation. See
+ also th the filternorm and filterrad parameters
+ norm: [ None | Normalize ]
+ An mcolors.Normalize instance; if None, default is normalization().
+ This scales luminance -> 0-1
 
- * norm is a mcolors.Normalize instance; default is
- normalization(). This scales luminance -> 0-1 (only used for an
- MxN float array).
+ norm is only used for an MxN float array.
+ vmin/vmax: [ None | scalar ]
+ Used to scale a luminance image to 0-1. If either is None, the min
+ and max of the luminance values will be used. Note if you pass a
+ norm instance, the settings for vmin and vmax will be ignored.
+ alpha: scalar
+ the alpha blending value, between 0 (transparent) and 1 (opaque)
+ origin: [ None | 'upper' | 'lower' ]
+ Place the [0,0] index of the array in the upper left or lower left
+ corner of the axes. If None, default to rc image.origin
+ extent: [ None | scalars (left, right, bottom, top) ]
+ data values of the axes. The default assigns zero-based row,
+ column indices to the x, y centers of the pixels.
+ shape: [ None | scalars (columns, rows) ]
+ for raw buffer images
+ filternorm:
+ A parameter for the antigrain image resize filter. From the
+ antigrain documentation, if normalize=1, the filter normalizes
+ integer values and corrects the rounding errors. It doesn't do
+ anything with the source floating point values, it corrects only
+ integers according to the rule of 1.0 which means that any sum of
+ pixel weights must be equal to 1.0. So, the filter function must
+ produce a graph of the proper shape.
+ filterrad:
+ the filter radius for filters that have a radius parameter, ie when
+ interpolation is one of: 'sinc', 'lanczos' or 'blackman'
 
- * vmin and vmax are used to scale a luminance image to 0-1. If
- either is None, the min and max of the luminance values will be
- used. Note if you pass a norm instance, the settings for vmin and
- vmax will be ignored.
-
- * alpha = 1.0 : the alpha blending value
-
- * origin is 'upper' or 'lower', to place the [0,0]
- index of the array in the upper left or lower left corner of
- the axes. If None, default to rc image.origin
-
- * extent is (left, right, bottom, top) data values of the
- axes. The default assigns zero-based row, column indices
- to the x, y centers of the pixels.
-
- * shape is for raw buffer images
-
- * filternorm is a parameter for the antigrain image resize
- filter. From the antigrain documentation, if normalize=1,
- the filter normalizes integer values and corrects the
- rounding errors. It doesn't do anything with the source
- floating point values, it corrects only integers according
- to the rule of 1.0 which means that any sum of pixel
- weights must be equal to 1.0. So, the filter function
- must produce a graph of the proper shape.
-
- * filterrad: the filter radius for filters that have a radius
- parameter, ie when interpolation is one of: 'sinc',
- 'lanczos' or 'blackman'
-
- Additional kwargs are martist properties
+ Additional kwargs are Artist properties:
+ %(Artist)s
 """
 
 if not self._hold: self.cla()
@@ -4992,6 +4997,7 @@
 self.images.append(im)
 
 return im
+ imshow.__doc__ = cbook.dedent(imshow.__doc__) % martist.kwdocd
 
 
 def _pcolorargs(self, funcname, *args):
@@ -6054,7 +6060,7 @@
 
 def matshow(self, Z, **kwargs):
 '''
- Plot a matrix as an image.
+ Plot a matrix or array as an image.
 
 The matrix will be shown the way it would be printed,
 with the first row at the top. Row and column numbering
Modified: trunk/matplotlib/lib/matplotlib/pyplot.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 13:15:36 UTC (rev 5349)
+++ trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 15:37:48 UTC (rev 5350)
@@ -1209,7 +1209,8 @@
 imread.__doc__ = dedent(_imread.__doc__)
 
 def matshow(A, fignum=None, **kw):
- """Display an array as a matrix in a new figure window.
+ """
+ Display an array as a matrix in a new figure window.
 
 The origin is set at the upper left hand corner and rows (first dimension
 of the array) are displayed horizontally. The aspect ratio of the figure
@@ -1218,12 +1219,12 @@
 
 Tick labels for the xaxis are placed on top.
 
- With one exception, keyword arguments are passed to
+ With the exception of fignum, keyword arguments are passed to
 imshow().
 
- Special keyword argument which is NOT passed to imshow():
 
- - fignum(None): by default, matshow() creates a new figure window with
+ fignum: [ None | integer | False ]
+ by default, matshow() creates a new figure window with
 automatic numbering. If fignum is given as an integer, the created
 figure will use this figure number. Because of how matshow() tries to
 set the figure aspect ratio to be the one of the array, if you provide
@@ -1231,19 +1232,6 @@
 
 if fignum is False or 0, a new figure window will NOT be created.
 
- Example usage:
-
- def samplemat(dims):
- aa = zeros(dims)
- for i in range(min(dims)):
- aa[i,i] = i
- return aa
-
- dimlist = [(12,12),(128,64),(64,512),(2048,256)]
-
- for d in dimlist:
- im = matshow(samplemat(d))
- show()
 """
 if fignum is False or fignum is 0:
 ax = gca()
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

Revision: 5349
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5349&view=rev
Author: dsdale
Date: 2008年06月01日 06:15:36 -0700 (2008年6月01日)
Log Message:
-----------
do not use column- or row-spanning cells in rest tables.
Such tables can not be converted to latex by sphinx.
Modified Paths:
--------------
 trunk/matplotlib/doc/api/pyplot_api.rst
 trunk/matplotlib/doc/devel/documenting_mpl.rst
 trunk/matplotlib/lib/matplotlib/axes.py
 trunk/matplotlib/lib/matplotlib/contour.py
 trunk/matplotlib/lib/matplotlib/lines.py
 trunk/matplotlib/lib/matplotlib/pyplot.py
Modified: trunk/matplotlib/doc/api/pyplot_api.rst
===================================================================
--- trunk/matplotlib/doc/api/pyplot_api.rst	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/doc/api/pyplot_api.rst	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -2,8 +2,9 @@
 matplotlib pyplot
 *****************
 
+
 :mod:`matplotlib.pyplot`
 =============================
 
 .. automodule:: matplotlib.pyplot
- :members: acorr
\ No newline at end of file
+ :members:
\ No newline at end of file
Modified: trunk/matplotlib/doc/devel/documenting_mpl.rst
===================================================================
--- trunk/matplotlib/doc/devel/documenting_mpl.rst	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/doc/devel/documenting_mpl.rst	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -30,6 +30,9 @@
 statement. For example, in the Developers Guide, index.rst lists
 coding_guide, which automatically inserts coding_guide.rst.
 
+Sphinx does not support tables with column- or row-spanning cells for
+latex output. Such tables can not be used when documenting matplotlib.
+
 Mathematical expressions can be rendered as png images in html, and in
 the usual way by latex. For example:
 
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -3888,7 +3888,7 @@
 call signature::
 
 errorbar(x, y, yerr=None, xerr=None,
- fmt='b-', ecolor=None, elinewidth=None, capsize=3,
+ fmt='-', ecolor=None, elinewidth=None, capsize=3,
 barsabove=False, lolims=False, uplims=False,
 xlolims=False, xuplims=False)
 
@@ -3901,39 +3901,31 @@
 
 Optional keyword arguments:
 
- +------------+------------------------------------------------------+
- | Keyword | Description |
- +============+======================================================+
- | xerr | a rank-0 or Nx1 Numpy array yields symmetric |
- | yerr | errorbars +/- value |
- | +------------------------------------------------------+
- | | an N-element list or tuple yields symmetric |
- | | errorbars +/- value |
- | +------------------------------------------------------+
- | | a rank-1, Nx2 Numpy array yields asymmetric |
- | | errorbars: -column1/+column2 |
- +------------+------------------------------------------------------+
- | fmt | the plot format symbol for y. If fmt is None, just |
- | | plot the errorbars with no line symbols. This can |
- | | be useful for creating a bar plot with errorbars |
- +------------+------------------------------------------------------+
- | ecolor | a matplotlib color arg which gives the color the |
- | | errorbar lines; if None, use the marker color. |
- +------------+------------------------------------------------------+
- | elinewidth | the linewidth of the errorbar lines. If None, use |
- | | the linewidth. |
- +------------+------------------------------------------------------+
- | capsize | the size of the error bar caps in points |
- +------------+------------------------------------------------------+
- | barsabove | if True, will plot the errorbars above the plot |
- | | symbols. Default is below. |
- +------------+------------------------------------------------------+
- | lolims | These arguments can be used to indicate that a value |
- | uplims | gives only upper/lower limits. In that case a caret |
- | xlolims | symbol is used to indicate this. lims-arguments may |
- | xuplims | be of the same type as xerr and yerr. |
- +------------+------------------------------------------------------+
+ xerr/yerr: [ scalar | N, Nx1, Nx2 array-like ]
+ If a scalar number, len(N) array-like object, or an Nx1 array-like
+ object, errorbars are drawn +/- value.
 
+ If a rank-1, Nx2 Numpy array, errorbars are drawn at -column1 and
+ +column2
+ fmt: '-'
+ The plot format symbol for y. If fmt is None, just plot the
+ errorbars with no line symbols. This can be useful for creating a
+ bar plot with errorbars.
+ ecolor: [ None | mpl color ]
+ a matplotlib color arg which gives the color the errorbar lines; if
+ None, use the marker color.
+ elinewidth: scalar
+ the linewidth of the errorbar lines. If None, use the linewidth.
+ capsize: scalar
+ the size of the error bar caps in points
+ barsabove: [ True | False ]
+ if True, will plot the errorbars above the plot symbols. Default is
+ below.
+ lolims/uplims/xlolims/xuplims: [ False | True ]
+ These arguments can be used to indicate that a value gives only
+ upper/lower limits. In that case a caret symbol is used to indicate
+ this. lims-arguments may be of the same type as xerr and yerr.
+
 All other keyword arguments are passed on to the plot command for the
 markers, so you can add additional key=value pairs to control the
 errorbar markers. For example, this code makes big red squares with
@@ -4594,73 +4586,61 @@
 
 Optional keyword arguments:
 
- +----------+---------------------------------------------------------+
- | Keyword | Description |
- +==========+=========================================================+
- | gridsize | The number of hexagons in the x-direction, default is |
- | | 100. The corresponding number of hexagons in the |
- | | y-direction is chosen such that the hexagons are |
- | | approximately regular. Alternatively, gridsize can be a |
- | | tuple with two elements specifying the number of |
- | | hexagons in the x-direction and the y-direction. |
- +----------+---------------------------------------------------------+
- | bins | If None, no binning is applied; the color of each |
- | | hexagon directly corresponds to its count value. |
- | +---------------------------------------------------------+
- | | If 'log', use a logarithmic scale for the color |
- | | map. Internally, log10(count+1) is used to determine |
- | | the hexagon color. |
- | +---------------------------------------------------------+
- | | If an integer, divide the counts in the specified |
- | | number of bins, and color the hexagons accordingly |
- | +---------------------------------------------------------+
- | | I a sequence of values, the values of the lower bound |
- | | of the bins to be used. |
- +----------+---------------------------------------------------------+
- | xscale | [ 'linear' | 'log' ] |
- | | Use a log10 scale on the horizontal axis. |
- +----------+---------------------------------------------------------+
- | yscale | [ 'linear' | 'log' ] |
- | | Use a log10 scale on the vertical axis. |
- +----------+---------------------------------------------------------+
+ gridsize: [ 100 | integer ]
+ The number of hexagons in the x-direction, default is 100. The
+ corresponding number of hexagons in the y-direction is chosen such
+ that the hexagons are approximately regular. Alternatively,
+ gridsize can be a tuple with two elements specifying the number of
+ hexagons in the x-direction and the y-direction.
+ bins: [ None | 'log' | integer | sequence ]
+ If None, no binning is applied; the color of each hexagon directly
+ corresponds to its count value.
 
+ If 'log', use a logarithmic scale for the color map. Internally,
+ log10(count+1) is used to determine the hexagon color.
+
+ If an integer, divide the counts in the specified number of bins,
+ and color the hexagons accordingly.
+
+ I a sequence of values, the values of the lower bound of the bins
+ to be used.
+ xscale: [ 'linear' | 'log' ]
+ Use a linear or log10 scale on the horizontal axis.
+ scale: [ 'linear' | 'log' ]
+ Use a linear or log10 scale on the vertical axis.
+
 Other keyword arguments controlling color mapping and normalization
 arguments:
 
- ========== ======================================================
- Keyword Description
- ========== ======================================================
- cmap a colors.Colormap instance from cm. defaults to rc
- image.cmap
- norm colors.Normalize instance is used to scale luminance
- data to 0,1.
- vmin/vmax vmin and vmax are used in conjunction with norm to
- normalize luminance data. If either are None, the
- min and max of the color array C is used. Note if you
- pass a norm instance, your settings for vmin and vmax
- will be ignored
- alpha the alpha value for the patches
- linewidths if None, defaults to (lines.linewidth,). Note
- that this is a tuple, and if you set the linewidths
- argument you must set it as a sequence of floats, as
- required by RegularPolyCollection -- see
- collections.RegularPolyCollection for details
- ========== ======================================================
+ cmap: [ None | Colormap ]
+ a colors.Colormap instance from cm. If None, defaults to rc
+ image.cmap.
+ norm: [ None | Normalize ]
+ colors.Normalize instance is used to scale luminance data to 0,1.
+ vmin/vmax: scalar
+ vmin and vmax are used in conjunction with norm to normalize
+ luminance data. If either are None, the min and max of the color
+ array C is used. Note if you pass a norm instance, your settings
+ for vmin and vmax will be ignored.
+ alpha: scalar
+ the alpha value for the patches
+ linewidths: [ None | scalar ]
+ If None, defaults to rc lines.linewidth. Note that this is a tuple,
+ and if you set the linewidths argument you must set it as a
+ sequence of floats, as required by RegularPolyCollection -- see
+ collections.RegularPolyCollection for details.
 
 Other keyword arguments controlling the Collection properties:
 
- ========== ======================================================
- Keyword Description
- ========== ======================================================
- edgecolors if 'none', draws the edges in the same color as the
- fill color. This is the default, as it avoids
- unsightly unpainted pixels between the hexagons.
+ edgecolors: [ None | mpl color | color sequence ]
+ If 'none', draws the edges in the same color as the fill color.
+ This is the default, as it avoids unsightly unpainted pixels
+ between the hexagons.
 
- if None, draws the outlines in the default color.
+ If None, draws the outlines in the default color.
 
- if a matplotlib color arg or sequence of rgba tuples,
- draws the outlines in the specified color.
- ========== ======================================================
+ If a matplotlib color arg or sequence of rgba tuples, draws the
+ outlines in the specified color.
 
 Here are the standard descriptions of all the Collection kwargs:
 %(Collection)s
Modified: trunk/matplotlib/lib/matplotlib/contour.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/contour.py	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/lib/matplotlib/contour.py	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -32,40 +32,37 @@
 """
 call signature::
 
- clabel(CS, **kwargs)
+ clabel(cs, **kwargs)
 
- adds labels to line contours in CS, where CS is a ContourSet object
+ adds labels to line contours in cs, where cs is a ContourSet object
 returned by contour.
 
- call signature::
+ ::
 
- clabel(CS, V, **kwargs)
+ clabel(cs, v, **kwargs)
 
- only labels contours listed in V
+ only labels contours listed in v
 
 Optional keyword arguments:
 
- +----------+--------------------------------------------------------+
- | Keyword | Description |
- +==========+========================================================+
- | fontsize | See http://matplotlib.sf.net/fonts.html |
- +----------+--------------------------------------------------------+
- | | a tuple of matplotlib color args (string, float, rgb, |
- | | etc). Different labels will be plotted in different |
- | | colors in the order specified |
- | +--------------------------------------------------------+
- | colors | one string color, e.g. colors = 'r' or colors = 'red' |
- | | all labels will be plotted in this color |
- | +--------------------------------------------------------+
- | | None, the color of each label matches the color |
- | | of the corresponding contour |
- +----------+--------------------------------------------------------+
- | inline | controls whether the underlying contour is removed |
- | | (inline = True) or not (False). Default is True |
- +----------+--------------------------------------------------------+
- | fmt | a format string for the label. Default is '%1.3f' |
- +----------+--------------------------------------------------------+
+ fontsize:
+ See http://matplotlib.sf.net/fonts.html
+ colors:
+ if None, the color of each label matches the color of the
+ corresponding contour
 
+ if one string color, e.g. colors = 'r' or colors = 'red' all labels
+ will be plotted in this color
+
+ if a tuple of matplotlib color args (string, float, rgb, etc),
+ different labels will be plotted in different colors in the order
+ specified
+ inline:
+ controls whether the underlying contour is removed
+ (inline = True) or not (False). Default is True
+ fmt:
+ a format string for the label. Default is '%1.3f'
+
 """
 fontsize = kwargs.get('fontsize', None)
 inline = kwargs.get('inline', 1)
@@ -384,11 +381,15 @@
 User-callable method: clabel
 
 Useful attributes:
- ax - the axes object in which the contours are drawn
- collections - a silent_list of LineCollections or PolyCollections
- levels - contour levels
- layers - same as levels for line contours; half-way between
- levels for filled contours. See _process_colors method.
+ ax:
+ the axes object in which the contours are drawn
+ collections:
+ a silent_list of LineCollections or PolyCollections
+ levels:
+ contour levels
+ layers:
+ same as levels for line contours; half-way between
+ levels for filled contours. See _process_colors method.
 """
 
 
@@ -801,108 +802,71 @@
 
 Optional keyword arguments:
 
- +---------+-----------+----------------------------------------------+
- | Keyword | Default | Description |
- +=========+===========+==============================================+
- | colors | None | a tuple of matplotlib color args (string, |
- | | | float, rgb, etc), different levels will be |
- | | | plotted in different colors in the order |
- | | | specified |
- | | +----------------------------------------------+
- | | | one string color, e.g.: |
- | | | |
- | | | >>> colors = 'r' |
- | | | |
- | | | all levels will be plotted in this color |
- | | +----------------------------------------------+
- | | | if colors is None, the colormap specified by |
- | | | cmap will be used |
- +---------+-----------+----------------------------------------------+
- | alpha | 1.0 | the alpha blending value |
- +---------+-----------+----------------------------------------------+
- | cmap | None | a cm Colormap instance from matplotlib.cm. |
- | | | if cmap is None and colors is None, a |
- | | | default Colormap is used. |
- +---------+-----------+----------------------------------------------+
- | norm | None | a matplotlib.colors.Normalize instance for |
- | | | scaling data values to colors. If norm is |
- | | | None and colors is None, the default linear |
- | | | scaling is used. |
- +---------+-----------+----------------------------------------------+
- | origin | None | [ 'upper' | 'lower' | 'image' | None ] |
- | | | If 'image', the rc value for image.origin |
- | | | will be used. If None, the first value of Z |
- | | | will correspond to the lower left corner, |
- | | | location (0,0). |
- | | | |
- | | | This keyword is not active if X and Y are |
- | | | specified in the call to contour. |
- +---------+-----------+----------------------------------------------+
- | extent | None | (x0,x1,y0,y1) If origin is not None, then |
- | | | extent is interpreted as in imshow: it gives |
- | | | the outer pixel boundaries. In this case, |
- | | | the position of Z[0,0] is the center of the |
- | | | pixel, not a corner. If origin is None, then |
- | | | (x0,y0) is the position of Z[0,0], and |
- | | | (x1,y1) is the position of Z[-1,-1]. |
- | | | |
- | | | This keyword is not active if X and Y are |
- | | | specified in the call to contour. |
- +---------+-----------+----------------------------------------------+
- | locator | None | an instance of a ticker.Locator subclass. |
- | | | If locator is None, the default MaxNLocator |
- | | | is used. The locator is used to determine |
- | | | the contour levels if they are not given |
- | | | explicitly via the V argument. |
- +---------+-----------+----------------------------------------------+
- | extend | 'neither' | ['neither' | 'both' | 'min' | 'max' ] |
- | | | Unless this is 'neither', contour levels are |
- | | | automatically added to one or both ends of |
- | | | the range so that all data are included. |
- | | | These added ranges are then mapped to the |
- | | | special colormap values which default to the |
- | | | ends of the colormap range, but can be set |
- | | | via Colormap.set_under() and |
- | | | Colormap.set_over() methods. |
- +---------+-----------+----------------------------------------------+
+ colors: [ None | string | (mpl_colors) ]
+ If None, the colormap specified by cmap will be used.
 
- contour only keyword arguments:
+ If a string like 'r' or 'red', all levels will be plotted in this
+ color.
 
- +------------+---------+---------------------------------------------+
- | Keyword | Default | Description |
- +============+=========+=============================================+
- | linewidths | None | a number: all levels will be plotted with |
- | | | this linewidth, e.g.: |
- | | | |
- | | | >>> linewidths = 0.6 |
- | | | |
- | | +---------------------------------------------+
- | | | a tuple of numbers, e.g.: |
- | | | |
- | | | >>> linewidths = (0.4, 0.8, 1.2) |
- | | | |
- | | | different levels will be plotted with |
- | | | different linewidths in the order specified |
- | | +---------------------------------------------+
- | | | if linewidths is None, the default width in |
- | | | lines.linewidth in matplotlibrc is used |
- +------------+---------+---------------------------------------------+
+ If a tuple of matplotlib color args (string, float, rgb, etc),
+ different levels will be plotted in different colors in the order
+ specified.
+ alpha: float
+ The alpha blending value
+ cmap: [ None | Colormap ]
+ A cm Colormap instance from matplotlib.cm or None. If cmap is None
+ and colors is None, a default Colormap is used.
+ norm: [ None | Normalize ]
+ A matplotlib.colors.Normalize instance for scaling data values to
+ colors. If norm is None and colors is None, the default linear
+ scaling is used.
+ origin: [ None | 'upper' | 'lower' | 'image' ]
+ If None, the first value of Z will correspond to the lower left
+ corner, location (0,0). If 'image', the rc value for image.origin
+ will be used.
 
+ This keyword is not active if X and Y are specified in the call to
+ contour.
+ extent: [ None | (x0,x1,y0,y1) ]
+ If origin is not None, then extent is interpreted as in imshow: it
+ gives the outer pixel boundaries. In this case, the position of
+ Z[0,0] is the center of the pixel, not a corner. If origin is None,
+ then (x0,y0) is the position of Z[0,0], and (x1,y1) is the position
+ of Z[-1,-1].
+
+ This keyword is not active if X and Y are specified in the call to
+ contour.
+ locator: [ None | ticker.Locator subclass ]
+ If locator is None, the default MaxNLocator is used. The locator is
+ used to determine the contour levels if they are not given
+ explicitly via the V argument.
+ extend: [ 'neither' | 'both' | 'min' | 'max' ]
+ Unless this is 'neither', contour levels are automatically added to
+ one or both ends of the range so that all data are included. These
+ added ranges are then mapped to the special colormap values which
+ default to the ends of the colormap range, but can be set via
+ Colormap.set_under() and Colormap.set_over() methods.
+
 contour only keyword arguments:
 
- +-------------+---------+--------------------------------------------+
- | Keyword | Default | Description |
- +=============+=========+============================================+
- | antialiased | True | [ True | False ] |
- +-------------+---------+--------------------------------------------+
- | nchunk | 0 | 0 for no subdivision of the domain |
- | | | specify a positive integer to divide the |
- | | | domain into subdomains of roughly nchunk |
- | | | by nchunk points. This may never actually |
- | | | be advantageous, so this option may be |
- | | | removed. Chunking introduces artifacts at |
- | | | the chunk boundaries unless antialiased |
- | | | is False |
- +-------------+---------+--------------------------------------------+
+ linewidths: [ None | number | tuple of numbers ]
+ if linewidths is None, the default width in lines.linewidth in
+ matplotlibrc is used
 
+ If a number, all levels will be plotted with this linewidth.
+
+ If a tuple, different levels will be plotted with different
+ linewidths in the order specified
+
+ contourf only keyword arguments:
+
+ antialiased: [ True | False ]
+ enable antialiasing
+ nchunk: [ 0 | integer ]
+ If 0, no subdivision of the domain. Specify a positive integer to
+ divide the domain into subdomains of roughly nchunk by nchunk
+ points. This may never actually be advantageous, so this option may
+ be removed. Chunking introduces artifacts at the chunk boundaries
+ unless antialiased is False.
+
 """
Modified: trunk/matplotlib/lib/matplotlib/lines.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/lines.py	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/lib/matplotlib/lines.py	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -214,7 +214,7 @@
 linestyle or ls: [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]
 linewidth or lw: float value in points
 lod: [True | False]
- marker: [ '+' | ',' | '.' | '1' | '2' | '3' | '4'
+ marker: [ '+' | ',' | '.' | '1' | '2' | '3' | '4' ]
 markeredgecolor or mec: any matplotlib color
 markeredgewidth or mew: float value in points (default 5)
 markerfacecolor or mfc: any matplotlib color
Modified: trunk/matplotlib/lib/matplotlib/pyplot.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 11:07:42 UTC (rev 5348)
+++ trunk/matplotlib/lib/matplotlib/pyplot.py	2008年06月01日 13:15:36 UTC (rev 5349)
@@ -631,41 +631,49 @@
 """
 Set/Get the axis properties:
 
- +--------------------+-----------------------------------------------------+
- | Use | Description |
- +====================+=====================================================+
- | >>> axis() | returns the current axes limits |
- | | [xmin, xmax, ymin, ymax] |
- +--------------------+-----------------------------------------------------+
- | >>> axis(v) | sets the min and max of the x and y axes |
- | | v = [xmin, xmax, ymin, ymax] |
- +--------------------+-----------------------------------------------------+
- | >>> axis('off') | turns off the axis lines and labels |
- +--------------------+-----------------------------------------------------+
- | >>> axis('equal') | changes limits of x or y axis so that equal |
- | | increments of x and y have the same length; |
- | | a circle is circular. |
- +--------------------+-----------------------------------------------------+
- | >>> axis('scaled') | achieves the same result by changing the |
- | | dimensions of the plot box instead of the axis data |
- | | limits. |
- +--------------------+-----------------------------------------------------+
- | >>> axis('tight') | changes x and y axis limits such that all data is |
- | | shown. If all data is already shown, it will move |
- | | it to the center of the figure without modifying |
- | | (xmax-xmin) or (ymax-ymin). Note this is slightly |
- | | different than in matlab. |
- +--------------------+-----------------------------------------------------+
- | >>> axis('image') | is 'scaled' with the axis limits equal to the |
- | | data limits. |
- +--------------------+-----------------------------------------------------+
- | >>> axis('auto') | (deprecated) restores default behavior; axis |
- | >>> axis('normal') | limits are automatically scaled to make the data |
- | | fit comfortably within the plot box. |
- +--------------------+-----------------------------------------------------+
+ >>> axis()
 
+ returns the current axes limits ``[xmin, xmax, ymin, ymax]``.
 
+ >>> axis(v)
 
+ sets the min and max of the x and y axes, with
+ ``v = [xmin, xmax, ymin, ymax]``.
+
+ >>> axis('off')
+
+ turns off the axis lines and labels.
+
+ >>> axis('equal')
+
+ changes limits of x or y axis so that equal increments of x and y have the
+ same length; a circle is circular.
+
+ >>> axis('scaled')
+
+ achieves the same result by changing the dimensions of the plot box instead
+ of the axis data limits.
+
+ >>> axis('tight')
+
+ changes x and y axis limits such that all data is shown. If all data is
+ already shown, it will move it to the center of the figure without
+ modifying (xmax-xmin) or (ymax-ymin). Note this is slightly different than
+ in matlab.
+
+ >>> axis('image')
+
+ is 'scaled' with the axis limits equal to the data limits.
+
+ >>> axis('auto')
+
+ and
+
+ >>> axis('normal')
+
+ are deprecated. They restore default behavior; axis limits are automatically
+ scaled to make the data fit comfortably within the plot box.
+
 if ``len(*v)==0``, you can pass in xmin, xmax, ymin, ymax as kwargs
 selectively to alter just those limits w/o changing the others.
 See help(xlim) and help(ylim) for more information
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

Revision: 5348
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5348&view=rev
Author: dsdale
Date: 2008年06月01日 04:07:42 -0700 (2008年6月01日)
Log Message:
-----------
mask a section on STIX fonts in mathtext.rst which is causing
latex document compilation problems.
Modified Paths:
--------------
 trunk/matplotlib/doc/users/mathtext.rst
Modified: trunk/matplotlib/doc/users/mathtext.rst
===================================================================
--- trunk/matplotlib/doc/users/mathtext.rst	2008年06月01日 11:03:32 UTC (rev 5347)
+++ trunk/matplotlib/doc/users/mathtext.rst	2008年06月01日 11:07:42 UTC (rev 5348)
@@ -156,17 +156,17 @@
 ``\mathcal`` :math:`\mathcal{CALLIGRAPHY}`
 =============== =================================
 
-When using the STIX fonts, you also have the choice of:
+.. When using the STIX fonts, you also have the choice of:
+..
+.. ================ =================================
+.. Command Result
+.. ================ =================================
+.. ``\mathbb`` :math:`\mathbb{Blackboard}`
+.. ``\mathcircled`` :math:`\mathcircled{Circled}`
+.. ``\mathfrak`` :math:`\mathfrak{Fraktur}`
+.. ``\mathsf`` :math:`\mathsf{sans-serif}`
+.. ================ =================================
 
- ================ =================================
- Command Result
- ================ =================================
- ``\mathbb`` :math:`\mathbb{Blackboard}`
- ``\mathcircled`` :math:`\mathcircled{Circled}`
- ``\mathfrak`` :math:`\mathfrak{Fraktur}`
- ``\mathsf`` :math:`\mathsf{sans-serif}`
- ================ =================================
-
 Accents
 -------
 
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

Revision: 5347
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5347&view=rev
Author: dsdale
Date: 2008年06月01日 04:03:32 -0700 (2008年6月01日)
Log Message:
-----------
continued docstring work
Modified Paths:
--------------
 trunk/matplotlib/doc/api/pyplot_api.rst
Modified: trunk/matplotlib/doc/api/pyplot_api.rst
===================================================================
--- trunk/matplotlib/doc/api/pyplot_api.rst	2008年06月01日 00:41:54 UTC (rev 5346)
+++ trunk/matplotlib/doc/api/pyplot_api.rst	2008年06月01日 11:03:32 UTC (rev 5347)
@@ -6,4 +6,4 @@
 =============================
 
 .. automodule:: matplotlib.pyplot
- :members:
\ No newline at end of file
+ :members: acorr
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

Revision: 5346
 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5346&view=rev
Author: dsdale
Date: 2008年05月31日 17:41:54 -0700 (2008年5月31日)
Log Message:
-----------
work on converting docstrings to restructured text
Modified Paths:
--------------
 trunk/matplotlib/doc/api/index.rst
 trunk/matplotlib/lib/matplotlib/artist.py
 trunk/matplotlib/lib/matplotlib/axes.py
 trunk/matplotlib/lib/matplotlib/backend_bases.py
 trunk/matplotlib/lib/matplotlib/colorbar.py
 trunk/matplotlib/lib/matplotlib/contour.py
 trunk/matplotlib/lib/matplotlib/figure.py
 trunk/matplotlib/lib/matplotlib/patches.py
 trunk/matplotlib/lib/matplotlib/pyplot.py
Added Paths:
-----------
 trunk/matplotlib/doc/api/pyplot_api.rst
Modified: trunk/matplotlib/doc/api/index.rst
===================================================================
--- trunk/matplotlib/doc/api/index.rst	2008年05月31日 14:30:09 UTC (rev 5345)
+++ trunk/matplotlib/doc/api/index.rst	2008年06月01日 00:41:54 UTC (rev 5346)
@@ -12,4 +12,5 @@
 .. toctree::
 
 artist_api.rst
+ pyplot_api.rst
 
Added: trunk/matplotlib/doc/api/pyplot_api.rst
===================================================================
--- trunk/matplotlib/doc/api/pyplot_api.rst	 (rev 0)
+++ trunk/matplotlib/doc/api/pyplot_api.rst	2008年06月01日 00:41:54 UTC (rev 5346)
@@ -0,0 +1,9 @@
+*****************
+matplotlib pyplot
+*****************
+
+:mod:`matplotlib.pyplot`
+=============================
+
+.. automodule:: matplotlib.pyplot
+ :members:
\ No newline at end of file
Modified: trunk/matplotlib/lib/matplotlib/artist.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/artist.py	2008年05月31日 14:30:09 UTC (rev 5345)
+++ trunk/matplotlib/lib/matplotlib/artist.py	2008年06月01日 00:41:54 UTC (rev 5346)
@@ -617,6 +617,28 @@
 attrs.sort()
 lines = []
 
+ ########
+ names = [self.aliased_name(prop) for prop in attrs]
+ accepts = [self.get_valid_values(prop) for prop in attrs]
+
+ col0_len = max([len(n) for n in names])
+ col1_len = max([len(a) for a in accepts])
+ table_formatstr = pad + '='*col0_len + ' ' + '='*col1_len
+
+ lines.append('')
+ lines.append(table_formatstr)
+ lines.append(pad + 'Property'.ljust(col0_len+3) + \
+ 'Description'.ljust(col1_len))
+ lines.append(table_formatstr)
+
+ lines.extend([pad + n.ljust(col0_len+3) + a.ljust(col1_len)
+ for n, a in zip(names, accepts)])
+
+ lines.append(table_formatstr)
+ lines.append('')
+ return lines
+ ########
+
 for prop in attrs:
 accepts = self.get_valid_values(prop)
 name = self.aliased_name(prop)
@@ -757,7 +779,7 @@
 return [x for x in flatten(ret)]
 
 def kwdoc(a):
- return '\n'.join(ArtistInspector(a).pprint_setters(leadingspace=4))
+ return '\n'.join(ArtistInspector(a).pprint_setters(leadingspace=2))
 
 kwdocd = dict()
 kwdocd['Artist'] = kwdoc(Artist)
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008年05月31日 14:30:09 UTC (rev 5345)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008年06月01日 00:41:54 UTC (rev 5346)
@@ -70,11 +70,11 @@
 """
 Process a matlab(TM) style color/line style format string. Return a
 linestyle, color tuple as a result of the processing. Default
- values are ('-', 'b'). Example format strings include
+ values are ('-', 'b'). Example format strings include:
 
- 'ko' : black circles
- '.b' : blue dots
- 'r--' : red dashed lines
+ * 'ko': black circles
+ * '.b': blue dots
+ * 'r--': red dashed lines
 
 See Line2D.lineStyles and GraphicsContext.colors for all possible
 styles and color format string.
@@ -151,7 +151,7 @@
 """
 
 Process variable length arguments to the plot command, so that
- plot commands like the following are supported
+ plot commands like the following are supported::
 
 plot(t, s)
 plot(t1, s1, t2, s2)
@@ -462,38 +462,45 @@
 **kwargs
 ):
 """
- Build an Axes instance in Figure with
- rect=[left, bottom, width,height in Figure coords
+ Build an Axes instance in Figure fig with
+ rect=[left, bottom, width, height] in Figure coords
 
- adjustable: ['box' | 'datalim']
- alpha: the alpha transparency
- anchor: ['C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W']
- aspect: ['auto' | 'equal' | aspect_ratio]
- autoscale_on: boolean - whether or not to autoscale the viewlim
- axis_bgcolor: any matplotlib color - see help(colors)
- axisbelow: draw the grids and ticks below the other artists
- cursor_props: a (float, color) tuple
- figure: a Figure instance
- frame_on: a boolean - draw the axes frame
- label: the axes label
- navigate: True|False
- navigate_mode: the navigation toolbar button status: 'PAN', 'ZOOM', or None
- position: [left, bottom, width,height in Figure coords
- sharex: an Axes instance to share the x-axis with
- sharey: an Axes instance to share the y-axis with
- title: the title string
- visible: a boolean - whether the axes is visible
- xlabel: the xlabel
- xlim: (xmin, xmax) view limits
- xscale: [%(scale)s]
- xticklabels: sequence of strings
- xticks: sequence of floats
- ylabel: the ylabel strings
- ylim: (ymin, ymax) view limits
- yscale: [%(scale)s]
- yticklabels: sequence of strings
- yticks: sequence of floats
+ Optional keyword arguments:
 
+ ============== ====================================================
+ Keyword Description
+ ============== ====================================================
+ adjustable [ 'box' | 'datalim' ]
+ alpha float: the alpha transparency
+ anchor [ 'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W' ]
+ aspect [ 'auto' | 'equal' | aspect_ratio ]
+ autoscale_on [ True | False ] whether or not to autoscale the
+ viewlim
+ axis_bgcolor any matplotlib color - see help(colors)
+ axisbelow draw the grids and ticks below the other artists
+ cursor_props a (float, color) tuple
+ figure a Figure instance
+ frame_on a boolean - draw the axes frame
+ label the axes label
+ navigate [ True | False ]
+ navigate_mode [ 'PAN' | 'ZOOM' | None ] the navigation toolbar
+ button status
+ position [left, bottom, width, height] in Figure coords
+ sharex an Axes instance to share the x-axis with
+ sharey an Axes instance to share the y-axis with
+ title the title string
+ visible [ True | False ] whether the axes is visible
+ xlabel the xlabel
+ xlim (xmin, xmax) view limits
+ xscale [%(scale)s]
+ xticklabels sequence of strings
+ xticks sequence of floats
+ ylabel the ylabel strings
+ ylim (ymin, ymax) view limits
+ yscale [%(scale)s]
+ yticklabels sequence of strings
+ yticks sequence of floats
+ ============== ====================================================
 """ % {'scale': ' | '.join([repr(x) for x in mscale.get_scale_names()])}
 martist.Artist.__init__(self)
 if isinstance(rect, mtransforms.Bbox):
@@ -561,7 +568,7 @@
 """
 Set the Axes figure
 
- ACCEPTS: a Figure instance
+ accepts a Figure instance
 """
 martist.Artist.set_figure(self, fig)
 
@@ -618,7 +625,7 @@
 will add the given amount of padding (in points) between the
 axes and the label. The x-direction is in data coordinates
 and the y-direction is in axis coordinates. Returns a 3-tuple
- of the form:
+ of the form::
 
 (transform, valign, halign)
 
@@ -639,7 +646,7 @@
 labels, which will add the given amount of padding (in points)
 between the axes and the label. The x-direction is in data
 coordinates and the y-direction is in axis coordinates.
- Returns a 3-tuple of the form:
+ Returns a 3-tuple of the form::
 
 (transform, valign, halign)
 
@@ -672,7 +679,7 @@
 will add the given amount of padding (in points) between the
 axes and the label. The x-direction is in axis coordinates
 and the y-direction is in data coordinates. Returns a 3-tuple
- of the form:
+ of the form::
 
 (transform, valign, halign)
 
@@ -693,7 +700,7 @@
 labels, which will add the given amount of padding (in points)
 between the axes and the label. The x-direction is in axis
 coordinates and the y-direction is in data coordinates.
- Returns a 3-tuple of the form:
+ Returns a 3-tuple of the form::
 
 (transform, valign, halign)
 
@@ -733,11 +740,19 @@
 used, but which may be modified by apply_aspect, and a second
 which is the starting point for apply_aspect.
 
- which = 'active' to change the first;
- 'original' to change the second;
- 'both' to change both
+ Required arguments:
+ pos:
+ len(4) sequence of floats, or a Bbox object
 
- ACCEPTS: len(4) sequence of floats, or a Bbox object
+ Optional keyword arguments:
+ which:
+
+ ========== ====================
+ 'active' to change the first
+ 'original' to change the second
+ 'both' to change both
+ ========== ====================
+
 """
 if not isinstance(pos, mtransforms.BboxBase):
 pos = mtransforms.Bbox.from_bounds(*pos)
@@ -864,17 +879,23 @@
 
 def hold(self, b=None):
 """
- HOLD(b=None)
+ call signature::
 
+ hold(b=None)
+
 Set the hold state. If hold is None (default), toggle the
 hold state. Else set the hold state to boolean value b.
 
- Eg
- hold() # toggle hold
- hold(True) # hold is on
- hold(False) # hold is off
+ Examples:
 
+ * toggle hold:
+ >>> hold()
+ * turn hold on:
+ >>> hold(True)
+ * turn hold off
+ >>> hold(False)
 
+
 When hold is True, subsequent plot commands will be added to
 the current axes. When hold is False, the current axes and
 figure will be cleared on the next plot command
@@ -891,25 +912,33 @@
 def set_aspect(self, aspect, adjustable=None, anchor=None):
 """
 aspect:
- 'auto' - automatic; fill position rectangle with data
- 'normal' - same as 'auto'; deprecated
- 'equal' - same scaling from data to plot units for x and y
- num - a circle will be stretched such that the height
- is num times the width. aspect=1 is the same as
- aspect='equal'.
 
+ ======== ================================================
+ 'auto' automatic; fill position rectangle with data
+ 'normal' same as 'auto'; deprecated
+ 'equal' same scaling from data to plot units for x and y
+ num a circle will be stretched such that the height
+ is num times the width. aspect=1 is the same as
+ aspect='equal'.
+ ======== ================================================
+
 adjustable:
- 'box' - change physical size of axes
- 'datalim' - change xlim or ylim
 
+ ======== ============================
+ 'box' change physical size of axes
+ 'datalim' change xlim or ylim
+ ======== ============================
+
 anchor:
- 'C' - centered
- 'SW' - lower left corner
- 'S' - middle of bottom edge
- 'SE' - lower right corner
- etc.
 
- ACCEPTS: ['auto' | 'equal' | aspect_ratio]
+ ==== =====================
+ 'C' centered
+ 'SW' lower left corner
+ 'S' middle of bottom edge
+ 'SE' lower right corner
+ etc.
+ ==== =====================
+
 """
 if aspect in ('normal', 'auto'):
 self._aspect = 'auto'
@@ -940,7 +969,20 @@
 
 def set_anchor(self, anchor):
 """
- ACCEPTS: ['C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W']
+ anchor:
+
+ ==== ============
+ 'C' Center
+ 'SW' bottom left
+ 'S' bottom
+ 'SE' bottom right
+ 'E' right
+ 'NE' top right
+ 'N' top
+ 'NW' top left
+ 'W' left
+ ==== ============
+
 """
 if anchor in mtransforms.Bbox.coefs.keys() or len(anchor) == 2:
 self._anchor = anchor
@@ -1325,7 +1367,7 @@
 """
 Set whether autoscaling is applied on plot commands
 
- ACCEPTS: True|False
+ accepts: True|False
 """
 self._autoscaleon = b
 
@@ -1518,14 +1560,17 @@
 
 def grid(self, b=None, **kwargs):
 """
- GRID(self, b=None, **kwargs)
+ call signature::
+
+ grid(self, b=None, **kwargs)
+
 Set the axes grids on or off; b is a boolean
 
 if b is None and len(kwargs)==0, toggle the grid state. if
 kwargs are supplied, it is assumed that you want a grid and b
 is thus set to True
 
- kawrgs are used to set the grid line properties, eg
+ kawrgs are used to set the grid line properties, eg::
 
 ax.grid(color='r', linestyle='-', linewidth=2)
 
@@ -1542,11 +1587,16 @@
 Convenience method for manipulating the ScalarFormatter
 used by default for linear axes.
 
- kwargs:
- style = 'sci' (or 'scientific') or 'plain';
- plain turns off scientific notation
- axis = 'x', 'y', or 'both'
+ Optional keyword arguments:
 
+ ======= =====================================
+ Keyword Description
+ ======= =====================================
+ style [ 'sci' (or 'scientific') | 'plain' ]
+ plain turns off scientific notation
+ axis [ 'x' | 'y' | 'both' ]
+ ======= =====================================
+
 Only the major ticks are affected.
 If the method is called when the ScalarFormatter is not
 the one being used, an AttributeError will be raised with
@@ -1577,19 +1627,11 @@
 self.yaxis.major.formatter.set_scientific(sb)
 
 def set_axis_off(self):
- """
- turn off the axis
-
- ACCEPTS: void
- """
+ """turn off the axis"""
 self.axison = False
 
 def set_axis_on(self):
- """
- turn on the axis
-
- ACCEPTS: void
- """
+ """turn on the axis"""
 self.axison = True
 
 def get_axis_bgcolor(self):
@@ -1619,7 +1661,12 @@
 return right < left
 
 def get_xbound(self):
- "Returns the x-axis numerical bounds in the form of lowerBound < upperBound"
+ """
+ Returns the x-axis numerical bounds where::
+
+ lowerBound < upperBound
+
+ """
 left, right = self.get_xlim()
 if left < right:
 return left, right
@@ -1627,9 +1674,10 @@
 return right, left
 
 def set_xbound(self, lower=None, upper=None):
- """Set the lower and upper numerical bounds of the x-axis.
- This method will honor axes inversion regardless of parameter order.
 """
+ Set the lower and upper numerical bounds of the x-axis.
+ This method will honor axes inversion regardless of parameter order.
+ """
 if upper is None and iterable(lower):
 lower,upper = lower
 
@@ -1657,24 +1705,31 @@
 
 def set_xlim(self, xmin=None, xmax=None, emit=True, **kwargs):
 """
- set_xlim(self, *args, **kwargs):
+ call signature::
 
- Set the limits for the xaxis; v = [xmin, xmax]
+ set_xlim(self, *args, **kwargs)
 
- set_xlim((valmin, valmax))
- set_xlim(valmin, valmax)
- set_xlim(xmin=1) # xmax unchanged
- set_xlim(xmax=1) # xmin unchanged
+ Set the limits for the xaxis
 
- Valid kwargs:
+ Returns the current xlimits as a length 2 tuple: [xmin, xmax]
 
- xmin : the min of the xlim
- xmax : the max of the xlim
- emit : notify observers of lim change
+ Examples::
 
+ set_xlim((valmin, valmax))
+ set_xlim(valmin, valmax)
+ set_xlim(xmin=1) # xmax unchanged
+ set_xlim(xmax=1) # xmin unchanged
 
- Returns the current xlimits as a length 2 tuple
+ Valid keyword arguments:
 
+ ======= ==============================
+ Keyword Description
+ ======= ==============================
+ xmin the min of the xlim
+ xmax the max of the xlim
+ emit notify observers of lim change
+ ======= ==============================
+
 ACCEPTS: len(2) sequence of floats
 """
 if xmax is None and iterable(xmin):
@@ -1714,8 +1769,10 @@
 
 def set_xscale(self, value, **kwargs):
 """
- SET_XSCALE(value)
+ call signature::
 
+ set_xscale(value)
+
 Set the scaling of the x-axis: %(scale)s
 
 ACCEPTS: [%(scale)s]
@@ -2460,8 +2517,10 @@
 
 def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
 """
- AXHLINE(y=0, xmin=0, xmax=1, **kwargs)
+ call signature::
 
+ axhline(y=0, xmin=0, xmax=1, **kwargs)
+
 Axis Horizontal Line
 
 Draw a horizontal line at y from xmin to xmax. With the default
@@ -2474,16 +2533,19 @@
 Return value is the Line2D instance. kwargs are the same as kwargs to
 plot, and can be used to control the line properties. Eg
 
- # draw a thick red hline at y=0 that spans the xrange
- axhline(linewidth=4, color='r')
+ * draw a thick red hline at y=0 that spans the xrange
 
- # draw a default hline at y=1 that spans the xrange
- axhline(y=1)
+ >>> axhline(linewidth=4, color='r')
 
- # draw a default hline at y=.5 that spans the the middle half of
- # the xrange
- axhline(y=.5, xmin=0.25, xmax=0.75)
+ * draw a default hline at y=1 that spans the xrange
 
+ >>> axhline(y=1)
+
+ * draw a default hline at y=.5 that spans the the middle half of
+ the xrange
+
+ >>> axhline(y=.5, xmin=0.25, xmax=0.75)
+
 Valid kwargs are Line2D properties
 %(Line2D)s
 """
@@ -2502,8 +2564,10 @@
 
 def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
 """
- AXVLINE(x=0, ymin=0, ymax=1, **kwargs)
+ call signature::
 
+ axvline(x=0, ymin=0, ymax=1, **kwargs)
+
 Axis Vertical Line
 
 Draw a vertical line at x from ymin to ymax. With the default values
@@ -2516,16 +2580,19 @@
 Return value is the Line2D instance. kwargs are the same as
 kwargs to plot, and can be used to control the line properties. Eg
 
- # draw a thick red vline at x=0 that spans the yrange
- l = axvline(linewidth=4, color='r')
+ * draw a thick red vline at x=0 that spans the yrange
 
- # draw a default vline at x=1 that spans the yrange
- l = axvline(x=1)
+ >>> axvline(linewidth=4, color='r')
 
- # draw a default vline at x=.5 that spans the the middle half of
- # the yrange
- axvline(x=.5, ymin=0.25, ymax=0.75)
+ * draw a default vline at x=1 that spans the yrange
 
+ >>> axvline(x=1)
+
+ * draw a default vline at x=.5 that spans the the middle half of
+ the yrange
+
+ >>> axvline(x=.5, ymin=0.25, ymax=0.75)
+
 Valid kwargs are Line2D properties
 %(Line2D)s
 """
@@ -2544,8 +2611,10 @@
 
 def axhspan(self, ymin, ymax, xmin=0, xmax=1, **kwargs):
 """
- AXHSPAN(ymin, ymax, xmin=0, xmax=1, **kwargs)
+ call signature::
 
+ axhspan(ymin, ymax, xmin=0, xmax=1, **kwargs)
+
 Axis Horizontal Span. ycoords are in data units and x
 coords are in axes (relative 0-1) units
 
@@ -2556,21 +2625,15 @@
 0=left, 0.5=middle, 1.0=right but the y location is in data
 coordinates.
 
- kwargs are the kwargs to Patch, eg
+ Return value is the patches.Polygon instance.
 
- antialiased, aa
- linewidth, lw
- edgecolor, ec
- facecolor, fc
+ Examples:
 
- the terms on the right are aliases
+ * draw a gray rectangle from y=0.25-0.75 that spans the horizontal
+ extent of the axes
 
- Return value is the patches.Polygon instance.
+ >>> axhspan(0.25, 0.75, facecolor='0.5', alpha=0.5)
 
- #draws a gray rectangle from y=0.25-0.75 that spans the horizontal
- #extent of the axes
- axhspan(0.25, 0.75, facecolor='0.5', alpha=0.5)
-
 Valid kwargs are Polygon properties
 %(Polygon)s
 """
@@ -2586,9 +2649,11 @@
 
 def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
 """
- AXVSPAN(xmin, xmax, ymin=0, ymax=1, **kwargs)
+ call signature::
 
- axvspan : Axis Vertical Span. xcoords are in data units and y coords
+ axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)
+
+ Axis Vertical Span. xcoords are in data units and y coords
 are in axes (relative 0-1) units
 
 Draw a vertical span (regtangle) from xmin to xmax. With the default
@@ -2597,22 +2662,16 @@
 command. That is, the vertical extent is in axes coords: 0=bottom,
 0.5=middle, 1.0=top but the y location is in data coordinates.
 
- kwargs are the kwargs to Patch, eg
+ return value is the patches.Polygon instance.
 
- antialiased, aa
- linewidth, lw
- edgecolor, ec
- facecolor, fc
+ Examples:
 
- the terms on the right are aliases
+ * draw a vertical green translucent rectangle from x=1.25 to 1.55 that
+ spans the yrange of the axes
 
- return value is the patches.Polygon instance.
+ >>> axvspan(1.25, 1.55, facecolor='g', alpha=0.5)
 
- # draw a vertical green translucent rectangle from x=1.25 to 1.55 that
- # spans the yrange of the axes
- axvspan(1.25, 1.55, facecolor='g', alpha=0.5)
-
- Valid kwargs are Polygon properties
+ Valid kwargs are Polygon properties:
 %(Polygon)s
 """
 # convert x axis units
@@ -2629,19 +2688,33 @@
 def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
 label='', **kwargs):
 """
- HLINES(y, xmin, xmax, colors='k', linestyle='solid', **kwargs)
+ call signature::
 
- plot horizontal lines at each y from xmin to xmax. xmin or xmax can
- be scalars or len(x) numpy arrays. If they are scalars, then the
- respective values are constant, else the widths of the lines are
- determined by xmin and xmax
+ hlines(y, xmin, xmax, colors='k', linestyle='solid', **kwargs)
 
- colors is a line collections color args, either a single color
- or a len(x) list of colors
+ plot horizontal lines at each y from xmin to xmax.
 
- linestyle is one of solid|dashed|dashdot|dotted
+ Returns the LineCollection that was added
 
- Returns the LineCollection that was added
+ Required arguments:
+
+ y:
+ a 1-D numpy array or iterable.
+
+ xmin and xmax:
+ can be scalars or len(x) numpy arrays. If they are scalars, then
+ the respective values are constant, else the widths of the lines
+ are determined by xmin and xmax
+
+ Optional keyword arguments:
+
+ colors:
+ a line collections color argument, either a single color
+ or a len(y) list of colors
+
+ linestyle:
+ [ 'solid' | 'dashed' | 'dashdot' | 'dotted' ]
+
 """
 if kwargs.get('fmt') is not None:
 raise DeprecationWarning(
@@ -3290,13 +3363,15 @@
 **kwargs
 ):
 """
- BAR(left, height, width=0.8, bottom=0,
- color=None, edgecolor=None, linewidth=None,
- yerr=None, xerr=None, ecolor=None, capsize=3,
- align='edge', orientation='vertical', log=False)
+ call signature::
 
- Make a bar plot with rectangles bounded by
+ bar(left, height, width=0.8, bottom=0,
+ color=None, edgecolor=None, linewidth=None,
+ yerr=None, xerr=None, ecolor=None, capsize=3,
+ align='edge', orientation='vertical', log=False)
 
+ Make a bar plot with rectangles bounded by:
+
 left, left+width, bottom, bottom+height
 (left, right, bottom and top edges)
 
@@ -3304,38 +3379,37 @@
 
 Return value is a list of Rectangle patch instances
 
- left - the x coordinates of the left sides of the bars
+ Required arguments:
 
- height - the heights of the bars
+ ======== ===============================================
+ Argument Description
+ ======== ===============================================
+ left the x coordinates of the left sides of the bars
+ height the heights of the bars
+ ======== ===============================================
 
- Optional arguments:
+ Optional keyword arguments:
 
- width - the widths of the bars
+ ============= ===================================================
+ Keyword Description
+ ============= ===================================================
+ width the widths of the bars
+ bottom the y coordinates of the bottom edges of the bars
+ color the colors of the bars
+ edgecolor the colors of the bar edges
+ linewidth width of bar edges; None means use default
+ linewidth; 0 means don't draw edges.
+ xerr and yerr if not None, will be used to generate errorbars
+ on the bar chart
+ ecolor specifies the color of any errorbar
+ capsize (default 3) determines the length in points of the
+ error bar caps
+ align 'edge' (default) | 'center'
+ orientation 'vertical' | 'horizontal'
+ log [False|True] False (default) leaves the orientation
+ axis as-is; True sets it to log scale
+ ============= ===================================================
 
- bottom - the y coordinates of the bottom edges of the bars
-
- color - the colors of the bars
-
- edgecolor - the colors of the bar edges
-
- linewidth - width of bar edges; None means use default
- linewidth; 0 means don't draw edges.
-
- xerr and yerr, if not None, will be used to generate errorbars
- on the bar chart
-
- ecolor specifies the color of any errorbar
-
- capsize (default 3) determines the length in points of the error
- bar caps
-
- align = 'edge' (default) | 'center'
-
- orientation = 'vertical' | 'horizontal'
-
- log = False | True - False (default) leaves the orientation
- axis as-is; True sets it to log scale
-
 For vertical bars, align='edge' aligns bars by their left edges in
 left, while 'center' interprets these values as the x coordinates of
 the bar centers. For horizontal bars, 'edge' aligns bars by their
@@ -3347,7 +3421,7 @@
 This enables you to use bar as the basis for stacked bar charts, or
 candlestick plots.
 
- Optional kwargs:
+ Other optional kwargs:
 %(Rectangle)s
 """
 if not self._hold: self.cla()
@@ -3536,10 +3610,12 @@
 
 def barh(self, bottom, width, height=0.8, left=None, **kwargs):
 """
- BARH(bottom, width, height=0.8, left=0, **kwargs)
+ call signature::
 
- Make a horizontal bar plot with rectangles bounded by
+ barh(bottom, width, height=0.8, left=0, **kwargs)
 
+ Make a horizontal bar plot with rectangles bounded by:
+
 left, left+width, bottom, bottom+height
 (left, right, bottom and top edges)
 
@@ -3547,36 +3623,36 @@
 
 Return value is a list of Rectangle patch instances
 
- bottom - the vertical positions of the bottom edges of the bars
+ Required arguments:
 
- width - the lengths of the bars
+ ======== ======================================================
+ Argument Description
+ ======== ======================================================
+ bottom the vertical positions of the bottom edges of the bars
+ width the lengths of the bars
+ ======== ======================================================
 
- Optional arguments:
+ Optional keyword arguments:
 
- height - the heights (thicknesses) of the bars
+ ============= ===================================================
+ Keyword Description
+ ============= ===================================================
+ height the heights (thicknesses) of the bars
+ left the x coordinates of the left edges of the bars
+ color the colors of the bars
+ edgecolor the colors of the bar edges
+ linewidth width of bar edges; None means use default
+ linewidth; 0 means don't draw edges.
+ xerr and yerr if not None, will be used to generate errorbars
+ on the bar chart
+ ecolor specifies the color of any errorbar
+ capsize (default 3) determines the length in points of the
+ error bar caps
+ align 'edge' (default) | 'center'
+ log [False|True] False (default) leaves the horizontal
+ axis as-is; True sets it to log scale
+ ============= ===================================================
 
- left - the x coordinates of the left edges of the bars
-
- color - the colors of the bars
-
- edgecolor - the colors of the bar edges
-
- linewidth - width of bar edges; None means use default
- linewidth; 0 means don't draw edges.
-
- xerr and yerr, if not None, will be used to generate errorbars
- on the bar chart
-
- ecolor specifies the color of any errorbar
-
- capsize (default 3) determines the length in points of the error
- bar caps
-
- align = 'edge' (default) | 'center'
-
- log = False | True - False (default) leaves the horizontal
- axis as-is; True sets it to log scale
-
 Setting align='edge' aligns bars by their bottom edges in bottom,
 while 'center' interprets these values as the y coordinates of the bar
 centers.
@@ -3586,7 +3662,7 @@
 This enables you to use barh as the basis for stacked bar charts, or
 candlestick plots.
 
- Optional kwargs:
+ other optional kwargs:
 %(Rectangle)s
 """
 
@@ -3598,19 +3674,33 @@
 
 def broken_barh(self, xranges, yrange, **kwargs):
 """
+ call signature::
+
+ broken_barh(self, xranges, yrange, **kwargs)
+
 A collection of horizontal bars spanning yrange with a sequence of
 xranges
 
- xranges : sequence of (xmin, xwidth)
- yrange : (ymin, ywidth)
+ Required arguments:
 
- kwargs are collections.BrokenBarHCollection properties
+ ======== ==========================
+ Argument Description
+ ======== ==========================
+ xranges sequence of (xmin, xwidth)
+ yrange sequence of (ymin, ywidth)
+ ======== ==========================
+
+ kwargs are collections.BrokenBarHCollection properties:
 %(BrokenBarHCollection)s
 
- these can either be a single argument, ie facecolors='black'
- or a sequence of arguments for the various bars, ie
- facecolors='black', 'red', 'green'
+ these can either be a single argument, ie::
 
+ facecolors = 'black'
+
+ or a sequence of arguments for the various bars, ie::
+
+ facecolors = 'black', 'red', 'green'
+
 """
 col = mcoll.BrokenBarHCollection(xranges, yrange, **kwargs)
 self.add_collection(col, autolim=True)
@@ -3795,59 +3885,67 @@
 barsabove=False, lolims=False, uplims=False,
 xlolims=False, xuplims=False, **kwargs):
 """
- ERRORBAR(x, y, yerr=None, xerr=None,
- fmt='b-', ecolor=None, elinewidth=None, capsize=3,
- barsabove=False, lolims=False, uplims=False,
- xlolims=False, xuplims=False)
+ call signature::
 
+ errorbar(x, y, yerr=None, xerr=None,
+ fmt='b-', ecolor=None, elinewidth=None, capsize=3,
+ barsabove=False, lolims=False, uplims=False,
+ xlolims=False, xuplims=False)
+
 Plot x versus y with error deltas in yerr and xerr.
- Vertical errorbars are plotted if yerr is not None
- Horizontal errorbars are plotted if xerr is not None
+ Vertical errorbars are plotted if yerr is not None.
+ Horizontal errorbars are plotted if xerr is not None.
 
- xerr and yerr may be any of:
+ x, y, xerr, and yerr can all be scalars, which plots a single error bar
+ at x, y.
 
- a rank-0, Nx1 Numpy array - symmetric errorbars +/- value
+ Optional keyword arguments:
 
- an N-element list or tuple - symmetric errorbars +/- value
+ +------------+------------------------------------------------------+
+ | Keyword | Description |
+ +============+======================================================+
+ | xerr | a rank-0 or Nx1 Numpy array yields symmetric |
+ | yerr | errorbars +/- value |
+ | +------------------------------------------------------+
+ | | an N-element list or tuple yields symmetric |
+ | | errorbars +/- value |
+ | +------------------------------------------------------+
+ | | a rank-1, Nx2 Numpy array yields asymmetric |
+ | | errorbars: -column1/+column2 |
+ +------------+------------------------------------------------------+
+ | fmt | the plot format symbol for y. If fmt is None, just |
+ | | plot the errorbars with no line symbols. This can |
+ | | be useful for creating a bar plot with errorbars |
+ +------------+------------------------------------------------------+
+ | ecolor | a matplotlib color arg which gives the color the |
+ | | errorbar lines; if None, use the marker color. |
+ +------------+------------------------------------------------------+
+ | elinewidth | the linewidth of the errorbar lines. If None, use |
+ | | the linewidth. |
+ +------------+------------------------------------------------------+
+ | capsize | the size of the error bar caps in points |
+ +------------+------------------------------------------------------+
+ | barsabove | if True, will plot the errorbars above the plot |
+ | | symbols. Default is below. |
+ +------------+------------------------------------------------------+
+ | lolims | These arguments can be used to indicate that a value |
+ | uplims | gives only upper/lower limits. In that case a caret |
+ | xlolims | symbol is used to indicate this. lims-arguments may |
+ | xuplims | be of the same type as xerr and yerr. |
+ +------------+------------------------------------------------------+
 
- a rank-1, Nx2 Numpy array - asymmetric errorbars -column1/+column2
+ All other keyword arguments are passed on to the plot command for the
+ markers, so you can add additional key=value pairs to control the
+ errorbar markers. For example, this code makes big red squares with
+ thick green edges::
 
- Alternatively, x, y, xerr, and yerr can all be scalars, which
- plots a single error bar at x, y.
+ x,y,yerr = rand(3,10)
+ errorbar(x, y, yerr, marker='s',
+ mfc='red', mec='green', ms=20, mew=4)
 
- fmt is the plot format symbol for y. if fmt is None, just
- plot the errorbars with no line symbols. This can be useful
- for creating a bar plot with errorbars
+ where mfc, mec, ms and mew are aliases for the longer property names,
+ markerfacecolor, markeredgecolor, markersize and markeredgewith.
 
- ecolor is a matplotlib color arg which gives the color the
- errorbar lines; if None, use the marker color.
-
- elinewidth is the linewidth of the errorbar lines;
- if None, use the linewidth.
-
- capsize is the size of the error bar caps in points
-
- barsabove, if True, will plot the errorbars above the plot symbols
- - default is below
-
- lolims, uplims, xlolims, xuplims: These arguments can be used
- to indicate that a value gives only upper/lower limits. In
- that case a caret symbol is used to indicate this. lims-arguments
- may be of the same type as xerr and yerr.
-
- kwargs are passed on to the plot command for the markers.
- So you can add additional key=value pairs to control the
- errorbar markers. For example, this code makes big red
- squares with thick green edges
-
- >>> x,y,yerr = rand(3,10)
- >>> errorbar(x, y, yerr, marker='s',
- mfc='red', mec='green', ms=20, mew=4)
-
- mfc, mec, ms and mew are aliases for the longer property
- names, markerfacecolor, markeredgecolor, markersize and
- markeredgewith.
-
 valid kwargs for the marker properties are
 %(Line2D)s
 
@@ -4018,9 +4116,11 @@
 def boxplot(self, x, notch=0, sym='b+', vert=1, whis=1.5,
 positions=None, widths=None):
 """
- boxplot(x, notch=0, sym='+', vert=1, whis=1.5,
- positions=None, widths=None)
+ call signature::
 
+ boxplot(x, notch=0, sym='+', vert=1, whis=1.5,
+ positions=None, widths=None)
+
 Make a box and whisker plot for each column of x or
 each vector in sequence x.
 The box extends from the lower to upper quartile values
@@ -4028,27 +4128,27 @@
 extend from the box to show the range of the data. Flier
 points are those past the end of the whiskers.
 
- notch = 0 (default) produces a rectangular box plot.
- notch = 1 will produce a notched box plot
+ ``notch = 0`` (default) produces a rectangular box plot.
+ ``notch = 1`` will produce a notched box plot
 
 sym (default 'b+') is the default symbol for flier points.
 Enter an empty string ('') if you don't want to show fliers.
 
- vert = 1 (default) makes the boxes vertical.
- vert = 0 makes horizontal boxes. This seems goofy, but
+ ``vert = 1`` (default) makes the boxes vertical.
+ ``vert = 0`` makes horizontal boxes. This seems goofy, but
 that's how Matlab did it.
 
 whis (default 1.5) defines the length of the whiskers as
 a function of the inner quartile range. They extend to the
- most extreme data point within ( whis*(75%-25%) ) data range.
+ most extreme data point within ( ``whis*(75%-25%)`` ) data range.
 
 positions (default 1,2,...,n) sets the horizontal positions of
 the boxes. The ticks and limits are automatically set to match
 the positions.
 
 widths is either a scalar or a vector and sets the width of
- each box. The default is 0.5, or 0.15*(distance between extreme
- positions) if that is smaller.
+ each box. The default is 0.5, or ``0.15*(distance between extreme
+ positions)`` if that is smaller.
 
 x is an array or a sequence of vectors.
 
@@ -4478,77 +4578,91 @@
 alpha=1.0, linewidths=None, edgecolors='none',
 **kwargs):
 """
- HEXBIN(x, y, gridsize = 100, bins = None,
- xscale = 'linear', yscale = 'linear',
- cmap=None, norm=None, vmin=None, vmax=None,
- alpha=1.0, linewidths=None, edgecolors='none'
- **kwargs)
+ call signature::
 
+ hexbin(x, y, gridsize = 100, bins = None,
+ xscale = 'linear', yscale = 'linear',
+ cmap=None, norm=None, vmin=None, vmax=None,
+ alpha=1.0, linewidths=None, edgecolors='none'
+ **kwargs)
+
 Make a hexagonal binning plot of x versus y, where x, y are 1-D
 sequences of the same length, N.
 
- Either or both of x and y may be masked arrays, in which case all
- masks will be combined and only unmasked points will be plotted.
+ x and/or y may be masked arrays, in which case only unmasked points will
+ be plotted.
 
- * gridsize=100 : The number of hexagons in the x-direction. The
- corresponding number of hexagons in the
- y-direction is chosen such that the hexagons are
- approximately regular.
- Alternatively, gridsize can be a tuple with two
- elements specifying the number of hexagons in
- the x-direction and the y-direction.
+ Optional keyword arguments:
 
- * bins=None : If None, no binning is applied; the color of
- each hexagon directly corresponds to its count
- value.
- bins='log' : Use a logarithmic scale for the color map.
- Internally, log10(count+1) is used to determine
- the hexagon color.
- bins=<integer> : Divide the counts in the specified number of
- bins, and color the hexagons accordingly
- bins=<a sequence of values> :
- The values of the lower bound of the bins
- to be used.
+ +----------+---------------------------------------------------------+
+ | Keyword | Description |
+ +==========+=========================================================+
+ | gridsize | The number of hexagons in the x-direction, default is |
+ | | 100. The corresponding number of hexagons in the |
+ | | y-direction is chosen such that the hexagons are |
+ | | approximately regular. Alternatively, gridsize can be a |
+ | | tuple with two elements specifying the number of |
+ | | hexagons in the x-direction and the y-direction. |
+ +----------+---------------------------------------------------------+
+ | bins | If None, no binning is applied; the color of each |
+ | | hexagon directly corresponds to its count value. |
+ | +---------------------------------------------------------+
+ | | If 'log', use a logarithmic scale for the color |
+ | | map. Internally, log10(count+1) is used to determine |
+ | | the hexagon color. |
+ | +---------------------------------------------------------+
+ | | If an integer, divide the counts in the specified |
+ | | number of bins, and color the hexagons accordingly |
+ | +---------------------------------------------------------+
+ | | I a sequence of values, the values of the lower bound |
+ | | of the bins to be used. |
+ +----------+---------------------------------------------------------+
+ | xscale | [ 'linear' | 'log' ] |
+ | | Use a log10 scale on the horizontal axis. |
+ +----------+---------------------------------------------------------+
+ | yscale | [ 'linear' | 'log' ] |
+ | | Use a log10 scale on the vertical axis. |
+ +----------+---------------------------------------------------------+
 
- * xscale = 'linear' | 'log':
- Use a log10 scale on the horizontal axis.
+ Other keyword arguments controlling color mapping and normalization
+ arguments:
 
- * yscale = 'linear' | 'log':
- Use a log10 scale on the vertical axis.
+ ========== ======================================================
+ Keyword Description
+ ========== ======================================================
+ cmap a colors.Colormap instance from cm. defaults to rc
+ image.cmap
+ norm colors.Normalize instance is used to scale luminance
+ data to 0,1.
+ vmin/vmax vmin and vmax are used in conjunction with norm to
+ normalize luminance data. If either are None, the
+ min and max of the color array C is used. Note if you
+ pass a norm instance, your settings for vmin and vmax
+ will be ignored
+ alpha the alpha value for the patches
+ linewidths if None, defaults to (lines.linewidth,). Note
+ that this is a tuple, and if you set the linewidths
+ argument you must set it as a sequence of floats, as
+ required by RegularPolyCollection -- see
+ collections.RegularPolyCollection for details
+ ========== ======================================================
 
- Other keyword args; the color mapping and normalization arguments.
+ Other keyword arguments controlling the Collection properties:
 
- * cmap = cm.jet : a colors.Colormap instance from cm.
- defaults to rc image.cmap
+ ========== ======================================================
+ Keyword Description
+ ========== ======================================================
+ edgecolors if 'none', draws the edges in the same color as the
+ fill color. This is the default, as it avoids
+ unsightly unpainted pixels between the hexagons.
 
- * norm = colors.Normalize() : colors.Normalize instance
- is used to scale luminance data to 0,1.
+ if None, draws the outlines in the default color.
 
- * vmin=None and vmax=None : vmin and vmax are used in conjunction
- with norm to normalize luminance data. If either are None, the
- min and max of the color array C is used. Note if you pass a norm
- instance, your settings for vmin and vmax will be ignored
+ if a matplotlib color arg or sequence of rgba tuples,
+ draws the outlines in the specified color.
+ ========== ======================================================
 
- * alpha =1.0 : the alpha value for the patches
-
- * linewidths, if None, defaults to (lines.linewidth,). Note
- that this is a tuple, and if you set the linewidths
- argument you must set it as a sequence of floats, as
- required by RegularPolyCollection -- see
- collections.RegularPolyCollection for details
-
- Optional kwargs control the Collection properties; in
- particular:
-
- edgecolors='none' : Draw the edges in the same color
- as the fill color. This is the default, as
- it avoids unsightly unpainted pixels
- between the hexagons.
- edgecolors=None : Draw the outlines in the default color.
- edgecolors=<a matplotlib color arg or sequence of rgba tuples>
- : Draw the outlines in the specified color.
-
- Here are the standard descriptions of all the Collection kwargs:
+ Here are the standard descriptions of all the Collection kwargs:
 %(Collection)s
 
 The return value is a PolyCollection instance; use get_array() on
@@ -4726,26 +4840,28 @@
 
 def fill(self, *args, **kwargs):
 """
- FILL(*args, **kwargs)
+ call signature::
 
- plot filled polygons. *args is a variable length argument, allowing
+ fill(*args, **kwargs)
+
+ plot filled polygons. ``*args`` is a variable length argument, allowing
 for multiple x,y pairs with an optional color format string; see plot
- for details on the argument parsing. For example, all of the
- following are legal, assuming ax is an Axes instance:
+ for details on the argument parsing. For example, to plot a polygon
+ with vertices at x,y in blue.::
 
- ax.fill(x,y) # plot polygon with vertices at x,y
- ax.fill(x,y, 'b' ) # plot polygon with vertices at x,y in blue
+ ax.fill(x,y, 'b' )
 
- An arbitrary number of x, y, color groups can be specified, as in
+ An arbitrary number of x, y, color groups can be specified::
+
 ax.fill(x1, y1, 'g', x2, y2, 'r')
 
- Return value is a list of patches that were added
+ Return value is a list of patches that were added.
 
 The same color strings that plot supports are supported by the fill
 format string.
 
 If you would like to fill below a curve, eg shade a region
- between 0 and y along x, use mlab.poly_between, eg
+ between 0 and y along x, use mlab.poly_between, eg::
 
 xs, ys = poly_between(x, 0, y)
 axes.fill(xs, ys, facecolor='red', alpha=0.5)
@@ -5387,9 +5503,6 @@
 self.autoscale_view(tight=True)
 return ret
 
-
-
-
 def contour(self, *args, **kwargs):
 kwargs['filled'] = False
 return mcontour.ContourSet(self, *args, **kwargs)
@@ -5404,7 +5517,6 @@
 return CS.clabel(*args, **kwargs)
 clabel.__doc__ = mcontour.ContourSet.clabel.__doc__
 
-
 def table(self, **kwargs):
 """
 TABLE(cellText=None, cellColours=None,
@@ -5467,54 +5579,66 @@
 bottom=None, histtype='bar', align='edge',
 orientation='vertical', rwidth=None, log=False, **kwargs):
 """
- HIST(x, bins=10, normed=False, cumulative=False,
- bottom=None, histtype='bar', align='edge',
- orientation='vertical', rwidth=None, log=False, **kwargs)
+ call signature::
 
- Compute the histogram of x. bins is either an integer number of
- bins or a sequence giving the bins. x are the data to be binned.
- x can be an array or a 2D array with multiple data in its columns.
+ hist(x, bins=10, normed=False, cumulative=False,
+ bottom=None, histtype='bar', align='edge',
+ orientation='vertical', rwidth=None, log=False, **kwargs)
 
- The return values is (n, bins, patches) or
- ([n0,n1,...], bins, [patches0,patches1,...]) if the input
- contains multiple data.
+ Compute the histogram of x. The return value is (n, bins, patches) or
+ ([n0,n1,...], bins, [patches0,patches1,...]) if the input contains
+ multiple data.
 
- If normed is true, the first element of the return tuple will
- be the counts normalized to form a probability density, ie,
- n/(len(x)*dbin). In a probability density, the integral of
- the histogram should be one; you can verify that with
+ Keyword arguments:
 
- # trapezoidal integration of the probability density function
- pdf, bins, patches = ax.hist(...)
- print np.sum(pdf * np.diff(bins))
+ bins:
+ either an integer number of bins or a sequence giving the
+ bins. x are the data to be binned. x can be an array or a 2D
+ array with multiple data in its columns.
 
- If cumulative is True then a histogram is computed where each bin
- gives the counts in that bin plus all bins for smaller values.
- The last bin gives the total number of datapoints. If normed is
- also True then the histogram is normalized such that the last bin
- equals one.
+ normed:
+ if True, the first element of the return tuple will
+ be the counts normalized to form a probability density, ie,
+ n/(len(x)*dbin). In a probability density, the integral of
+ the histogram should be one; you can verify that with a
+ trapezoidal integration of the probability density function::
 
- histtype = 'bar' | 'barstacked' | 'step'. The type of histogram
- to draw. 'bar' is a traditional bar-type histogram, 'barstacked'
- is a bar-type histogram where multiple data are stacked on top
- of each other, and 'step' generates a lineplot.
+ pdf, bins, patches = ax.hist(...)
+ print np.sum(pdf * np.diff(bins))
 
- align controles how the histogram is plotted
- - 'edge' : bars are centered between the bin edges
- - 'center': bars are centered on the left bin edges
+ cumulative:
+ if True then a histogram is computed where each bin
+ gives the counts in that bin plus all bins for smaller values.
+ The last bin gives the total number of datapoints. If normed is
+ also True then the histogram is normalized such that the last bin
+ equals one.
 
- orientation = 'horizontal' | 'vertical'. If horizontal, barh
- will be used and the "bottom" kwarg will be the left edges.
+ histtype:
+ [ 'bar' | 'barstacked' | 'step' ] The type of histogram
+ to draw. 'bar' is a traditional bar-type histogram,
+ 'barstacked' is a bar-type histogram where multiple data are
+ stacked on top of each other, and 'step' generates a lineplot.
 
- rwidth: the relative width of the bars as fraction of the bin
- width. If None, automatically compute the width. Ignored
- for 'step' histtype.
+ align:
+ ['edge' | 'center' ] Controles how the histogram is plotted.
+ If 'edge, bars are centered between the bin edges.
+ If 'center', bars are centered on the left bin edges
 
- log: if True, the histogram axis will be set to a log scale.
- If log is true and x is a 1D array, empty bins will be
- filtered out and only the non-empty n, bins, patches will be
- returned.
+ orientation:
+ [ 'horizontal' | 'vertical' ] If horizontal, barh will be used
+ and the "bottom" kwarg will be the left edges.
 
+ rwidth:
+ the relative width of the bars as fraction of the bin
+ width. If None, automatically compute the width. Ignored
+ for 'step' histtype.
+
+ log:
+ if True, the histogram axis will be set to a log scale.
+ If log is true and x is a 1D array, empty bins will be
+ filtered out and only the non-empty n, bins, patches will be
+ returned.
+
 kwargs are used to update the properties of the
 hist Rectangles:
 %(Rectangle)s
@@ -5714,9 +5838,11 @@
 def csd(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
 window=mlab.window_hanning, noverlap=0, **kwargs):
 """
- CSD(x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
- window=window_hanning, noverlap=0, **kwargs)
+ call signature::
 
+ csd(x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
+ window=window_hanning, noverlap=0, **kwargs)
+
 The cross spectral density Pxy by Welches average periodogram method.
 The vectors x and y are divided into NFFT length segments. Each
 segment is detrended by function detrend and windowed by function
@@ -5727,11 +5853,11 @@
 See the PSD help for a description of the optional parameters.
 
 Returns the tuple Pxy, freqs. Pxy is the cross spectrum (complex
- valued), and 10*np.log10(|Pxy|) is plotted
+ valued), and ``10*np.log10(|Pxy|)`` is plotted
 
- Refs:
+ References:
 Bendat & Piersol -- Random Data: Analysis and Measurement
- Procedures, John Wiley & Sons (1986)
+ Procedures, John Wiley & Sons (1986)
 
 kwargs control the Line2D properties:
 %(Line2D)s
@@ -5760,14 +5886,18 @@
 def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
 window=mlab.window_hanning, noverlap=0, **kwargs):
 """
- COHERE(x, y, NFFT=256, Fs=2, Fc=0, detrend = mlab.detrend_none,
- window = mlab.window_hanning, noverlap=0, **kwargs)
+ call signature::
 
+ cohere(x, y, NFFT=256, Fs=2, Fc=0, detrend = mlab.detrend_none,
+ window = mlab.window_hanning, noverlap=0, **kwargs)
+
 cohere the coherence between x and y. Coherence is the normalized
 cross spectral density
 
- Cxy = |Pxy|^2/(Pxx*Pyy)
+ .. math::
 
+ C_{xy} = \\frac{|P_{xy}|^2}{P_{xx}*P_{yy}}
+
 The return value is (Cxy, f), where f are the frequencies of the
 coherence vector.
 
@@ -5777,9 +5907,11 @@
 
 Returns the tuple Cxy, freqs
 
- Refs: Bendat & P...
 
[truncated message content]