Mercurial > hg > octave-nkf

annotate scripts/plot/appearance/caxis.m @ 20383:777f26aa8e3e stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed plot/ and gui/ in scripts directory. * scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/private/__get_funcname__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m, scripts/plot/draw/area.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m, scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m, scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m, scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m, scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m, scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m, scripts/plot/util/zoom.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 22:50:09 -0700
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
1 ## Copyright (C) 2007-2015 David Bateman
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
2 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
4 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
8 ## your option) any later version.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
9 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
14 ##
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
18
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
17442
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
20 ## @deftypefn {Function File} {} caxis ([cmin cmax])
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
21 ## @deftypefnx {Function File} {} caxis ("auto")
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
22 ## @deftypefnx {Function File} {} caxis ("manual")
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
23 ## @deftypefnx {Function File} {} caxis (@var{hax}, @dots{})
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
24 ## @deftypefnx {Function File} {@var{limits} =} caxis ()
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
25 ## Query or set color axis limits for plots.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
26 ##
20383
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
27 ## The limits argument should be a 2-element vector specifying the lower and
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
28 ## upper limits to assign to the first and last value in the colormap. Data
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
29 ## values outside this range are clamped to the first and last colormap
777f26aa8e3e doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
30 ## entries.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
31 ##
17442
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
32 ## If the @qcode{"auto"} option is given then automatic colormap limits are
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
33 ## applied. The automatic algorithm sets @var{cmin} to the minimum data value
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
34 ## and @var{cmax} to the maximum data value. If @qcode{"manual"} is specified
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
35 ## then the @qcode{"climmode"} property is set to @qcode{"manual"} and the
4e86bb1901d6 caxis.m: Add more information to docstring.
Rik <rik@octave.org>
parents: 17301
diff changeset
36 ## numeric values in the @qcode{"clim"} property are used for limits.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
37 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17062
diff changeset
38 ## If the first argument @var{hax} is an axes handle, then operate on
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17062
diff changeset
39 ## this axis rather than the current axes returned by @code{gca}.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
40 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17062
diff changeset
41 ## Called without arguments the current color axis limits are returned.
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
42 ## @seealso{colormap}
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
43 ## @end deftypefn
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
44
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
45 function limits = caxis (varargin)
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
46
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
47 [hax, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:});
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
48
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17122
diff changeset
49 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17281
diff changeset
50 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17122
diff changeset
51 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17122
diff changeset
52 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
53 unwind_protect
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
54 if (isempty (hax))
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
55 hax = gca ();
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
56 endif
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
57 if (nargin == 0)
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
58 limits = __caxis__ (hax);
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
59 else
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
60 __caxis__ (hax, varargin{:});
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
61 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
62 unwind_protect_cleanup
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
63 if (! isempty (oldfig))
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
64 set (0, "currentfigure", oldfig);
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
65 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7189
diff changeset
66 end_unwind_protect
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
67
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
68 endfunction
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
69
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
70 function limits = __caxis__ (ca, ax, varargin)
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
71
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
72 if (nargin == 1)
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
73 limits = get (ca, "clim");
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
74 elseif (ischar (ax))
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7216
diff changeset
75 if (strcmpi (ax, "auto"))
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
76 set (ca, "climmode", "auto");
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7216
diff changeset
77 elseif (strcmpi (ax, "manual"))
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
78 set (ca, "climmode", "manual");
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
79 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
80 elseif (isvector (ax))
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
81 len = length (ax);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
82 if (len != 2)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
83 error ("caxis: expecting vector with 2 elements");
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
84 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
85
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
86 set (ca, "clim", [ax(1), ax(2)]);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
87 else
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
88 error ("caxis: expecting no args, a string, or a 2 element vector");
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
89 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
90
17062
19c3b5bf5c8e caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 14359
diff changeset
91 ## FIXME: Why should it be possible to call __caxis__ recursively?
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
92 if (nargin > 2)
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
93 __caxis__ (ca, varargin{:})';
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
94 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
95
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents:
diff changeset
96 endfunction
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
97