Mercurial > octave-nkf
annotate scripts/plot/caxis.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 | 19c3b5bf5c8e |
| children | 87ba70043bfc |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11589
diff
changeset
|
1 ## Copyright (C) 2007-2012 David Bateman |
| 7189 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9040
diff
changeset
|
20 ## @deftypefn {Function File} {} caxis (@var{limits}) |
|
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 | 26 ## |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
27 ## The argument @var{limits} should be a 2-element vector specifying the |
| 7189 | 28 ## lower and upper limits to assign to the first and last value in the |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
29 ## colormap. Values outside this range are clamped to the first and last |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
30 ## colormap entries. |
| 7189 | 31 ## |
|
14359
7277fe922e99
doc: Use Octave preference for double quote in docstrings in scripts/
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
32 ## If @var{limits} is "auto", then automatic colormap scaling is applied, |
|
7277fe922e99
doc: Use Octave preference for double quote in docstrings in scripts/
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
33 ## whereas if @var{limits} is "manual" the colormap scaling is set to manual. |
| 7189 | 34 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17062
diff
changeset
|
35 ## 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
|
36 ## this axis rather than the current axes returned by @code{gca}. |
| 7189 | 37 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17062
diff
changeset
|
38 ## 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
|
39 ## @seealso{colormap} |
| 7189 | 40 ## @end deftypefn |
| 41 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
42 function limits = caxis (varargin) |
| 7189 | 43 |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
44 [hax, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:}); |
| 7216 | 45 |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
46 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure")); |
| 7215 | 47 unwind_protect |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
48 if (isempty (hax)) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
49 hax = gca (); |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
50 endif |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
51 if (nargin == 0) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
52 limits = __caxis__ (hax); |
| 7189 | 53 else |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
54 __caxis__ (hax, varargin{:}); |
| 7189 | 55 endif |
| 7215 | 56 unwind_protect_cleanup |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
57 if (! isempty (oldfig)) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
58 set (0, "currentfigure", oldfig); |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
59 endif |
| 7215 | 60 end_unwind_protect |
| 7189 | 61 |
| 62 endfunction | |
| 63 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
64 function limits = __caxis__ (ca, ax, varargin) |
| 7189 | 65 |
| 66 if (nargin == 1) | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
67 limits = get (ca, "clim"); |
| 7189 | 68 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
|
69 if (strcmpi (ax, "auto")) |
| 7189 | 70 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
|
71 elseif (strcmpi (ax, "manual")) |
| 7189 | 72 set (ca, "climmode", "manual"); |
| 73 endif | |
| 74 elseif (isvector (ax)) | |
| 75 len = length (ax); | |
| 76 if (len != 2) | |
| 77 error ("caxis: expecting vector with 2 elements"); | |
| 78 endif | |
| 79 | |
| 80 set (ca, "clim", [ax(1), ax(2)]); | |
| 81 else | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
82 error ("caxis: expecting no args, a string, or a 2 element vector"); |
| 7189 | 83 endif |
| 84 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
85 ## FIXME: Why should it be possible to call __caxis__ recursively? |
| 7189 | 86 if (nargin > 2) |
|
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
87 __caxis__ (ca, varargin{:})'; |
| 7189 | 88 endif |
| 89 | |
| 90 endfunction | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
91 |