Mercurial > octave
changeset 33129:92b8822976fe
clim.m: New function identical to caxis, but more clearly named.
* NEWS.10.md: Announce addition of new function.
* scripts/plot/appearance/clim.m: New function.
* scripts/plot/appearance/module.mk: Add clim.m to build system.
* scripts/legacy/caxis.m: Moved from scripts/plot/appearance.
* scripts/legacy/module.mk: Add caxis.m to build system.
* plot.txi: Add clim to manual and remove caxis.
* imagesc.m, axis.m, text.m, contour.m, contour3.m, contourf.m, fill.m,
fill3.m, mesh.m, meshc.m, meshz.m, patch.m, pcolor.m, surf.m, surfc.m,
surfl.m, trimesh.m, trisurf.m, waterfall.m, caxis.m: Update all Seealso
links to point to clim rather than caxis.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 02 Mar 2024 19:59:16 -0800 |
parents | 7a25ad58d79e |
children | 41ac5e288d5a |
files | doc/interpreter/plot.txi etc/NEWS.10.md scripts/image/imagesc.m scripts/legacy/caxis.m scripts/legacy/module.mk scripts/plot/appearance/axis.m scripts/plot/appearance/caxis.m scripts/plot/appearance/clim.m scripts/plot/appearance/module.mk scripts/plot/appearance/text.m scripts/plot/draw/contour.m scripts/plot/draw/contour3.m scripts/plot/draw/contourf.m scripts/plot/draw/fill.m scripts/plot/draw/fill3.m scripts/plot/draw/mesh.m scripts/plot/draw/meshc.m scripts/plot/draw/meshz.m scripts/plot/draw/patch.m scripts/plot/draw/pcolor.m scripts/plot/draw/surf.m scripts/plot/draw/surfc.m scripts/plot/draw/surfl.m scripts/plot/draw/trimesh.m scripts/plot/draw/trisurf.m scripts/plot/draw/waterfall.m |
diffstat | 26 files changed, 298 insertions(+), 163 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi Sat Mar 02 19:24:04 2024 -0800 +++ b/doc/interpreter/plot.txi Sat Mar 02 19:59:16 2024 -0800 @@ -299,10 +299,10 @@ @DOCSTRING(axis) -Similarly the axis limits of the colormap can be changed with the caxis +Similarly the axis limits of the colormap can be changed with the @code{clim} function. -@DOCSTRING(caxis) +@DOCSTRING(clim) The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to get or set individual axis limits. Each has the same form.
--- a/etc/NEWS.10.md Sat Mar 02 19:24:04 2024 -0800 +++ b/etc/NEWS.10.md Sat Mar 02 19:59:16 2024 -0800 @@ -43,6 +43,7 @@ ### Alphabetical list of new functions added in Octave 10 +* `clim` * `rticklabels` * `tticklabels`
--- a/scripts/image/imagesc.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/image/imagesc.m Sat Mar 02 19:59:16 2024 -0800 @@ -55,7 +55,7 @@ ## and inserts it in the current axes. The full list of properties is ## documented at @ref{Image Properties}. ## -## @seealso{image, imshow, caxis} +## @seealso{image, imshow, clim} ## @end deftypefn function h = imagesc (varargin)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/legacy/caxis.m Sat Mar 02 19:59:16 2024 -0800 @@ -0,0 +1,133 @@ +######################################################################## +## +## Copyright (C) 2007-2024 The Octave Project Developers +## +## See the file COPYRIGHT.md in the top-level directory of this +## distribution or <https://octave.org/copyright/>. +## +## This file is part of Octave. +## +## Octave is free software: you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## (at your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <https://www.gnu.org/licenses/>. +## +######################################################################## + +## -*- texinfo -*- +## @deftypefn {} {} caxis ([cmin cmax]) +## @deftypefnx {} {} caxis ("auto") +## @deftypefnx {} {} caxis ("manual") +## @deftypefnx {} {} caxis (@var{hax}, @dots{}) +## @deftypefnx {} {@var{limits} =} caxis () +## +## This function is not recommended. Use @code{clim} instead. +## +## Query or set color axis limits for plots. +## +## The limits argument should be a 2-element vector specifying the lower and +## upper limits to assign to the first and last value in the colormap. Data +## values outside this range are clamped to the first and last colormap +## entries. +## +## If the @qcode{"auto"} option is given then automatic colormap limits are +## applied. The automatic algorithm sets @var{cmin} to the minimum data value +## and @var{cmax} to the maximum data value. If @qcode{"manual"} is specified +## then the @qcode{"climmode"} property is set to @qcode{"manual"} and the +## numeric values in the @qcode{"clim"} property are used for limits. +## +## If the first argument @var{hax} is an axes handle, then operate on +## this axes rather than the current axes returned by @code{gca}. +## +## Called without arguments the current color axis limits are returned. +## +## Programming Note: The color axis affects the display of image, patch, and +## surface graphics objects, but @strong{only} if the @qcode{"cdata"} property +## has indexed data and the @qcode{"cdatamapping"} property is set to +## @qcode{"scaled"}. Graphic objects with true color @code{cdata}, or +## @qcode{"direct"} @code{cdatamapping} are not affected. +## @seealso{clim, colormap, axis} +## @end deftypefn + +function limits = caxis (varargin) + + [hax, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:}); + + if (nargin > 1) + print_usage (); + endif + + oldfig = []; + if (! isempty (hax)) + oldfig = get (0, "currentfigure"); + endif + unwind_protect + if (isempty (hax)) + hax = gca (); + endif + if (nargin == 0) + limits = get (hax, "clim"); + else + arg1 = varargin{1}; + if (ischar (arg1)) + if (strcmpi (arg1, "auto")) + set (hax, "climmode", "auto"); + elseif (strcmpi (arg1, "manual")) + set (hax, "climmode", "manual"); + else + error ("caxis: invalid mode '%s'", arg1); + endif + elseif (isvector (arg1)) + if (numel (arg1) != 2 || ! isnumeric (arg1) || arg1(1) >= arg1(2)) + error ("caxis: LIMITS must be a numeric 2-element vector where LIM1 < LIM2"); + endif + set (hax, "clim", arg1); + else + print_usage (); + endif + endif + unwind_protect_cleanup + if (! isempty (oldfig)) + set (0, "currentfigure", oldfig); + endif + end_unwind_protect + +endfunction + + +%!test +%! hf = figure ("visible", "off"); +%! hax = gca (); +%! unwind_protect +%! caxis ([e, pi]); +%! assert (caxis (), [e, pi]); +%! caxis (hax, [-1, 1]); +%! assert (caxis (hax), [-1, 1]); +%! assert (get (hax, "climmode"), "manual"); +%! caxis ("auto"); +%! assert (get (hax, "climmode"), "auto"); +%! unwind_protect_cleanup +%! close (hf); +%! end_unwind_protect + +## Test input validation +%!error caxis (1,2,3) +%!test +%! hf = figure ("visible", "off"); +%! unwind_protect +%! fail ("caxis ('foo')", "invalid mode 'foo'"); +%! fail ("caxis ([1 2 3])", "2-element vector"); +%! fail ("caxis ({1 2 3})", "numeric 2-element vector"); +%! fail ("caxis ([1 0])", "LIM1 < LIM2"); +%! unwind_protect_cleanup +%! close (hf); +%! end_unwind_protect
--- a/scripts/legacy/module.mk Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/legacy/module.mk Sat Mar 02 19:59:16 2024 -0800 @@ -3,6 +3,7 @@ %canon_reldir%_FCN_FILES = \ %reldir%/.oct-config \ %reldir%/__vectorize__.m \ + %reldir%/caxis.m \ %reldir%/findstr.m \ %reldir%/flipdim.m \ %reldir%/genvarname.m \
--- a/scripts/plot/appearance/axis.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/appearance/axis.m Sat Mar 02 19:59:16 2024 -0800 @@ -158,7 +158,7 @@ ## axis ("tic", "labely"); ## @end example ## -## @seealso{xlim, ylim, zlim, caxis, daspect, pbaspect, box, grid} +## @seealso{xlim, ylim, zlim, clim, daspect, pbaspect, box, grid} ## @end deftypefn function limits = axis (varargin) @@ -390,7 +390,7 @@ endif if (len > 7) - caxis (ca, opt(7:8)); + clim (ca, opt(7:8)); endif else
--- a/scripts/plot/appearance/caxis.m Sat Mar 02 19:24:04 2024 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,130 +0,0 @@ -######################################################################## -## -## Copyright (C) 2007-2024 The Octave Project Developers -## -## See the file COPYRIGHT.md in the top-level directory of this -## distribution or <https://octave.org/copyright/>. -## -## This file is part of Octave. -## -## Octave is free software: you can redistribute it and/or modify it -## under the terms of the GNU General Public License as published by -## the Free Software Foundation, either version 3 of the License, or -## (at your option) any later version. -## -## Octave is distributed in the hope that it will be useful, but -## WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU General Public License for more details. -## -## You should have received a copy of the GNU General Public License -## along with Octave; see the file COPYING. If not, see -## <https://www.gnu.org/licenses/>. -## -######################################################################## - -## -*- texinfo -*- -## @deftypefn {} {} caxis ([cmin cmax]) -## @deftypefnx {} {} caxis ("auto") -## @deftypefnx {} {} caxis ("manual") -## @deftypefnx {} {} caxis (@var{hax}, @dots{}) -## @deftypefnx {} {@var{limits} =} caxis () -## Query or set color axis limits for plots. -## -## The limits argument should be a 2-element vector specifying the lower and -## upper limits to assign to the first and last value in the colormap. Data -## values outside this range are clamped to the first and last colormap -## entries. -## -## If the @qcode{"auto"} option is given then automatic colormap limits are -## applied. The automatic algorithm sets @var{cmin} to the minimum data value -## and @var{cmax} to the maximum data value. If @qcode{"manual"} is specified -## then the @qcode{"climmode"} property is set to @qcode{"manual"} and the -## numeric values in the @qcode{"clim"} property are used for limits. -## -## If the first argument @var{hax} is an axes handle, then operate on -## this axes rather than the current axes returned by @code{gca}. -## -## Called without arguments the current color axis limits are returned. -## -## Programming Note: The color axis affects the display of image, patch, and -## surface graphics objects, but @strong{only} if the @qcode{"cdata"} property -## has indexed data and the @qcode{"cdatamapping"} property is set to -## @qcode{"scaled"}. Graphic objects with true color @code{cdata}, or -## @qcode{"direct"} @code{cdatamapping} are not affected. -## @seealso{colormap, axis} -## @end deftypefn - -function limits = caxis (varargin) - - [hax, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:}); - - if (nargin > 1) - print_usage (); - endif - - oldfig = []; - if (! isempty (hax)) - oldfig = get (0, "currentfigure"); - endif - unwind_protect - if (isempty (hax)) - hax = gca (); - endif - if (nargin == 0) - limits = get (hax, "clim"); - else - arg1 = varargin{1}; - if (ischar (arg1)) - if (strcmpi (arg1, "auto")) - set (hax, "climmode", "auto"); - elseif (strcmpi (arg1, "manual")) - set (hax, "climmode", "manual"); - else - error ("caxis: invalid mode '%s'", arg1); - endif - elseif (isvector (arg1)) - if (numel (arg1) != 2 || ! isnumeric (arg1) || arg1(1) >= arg1(2)) - error ("caxis: LIMITS must be a numeric 2-element vector where LIM1 < LIM2"); - endif - set (hax, "clim", arg1); - else - print_usage (); - endif - endif - unwind_protect_cleanup - if (! isempty (oldfig)) - set (0, "currentfigure", oldfig); - endif - end_unwind_protect - -endfunction - - -%!test -%! hf = figure ("visible", "off"); -%! hax = gca (); -%! unwind_protect -%! caxis ([e, pi]); -%! assert (caxis (), [e, pi]); -%! caxis (hax, [-1, 1]); -%! assert (caxis (hax), [-1, 1]); -%! assert (get (hax, "climmode"), "manual"); -%! caxis ("auto"); -%! assert (get (hax, "climmode"), "auto"); -%! unwind_protect_cleanup -%! close (hf); -%! end_unwind_protect - -## Test input validation -%!error caxis (1,2,3) -%!test -%! hf = figure ("visible", "off"); -%! unwind_protect -%! fail ("caxis ('foo')", "invalid mode 'foo'"); -%! fail ("caxis ([1 2 3])", "2-element vector"); -%! fail ("caxis ({1 2 3})", "numeric 2-element vector"); -%! fail ("caxis ([1 0])", "LIM1 < LIM2"); -%! unwind_protect_cleanup -%! close (hf); -%! end_unwind_protect
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/plot/appearance/clim.m Sat Mar 02 19:59:16 2024 -0800 @@ -0,0 +1,130 @@ +######################################################################## +## +## Copyright (C) 2024 The Octave Project Developers +## +## See the file COPYRIGHT.md in the top-level directory of this +## distribution or <https://octave.org/copyright/>. +## +## This file is part of Octave. +## +## Octave is free software: you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## (at your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <https://www.gnu.org/licenses/>. +## +######################################################################## + +## -*- texinfo -*- +## @deftypefn {} {} clim ([cmin cmax]) +## @deftypefnx {} {} clim ("auto") +## @deftypefnx {} {} clim ("manual") +## @deftypefnx {} {} clim (@var{hax}, @dots{}) +## @deftypefnx {} {@var{limits} =} clim () +## Query or set color axis limits for plots. +## +## The limits argument should be a 2-element vector specifying the lower and +## upper limits to assign to the first and last value in the colormap. Data +## values outside this range are clamped to the first and last colormap +## entries. +## +## If the @qcode{"auto"} option is given then automatic colormap limits are +## applied. The automatic algorithm sets @var{cmin} to the minimum data value +## and @var{cmax} to the maximum data value. If @qcode{"manual"} is specified +## then the @qcode{"climmode"} property is set to @qcode{"manual"} and the +## numeric values in the @qcode{"clim"} property are used for limits. +## +## If the first argument @var{hax} is an axes handle, then operate on +## this axes rather than the current axes returned by @code{gca}. +## +## Called without arguments the current color axis limits are returned. +## +## Programming Note: The color axis affects the display of image, patch, and +## surface graphics objects, but @strong{only} if the @qcode{"cdata"} property +## has indexed data and the @qcode{"cdatamapping"} property is set to +## @qcode{"scaled"}. Graphic objects with true color @code{cdata}, or +## @qcode{"direct"} @code{cdatamapping} are not affected. +## @seealso{colormap, axis} +## @end deftypefn + +function limits = clim (varargin) + + [hax, varargin, nargin] = __plt_get_axis_arg__ ("clim", varargin{:}); + + if (nargin > 1) + print_usage (); + endif + + oldfig = []; + if (! isempty (hax)) + oldfig = get (0, "currentfigure"); + endif + unwind_protect + if (isempty (hax)) + hax = gca (); + endif + if (nargin == 0) + limits = get (hax, "clim"); + else + arg1 = varargin{1}; + if (ischar (arg1)) + if (strcmpi (arg1, "auto")) + set (hax, "climmode", "auto"); + elseif (strcmpi (arg1, "manual")) + set (hax, "climmode", "manual"); + else + error ("clim: invalid mode '%s'", arg1); + endif + elseif (isvector (arg1)) + if (numel (arg1) != 2 || ! isnumeric (arg1) || arg1(1) >= arg1(2)) + error ("clim: LIMITS must be a numeric 2-element vector where LIM1 < LIM2"); + endif + set (hax, "clim", arg1); + else + print_usage (); + endif + endif + unwind_protect_cleanup + if (! isempty (oldfig)) + set (0, "currentfigure", oldfig); + endif + end_unwind_protect + +endfunction + + +%!test +%! hf = figure ("visible", "off"); +%! hax = gca (); +%! unwind_protect +%! clim ([e, pi]); +%! assert (clim (), [e, pi]); +%! clim (hax, [-1, 1]); +%! assert (clim (hax), [-1, 1]); +%! assert (get (hax, "climmode"), "manual"); +%! clim ("auto"); +%! assert (get (hax, "climmode"), "auto"); +%! unwind_protect_cleanup +%! close (hf); +%! end_unwind_protect + +## Test input validation +%!error clim (1,2,3) +%!test +%! hf = figure ("visible", "off"); +%! unwind_protect +%! fail ("clim ('foo')", "invalid mode 'foo'"); +%! fail ("clim ([1 2 3])", "2-element vector"); +%! fail ("clim ({1 2 3})", "numeric 2-element vector"); +%! fail ("clim ([1 0])", "LIM1 < LIM2"); +%! unwind_protect_cleanup +%! close (hf); +%! end_unwind_protect
--- a/scripts/plot/appearance/module.mk Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/appearance/module.mk Sat Mar 02 19:59:16 2024 -0800 @@ -24,8 +24,8 @@ %reldir%/camup.m \ %reldir%/camva.m \ %reldir%/camzoom.m \ - %reldir%/caxis.m \ %reldir%/clabel.m \ + %reldir%/clim.m \ %reldir%/daspect.m \ %reldir%/datetick.m \ %reldir%/diffuse.m \
--- a/scripts/plot/appearance/text.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/appearance/text.m Sat Mar 02 19:59:16 2024 -0800 @@ -280,7 +280,7 @@ %! "edgecolor", "k", ... %! "verticalalignment", "bottom"); %! endfor -%! caxis ([-100 100]); +%! clim ([-100 100]); %! title ("Vertically Aligned at Bottom"); %!demo
--- a/scripts/plot/draw/contour.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/contour.m Sat Mar 02 19:59:16 2024 -0800 @@ -62,7 +62,7 @@ ## @end example ## ## @seealso{ezcontour, contourc, contourf, contour3, clabel, meshc, surfc, -## caxis, colormap, plot} +## clim, colormap, plot} ## ## @end deftypefn
--- a/scripts/plot/draw/contour3.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/contour3.m Sat Mar 02 19:59:16 2024 -0800 @@ -66,7 +66,7 @@ ## @end group ## @end example ## -## @seealso{contour, contourc, contourf, clabel, meshc, surfc, caxis, colormap, +## @seealso{contour, contourc, contourf, clabel, meshc, surfc, clim, colormap, ## plot} ## @end deftypefn
--- a/scripts/plot/draw/contourf.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/contourf.m Sat Mar 02 19:59:16 2024 -0800 @@ -62,7 +62,7 @@ ## @end group ## @end example ## @seealso{ezcontourf, contour, contourc, contour3, clabel, meshc, surfc, -## caxis, colormap, plot} +## clim, colormap, plot} ## @end deftypefn function [c, h] = contourf (varargin)
--- a/scripts/plot/draw/fill.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/fill.m Sat Mar 02 19:59:16 2024 -0800 @@ -40,7 +40,7 @@ ## is a single color specification such as a @code{plot} format or an ## RGB-triple. In this case the polygon(s) will have one unique color. If ## @var{c} is a vector or matrix then the color data is first scaled using -## @code{caxis} and then indexed into the current colormap. A row vector will +## @code{clim} and then indexed into the current colormap. A row vector will ## color each polygon (a column from matrices @var{x} and @var{y}) with a ## single computed color. A matrix @var{c} of the same size as @var{x} and ## @var{y} will compute the color of each vertex and then interpolate the face @@ -70,7 +70,7 @@ ## @end group ## @end example ## -## @seealso{patch, fill3, caxis, colormap} +## @seealso{patch, fill3, clim, colormap} ## @end deftypefn function h = fill (varargin)
--- a/scripts/plot/draw/fill3.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/fill3.m Sat Mar 02 19:59:16 2024 -0800 @@ -40,7 +40,7 @@ ## is a single color specification such as a @code{plot} format or an ## RGB-triple. In this case the polygon(s) will have one unique color. If ## @var{c} is a vector or matrix then the color data is first scaled using -## @code{caxis} and then indexed into the current colormap. A row vector will +## @code{clim} and then indexed into the current colormap. A row vector will ## color each polygon (a column from matrices @var{x}, @var{y}, and @var{z}) ## with a single computed color. A matrix @var{c} of the same size as @var{x}, ## @var{y}, and @var{z} will compute the color of each vertex and then @@ -72,7 +72,7 @@ ## @end group ## @end example ## -## @seealso{patch, fill, caxis, colormap} +## @seealso{patch, fill, clim, colormap} ## @end deftypefn function h = fill3 (varargin)
--- a/scripts/plot/draw/mesh.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/mesh.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the mesh is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally, the color of the mesh can be specified independently of @var{z} @@ -59,7 +59,7 @@ ## surface object. ## ## @seealso{ezmesh, meshc, meshz, trimesh, contour, surf, surface, meshgrid, -## hidden, shading, colormap, caxis} +## hidden, shading, colormap, clim} ## @end deftypefn function h = mesh (varargin)
--- a/scripts/plot/draw/meshc.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/meshc.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the mesh is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally the color of the mesh can be specified independently of @var{z} @@ -59,7 +59,7 @@ ## handle to the created surface object and to the created contour plot. ## ## @seealso{ezmeshc, mesh, meshz, contour, surfc, surface, meshgrid, hidden, -## shading, colormap, caxis} +## shading, colormap, clim} ## @end deftypefn function h = meshc (varargin)
--- a/scripts/plot/draw/meshz.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/meshz.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the mesh is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally the color of the mesh can be specified independently of @var{z} @@ -59,7 +59,7 @@ ## surface object. ## ## @seealso{mesh, meshc, contour, surf, surface, waterfall, meshgrid, hidden, -## shading, colormap, caxis} +## shading, colormap, clim} ## @end deftypefn function h = meshz (varargin)
--- a/scripts/plot/draw/patch.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/patch.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,11 +42,11 @@ ## ## The color argument @var{c} can take many forms. To create polygons ## which all share a single color use a string value (e.g., @qcode{"r"} for -## red), a scalar value which is scaled by @code{caxis} and indexed into the +## red), a scalar value which is scaled by @code{clim} and indexed into the ## current colormap, or a 3-element RGB vector with the precise TrueColor. ## ## If @var{c} is a vector of length N then the ith polygon will have a color -## determined by scaling entry @var{c}(i) according to @code{caxis} and then +## determined by scaling entry @var{c}(i) according to @code{clim} and then ## indexing into the current colormap. More complicated coloring situations ## require directly manipulating patch property/value pairs. ##
--- a/scripts/plot/draw/pcolor.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/pcolor.m Sat Mar 02 19:59:16 2024 -0800 @@ -40,7 +40,7 @@ ## ## The values in @var{c} are scaled to span the range of the current ## colormap. Limits may be placed on the color axis by the command -## @code{caxis}, or by setting the @code{clim} property of the parent axis. +## @code{clim}, 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 each of the cell's vertices; Contrast this with @@ -58,7 +58,7 @@ ## The optional return value @var{h} is a graphics handle to the created ## surface object. ## -## @seealso{caxis, shading, meshgrid, contour, imagesc} +## @seealso{clim, shading, meshgrid, contour, imagesc} ## @end deftypefn function h = pcolor (varargin)
--- a/scripts/plot/draw/surf.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/surf.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the surface is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally, the color of the surface can be specified independently of @@ -62,7 +62,7 @@ ## @code{shading} command or by using @code{set} to control surface object ## properties. ## @seealso{ezsurf, surfc, surfl, surfnorm, trisurf, contour, mesh, surface, -## meshgrid, hidden, shading, colormap, caxis} +## meshgrid, hidden, shading, colormap, clim} ## @end deftypefn function h = surf (varargin)
--- a/scripts/plot/draw/surfc.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/surfc.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the surface is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally, the color of the surface can be specified independently of @@ -62,7 +62,7 @@ ## @code{shading} command or by using @code{set} to control surface object ## properties. ## @seealso{ezsurfc, surf, surfl, surfnorm, trisurf, contour, mesh, surface, -## meshgrid, hidden, shading, colormap, caxis} +## meshgrid, hidden, shading, colormap, clim} ## @end deftypefn function h = surfc (varargin)
--- a/scripts/plot/draw/surfl.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/surfl.m Sat Mar 02 19:59:16 2024 -0800 @@ -83,7 +83,7 @@ ## shading interp; ## @end group ## @end example -## @seealso{diffuse, specular, surf, shading, colormap, caxis} +## @seealso{diffuse, specular, surf, shading, colormap, clim} ## @end deftypefn function h = surfl (varargin)
--- a/scripts/plot/draw/trimesh.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/trimesh.m Sat Mar 02 19:59:16 2024 -0800 @@ -42,7 +42,7 @@ ## the triangles are plotted as a 2-D figure. ## ## The color of the trimesh is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally, the color of the mesh can be specified independently of @var{z}
--- a/scripts/plot/draw/trisurf.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/trisurf.m Sat Mar 02 19:59:16 2024 -0800 @@ -40,7 +40,7 @@ ## plane of each vertex. ## ## The color of the trisurf is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or change +## to fit the range of the current colormap. Use @code{clim} and/or change ## the colormap to control the appearance. ## ## Optionally, the color of the mesh can be specified independently of @var{z}
--- a/scripts/plot/draw/waterfall.m Sat Mar 02 19:24:04 2024 -0800 +++ b/scripts/plot/draw/waterfall.m Sat Mar 02 19:59:16 2024 -0800 @@ -45,7 +45,7 @@ ## of @var{z} correspond to different @var{y} values. ## ## The color of the mesh is computed by linearly scaling the @var{z} values -## to fit the range of the current colormap. Use @code{caxis} and/or +## to fit the range of the current colormap. Use @code{clim} and/or ## change the colormap to control the appearance. ## ## Optionally the color of the mesh can be specified independently of @var{z} @@ -62,7 +62,7 @@ ## surface object. ## ## @seealso{meshz, mesh, meshc, contour, surf, surface, ribbon, meshgrid, -## hidden, shading, colormap, caxis} +## hidden, shading, colormap, clim} ## @end deftypefn function h = waterfall (varargin)