octave-lyh: scripts/image/colormap.m annotate

annotate scripts/image/colormap.m @ 17289: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	24bb7dc754ed
children	ab71b9829752

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	1 ## Copyright (C) 1994-2012 John W. Eaton
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	2 ## Copyright (C) 2012 Carnë Draug
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6895 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6895 diff changeset	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6895 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6895 diff changeset	18 ## <http://www.gnu.org/licenses/>.
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	19
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3373 diff changeset	20 ## -- texinfo --
14246 8b220af26cfb doc: Update docstring for colormap() Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	21 ## @deftypefn {Function File} {@var{cmap} =} colormap ()
8b220af26cfb doc: Update docstring for colormap() Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	22 ## @deftypefnx {Function File} {@var{cmap} =} colormap (@var{map})
8b220af26cfb doc: Update docstring for colormap() Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	23 ## @deftypefnx {Function File} {@var{cmap} =} colormap ("default")
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	24 ## @deftypefnx {Function File} {@var{cmap} =} colormap ("list")
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	25 ## @deftypefnx {Function File} {@var{cmap} =} colormap ("register", "@var{name}")
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	26 ## @deftypefnx {Function File} {@var{cmap} =} colormap ("unregister", "@var{name}")
16947 24bb7dc754ed Document command form of colormap(). Carnë Draug <carandraug@octave.org> parents: 16946 diff changeset	27 ## @deftypefnx {Command} {} colormap @var{map_name}
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14246 diff changeset	28 ## Query or set the current colormap.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	29 ##
16946 92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	30 ## With no input arguments, @code{colormap} returns the current color map.
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	31 ##
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3238 diff changeset	32 ## @code{colormap (@var{map})} sets the current colormap to @var{map}. The
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14246 diff changeset	33 ## colormap should be an @var{n} row by 3 column matrix. The columns
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3238 diff changeset	34 ## contain red, green, and blue intensities respectively. All entries
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14246 diff changeset	35 ## must be between 0 and 1 inclusive. The new colormap is returned.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	36 ##
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6762 diff changeset	37 ## @code{colormap ("default")} restores the default colormap (the
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6762 diff changeset	38 ## @code{jet} map with 64 entries). The default colormap is returned.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	39 ##
16946 92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	40 ## @code{colormap ("list")} returns a cell array with all of the available
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16947 diff changeset	41 ## colormaps. The options @qcode{"register"} and @qcode{"unregister"} will
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16947 diff changeset	42 ## add or remove the colormap @var{name} from this list.
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	43 ##
16947 24bb7dc754ed Document command form of colormap(). Carnë Draug <carandraug@octave.org> parents: 16946 diff changeset	44 ## For convenience, it is also possible to use this function with the
24bb7dc754ed Document command form of colormap(). Carnë Draug <carandraug@octave.org> parents: 16946 diff changeset	45 ## command form, where @var{map_name} must be the name of a function
24bb7dc754ed Document command form of colormap(). Carnë Draug <carandraug@octave.org> parents: 16946 diff changeset	46 ## that returns a colormap.
24bb7dc754ed Document command form of colormap(). Carnë Draug <carandraug@octave.org> parents: 16946 diff changeset	47 ##
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6762 diff changeset	48 ## @seealso{jet}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3238 diff changeset	49 ## @end deftypefn
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	50
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3106 diff changeset	51 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	52 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	53 ## Adapted-By: jwe
904 3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe] jwe parents: 559 diff changeset	54
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	55 function cmap = colormap (map, name)
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	56
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	57 if (nargin > 2)
5923 611e30b984b3 [project @ 2006-08-14 18:29:18 by jwe] jwe parents: 5443 diff changeset	58 print_usage ();
1062 1b3a87031641 [project @ 1995-01-24 02:54:50 by jwe] jwe parents: 1024 diff changeset	59 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	60
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	61 persistent map_list = cell ();
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	62
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	63 if (nargin == 1)
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	64
5443 ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe] jwe parents: 5307 diff changeset	65 if (ischar (map))
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	66 if (strcmp (map, "default"))
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6762 diff changeset	67 map = jet (64);
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	68 elseif (strcmp (map, "list"))
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	69 cmap = map_list;
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	70 return;
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	71 else
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 5923 diff changeset	72 map = feval (map);
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	73 endif
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	74 endif
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	75
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	76 if (! isempty (map))
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	77 if (! (isnumeric (map) && isreal (map)
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	78 && ndims (map) == 2 && columns (map) == 3))
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	79 error ("colormap: MAP must be a real-valued N x 3 ([R,G,B]) matrix");
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	80 endif
15683 806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14640 diff changeset	81 if (any (map(:) < 0) \|\| any (map(:) > 1))
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14640 diff changeset	82 error ("colormap: all MAP values must be in the range [0,1]");
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	83 endif
2303 5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe] jwe parents: 1887 diff changeset	84 ## Set the new color map
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 5923 diff changeset	85 set (gcf (), "colormap", map);
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	86 endif
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3202 diff changeset	87
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	88 elseif (nargin == 2)
16946 92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	89 if (! ischar (map) \|\| ! any (strcmp (map, {"register", "unregister"})))
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	90 print_usage ();
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	91 elseif (! ischar (name))
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	92 error ("colormap: to register/unregister a colormap, NAME must be a string");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	93 elseif (strcmp (map, "register"))
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	94 map_list{end+1} = name;
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	95 elseif (strcmp (map, "unregister"))
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	96 map_list(strcmp (name, map_list)) = [];
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14260 diff changeset	97 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	98 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	99
2303 5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe] jwe parents: 1887 diff changeset	100 ## Return current color map.
7108 60a1165732f9 [project @ 2007-11-06 22:05:18 by jwe] jwe parents: 7017 diff changeset	101 if (nargout > 0 \|\| (nargout == 0 && nargin == 0))
6762 721953d49b19 [project @ 2007-06-27 18:20:19 by jwe] jwe parents: 6257 diff changeset	102 cmap = get (gcf (), "colormap");
721953d49b19 [project @ 2007-06-27 18:20:19 by jwe] jwe parents: 6257 diff changeset	103 endif
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	104
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	105 endfunction
15683 806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14640 diff changeset	106
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14640 diff changeset	107
16946 92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	108 %!demo
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	109 %! ## Create an image for displaying a colormap
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	110 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	111 %! axis ([1, 64, 0, 1], "ticy", "xy");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	112 %! ## Show 'jet' colormap
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	113 %! colormap (jet (64));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	114 %! title "colormap (jet (64))"
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	115 %! disp ("Press a key to continue");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	116 %! pause ();
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	117 %! ## Show 'colorcube' colormap
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	118 %! colormap (colorcube (64));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	119 %! title "colormap (colorcube (64))"
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	120
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	121 %!test
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	122 %! figure ("visible", "off");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	123 %! cmaptst = [0 1 0; 1 0 1; 1 1 1];
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	124 %! cmap = colormap (cmaptst);
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	125 %! assert (cmap, cmaptst);
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	126 %! cmap = colormap ();
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	127 %! assert (cmap, cmaptst);
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	128 %! cmap = (get (gcf, "colormap"));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	129 %! assert (cmap, cmaptst);
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	130 %! colormap ("default");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	131 %! assert (colormap (), jet (64));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	132 %! colormap ("ocean");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	133 %! assert (colormap, ocean (64));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	134 %! close (); # done with temp. figure
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	135
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	136 %!test
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	137 %! cmaplst = colormap ("list");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	138 %! assert (iscell (cmaplst));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	139 %! colormap ("register", "__mycmap__");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	140 %! cmaplst2 = colormap ("list");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	141 %! assert (numel (cmaplst2), numel (cmaplst) + 1);
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	142 %! assert (any (strcmp (cmaplst2, "__mycmap__")));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	143 %! colormap ("unregister", "__mycmap__");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	144 %! cmaplst2 = colormap ("list");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	145 %! assert (numel (cmaplst2), numel (cmaplst));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	146 %! assert (! any (strcmp (cmaplst2, "__mycmap__")));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	147 %! ## Unregister again and verify that nothing has happened
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	148 %! colormap ("unregister", "__mycmap__");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	149 %! cmaplst3 = colormap ("list");
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	150 %! assert (isequal (cmaplst2, cmaplst3));
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	151
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	152 ## Test input validation
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	153 %!error colormap (1,2,3)
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	154 %!error <MAP must be a real-valued N x 3> colormap ({1,2,3})
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	155 %!error <MAP must be a real-valued N x 3> colormap ([1 i 1])
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	156 %!error <MAP must be a real-valued N x 3> colormap (ones(3,3,3))
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	157 %!error <MAP must be a real-valued N x 3> colormap ([1 0 1 0])
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	158 %!error <all MAP values must be in the range> colormap ([-1 0 0])
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	159 %!error <all MAP values must be in the range> colormap ([2 0 0])
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	160 %!error colormap ("invalid", "name")
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	161 %!error <NAME must be a string> colormap ("register", 1)
92f42d9f2ae4 colormap.m: Add demos, tests, and warning when using deprecated syntax. Rik <rik@octave.org> parents: 16766 diff changeset	162

Mercurial > hg > octave-lyh

annotate scripts/image/colormap.m @ 17289:bc924baa2c4e