comparison scripts/plot/pcolor.m @ 8132:8139ddb83bc3

pcolor.m: Improve doc strings.
author Ben Abbott <bpabbott@mac.com>
date Tue, 23 Sep 2008 11:33:13 -0400
parents e70789e0cd92
children eb63fbe60fab
comparison
equal deleted inserted replaced
8131:10b63c4fd413 8132:8139ddb83bc3
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} pcolor (@var{x}, @var{y}, @var{c}) 20 ## @deftypefn {Function File} {} pcolor (@var{x}, @var{y}, @var{c})
21 ## @deftypefnx {Function File} {} pcolor (@var{c}) 21 ## @deftypefnx {Function File} {} pcolor (@var{c})
22 ## Density plot for given matrices @var{x}, and @var{y} from @code{meshgrid} and 22 ## Density plot for given matrices @var{x}, and @var{y} from @code{meshgrid} and
23 ## a matrix @var{c} corresponding to the @var{x} and @var{y} coordinates of 23 ## a matrix @var{c} corresponding to the @var{x} and @var{y} coordinates of
24 ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex 24 ## the mesh's vertices. If @var{x} and @var{y} are vectors, then a typical vertex
25 ## is (@var{x}(j), @var{y}(i), @var{c}(i,j)). Thus, columns of @var{c} 25 ## is (@var{x}(j), @var{y}(i), @var{c}(i,j)). Thus, columns of @var{c}
26 ## correspond to different @var{x} values and rows of @var{c} correspond 26 ## correspond to different @var{x} values and rows of @var{c} correspond
27 ## to different @var{y} values. 27 ## to different @var{y} values.
28 ## @seealso{meshgrid, contour} 28 ##
29 ## The @code{colormap} is scaled to the extents of @var{c}.
30 ## Limits may be placed on the color axis by the
31 ## command @code{caxis}, or by setting the @code{clim} property of the
32 ## parent axis.
33 ##
34 ## The face color of each cell of the mesh is determined by interpolating
35 ## the values of @var{c} for the cell's vertices. Contrast this with
36 ## @code{imagesc} which renders one cell for each element of @var{c}.
37 ##
38 ## @code{shading} modifies an attribute determining the manner by which the
39 ## face color of each cell is interpolated from the values of @var{c},
40 ## and the visibility of the cells' edges. By default the attribute is
41 ## "faceted", which renders a single color for each cell's face with the edge
42 ## visible.
43 ##
44 ## @var{h} is the handle to the surface object.
45 ##
46 ## @seealso{caxis, contour, meshgrid, imagesc, shading}
29 ## @end deftypefn 47 ## @end deftypefn
30 48
31 ## Author: Kai Habel <kai.habel@gmx.de> 49 ## Author: Kai Habel <kai.habel@gmx.de>
32 50
33 function h = pcolor (x, y, c) 51 function h = pcolor (x, y, c)