Mercurial > octave-nkf
annotate scripts/plot/caxis.m @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.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/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | 87ba70043bfc |
| children | 68bcac3c043a |
| 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 ## |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17211
diff
changeset
|
32 ## If @var{limits} is @qcode{"auto"}, then automatic colormap scaling is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17211
diff
changeset
|
33 ## applied, whereas if @var{limits} is @qcode{"manual"} the colormap scaling |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17211
diff
changeset
|
34 ## is set to manual. |
| 7189 | 35 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17062
diff
changeset
|
36 ## 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
|
37 ## this axis rather than the current axes returned by @code{gca}. |
| 7189 | 38 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17062
diff
changeset
|
39 ## 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
|
40 ## @seealso{colormap} |
| 7189 | 41 ## @end deftypefn |
| 42 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
43 function limits = caxis (varargin) |
| 7189 | 44 |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
45 [hax, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:}); |
| 7216 | 46 |
|
17211
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
47 oldfig = []; |
|
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
48 if (isempty (hax)) |
|
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
49 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
|
50 endif |
| 7215 | 51 unwind_protect |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
52 if (isempty (hax)) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
53 hax = gca (); |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
54 endif |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
55 if (nargin == 0) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
56 limits = __caxis__ (hax); |
| 7189 | 57 else |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
58 __caxis__ (hax, varargin{:}); |
| 7189 | 59 endif |
| 7215 | 60 unwind_protect_cleanup |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
61 if (! isempty (oldfig)) |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
62 set (0, "currentfigure", oldfig); |
|
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
63 endif |
| 7215 | 64 end_unwind_protect |
| 7189 | 65 |
| 66 endfunction | |
| 67 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
68 function limits = __caxis__ (ca, ax, varargin) |
| 7189 | 69 |
| 70 if (nargin == 1) | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
71 limits = get (ca, "clim"); |
| 7189 | 72 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
|
73 if (strcmpi (ax, "auto")) |
| 7189 | 74 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
|
75 elseif (strcmpi (ax, "manual")) |
| 7189 | 76 set (ca, "climmode", "manual"); |
| 77 endif | |
| 78 elseif (isvector (ax)) | |
| 79 len = length (ax); | |
| 80 if (len != 2) | |
| 81 error ("caxis: expecting vector with 2 elements"); | |
| 82 endif | |
| 83 | |
| 84 set (ca, "clim", [ax(1), ax(2)]); | |
| 85 else | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
86 error ("caxis: expecting no args, a string, or a 2 element vector"); |
| 7189 | 87 endif |
| 88 | |
|
17062
19c3b5bf5c8e
caxis.m: Overhaul to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
89 ## FIXME: Why should it be possible to call __caxis__ recursively? |
| 7189 | 90 if (nargin > 2) |
|
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
91 __caxis__ (ca, varargin{:})'; |
| 7189 | 92 endif |
| 93 | |
| 94 endfunction | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
95 |