Mercurial > hg > octave-nkf
diff scripts/plot/contourf.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | 9ff7d4849f03 |
children | 26589abbc78d |
line wrap: on
line diff
--- a/scripts/plot/contourf.m +++ b/scripts/plot/contourf.m @@ -18,39 +18,35 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} contourf (@var{x}, @var{y}, @var{z}, @var{lvl}) -## @deftypefnx {Function File} {} contourf (@var{x}, @var{y}, @var{z}, @var{n}) +## @deftypefn {Function File} {} contourf (@var{z}) +## @deftypefnx {Function File} {} contourf (@var{z}, @var{vn}) ## @deftypefnx {Function File} {} contourf (@var{x}, @var{y}, @var{z}) -## @deftypefnx {Function File} {} contourf (@var{z}, @var{n}) -## @deftypefnx {Function File} {} contourf (@var{z}, @var{lvl}) -## @deftypefnx {Function File} {} contourf (@var{z}) -## @deftypefnx {Function File} {} contourf (@dots{}, @var{prop}, @var{val}) +## @deftypefnx {Function File} {} contourf (@var{x}, @var{y}, @var{z}, @var{vn}) +## @deftypefnx {Function File} {} contourf (@dots{}, @var{style}) ## @deftypefnx {Function File} {} contourf (@var{hax}, @dots{}) ## @deftypefnx {Function File} {[@var{c}, @var{h}] =} contourf (@dots{}) -## Compute and plot filled contours of the matrix @var{z}. -## Parameters @var{x}, @var{y} and @var{n} or @var{lvl} are optional. +## Create a 2-D contour plot with filled intervals. ## -## If @var{x} and @var{y} are omitted they are taken as the row/column -## indices of @var{z}. @var{n} is a scalar denoting the number of contour -## lines to compute. Alternatively @var{lvl} is a vector containing the -## contour levels. If only one value (e.g., lvl0) is desired, set -## @var{lvl} to [lvl0, lvl0]. If both @var{n} or @var{lvl} are omitted -## a default value of 10 contour levels is assumed. +## Plot level curves (contour lines) of the matrix @var{z} and fill the region +## between lines with colors from the current colormap. +## +## The level curves are taken from the contour matrix @var{c} computed by +## @code{contourc} for the same arguments; see the latter for their +## interpretation. ## -## The appearance of the plot can be customized by passing -## property/value pairs to the function. +## The appearance of contour lines can be defined with a line style @var{style} +## in the same manner as @code{plot}. Only line style and color are used; +## Any markers defined by @var{style} are ignored. ## -## If provided, the filled contours are added to the axes object -## @var{hax} instead of the current axis. +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. ## -## The return value @var{c} is a 2xn matrix containing the contour lines -## as described in the documentation on the @code{contourc} function. +## The optional output @var{c} are the contour levels in @code{contourc} format. ## -## The return value @var{h} is handle-vector to the patch objects creating -## the filled contours. +## The optional return value @var{h} is a graphics handle to the hggroup +## comprising the contour lines. ## -## The following example plots filled contours of the @code{peaks} -## function. +## The following example plots filled contours of the @code{peaks} function. ## ## @example ## @group @@ -58,7 +54,7 @@ ## contourf (x, y, z, -7:9) ## @end group ## @end example -## @seealso{contourc, contour, contour3, patch} +## @seealso{ezcontourf, contour, contourc, contour3, clabel, meshc, surfc, caxis, colormap, plot} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de>