changeset 11852:624ee5198ca4 release-3-0-x

pcolor.m: Improve doc strings.
author Ben Abbott <bpabbott@mac.com>
date Wed, 24 Sep 2008 08:56:40 +0200
parents 651401a1c39b
children 69d44d782cee
files scripts/ChangeLog scripts/plot/pcolor.m
diffstat 2 files changed, 24 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog	Mon Sep 22 19:41:08 2008 +0200
+++ b/scripts/ChangeLog	Wed Sep 24 08:56:40 2008 +0200
@@ -1,3 +1,7 @@
+2008-09-23  Francesco Potorti`  <Potorti@isti.cnr.it>
+
+	* plot/pcolor.m: Improve doc string.
+
 2008-09-18  Jaroslav Hajek <highegg@gmail.com>
 
 	* general/blkdiag.m: Skip assignment if rhs is empty.
--- a/scripts/plot/pcolor.m	Mon Sep 22 19:41:08 2008 +0200
+++ b/scripts/plot/pcolor.m	Wed Sep 24 08:56:40 2008 +0200
@@ -21,11 +21,29 @@
 ## @deftypefnx {Function File} {} pcolor (@var{c})
 ## Density plot for given matrices @var{x}, and @var{y} from @code{meshgrid} and
 ## a matrix @var{c} corresponding to the @var{x} and @var{y} coordinates of
-## the mesh.  If @var{x} and @var{y} are vectors, then a typical vertex
+## the mesh's vertices. If @var{x} and @var{y} are vectors, then a typical vertex
 ## is (@var{x}(j), @var{y}(i), @var{c}(i,j)).  Thus, columns of @var{c}
 ## correspond to different @var{x} values and rows of @var{c} correspond
 ## to different @var{y} values.
-## @seealso{meshgrid, contour}
+##
+## The @code{colormap} is scaled to the extents of @var{c}.
+## Limits may be placed on the color axis by the
+## command @code{caxis}, or by setting the @code{clim} property of the
+## parent axis.
+##
+## The face color of each cell of the mesh is determined by interpolating
+## the values of @var{c} for the cell's vertices. Contrast this with 
+## @code{imagesc} which renders one cell for each element of @var{c}.
+##
+## @code{shading} modifies an attribute determining the manner by which the
+## face color of each cell is interpolated from the values of @var{c},
+## and the visibility of the cells' edges. By default the attribute is
+## "faceted", which renders a single color for each cell's face with the edge
+## visible.
+##
+## @var{h} is the handle to the surface object.
+##
+## @seealso{caxis, contour, meshgrid, imagesc, shading}
 ## @end deftypefn
 
 ## Author: Kai Habel <kai.habel@gmx.de>