octave-nkf: scripts/image/imshow.m annotate

annotate scripts/image/imshow.m @ 19630:0e1f5a750d00

maint: Periodic merge of gui-release to default.

author	John W. Eaton <jwe@octave.org>
date	Tue, 20 Jan 2015 10:24:46 -0500
parents	0461fe1d2a01 446c46af4b42
children	db92e7e28e1f

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17734 diff changeset	1 ## Copyright (C) 1994-2013 John W. Eaton
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	2 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ## 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	6 ## 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: 6757 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6757 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## 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	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ## 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: 6757 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6757 diff changeset	17 ## <http://www.gnu.org/licenses/>.
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 904 diff changeset	18
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3373 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10648 diff changeset	20 ## @deftypefn {Function File} {} imshow (@var{im})
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	21 ## @deftypefnx {Function File} {} imshow (@var{im}, @var{limits})
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	22 ## @deftypefnx {Function File} {} imshow (@var{im}, @var{map})
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	23 ## @deftypefnx {Function File} {} imshow (@var{rgb}, @dots{})
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	24 ## @deftypefnx {Function File} {} imshow (@var{filename})
6309 6a60e68fc4b1 [project @ 2007-02-15 09:49:27 by jwe] jwe parents: 6219 diff changeset	25 ## @deftypefnx {Function File} {} imshow (@dots{}, @var{string_param1}, @var{value1}, @dots{})
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13738 diff changeset	26 ## @deftypefnx {Function File} {@var{h} =} imshow (@dots{})
6368 ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe] jwe parents: 6310 diff changeset	27 ## Display the image @var{im}, where @var{im} can be a 2-dimensional
14897 8e2a6fc55787 doc: Use 'grayscale' rather than 'gray-scale' in documentation. Rik <rik@octave.org> parents: 14366 diff changeset	28 ## (grayscale image) or a 3-dimensional (RGB image) matrix.
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	29 ##
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	30 ## If @var{limits} is a 2-element vector @code{[@var{low}, @var{high}]},
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	31 ## the image is shown using a display range between @var{low} and
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	32 ## @var{high}. If an empty matrix is passed for @var{limits}, the
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	33 ## display range is computed as the range between the minimal and the
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	34 ## maximal value in the image.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	35 ##
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	36 ## If @var{map} is a valid color map, the image will be shown as an indexed
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	37 ## image using the supplied color map.
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	38 ##
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	39 ## If a file name is given instead of an image, the file will be read and
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	40 ## shown.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	41 ##
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	42 ## If given, the parameter @var{string_param1} has value
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	43 ## @var{value1}. @var{string_param1} can be any of the following:
14366 b76f0740940e doc: Periodic grammar check of documentation. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	44 ##
11595 5ec6aa05638d Prevent doubled quotes around @table items in Info. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	45 ## @table @asis
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14897 diff changeset	46 ## @item @qcode{"displayrange"}
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	47 ## @var{value1} is the display range as described above.
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 18546 diff changeset	48 ##
18748 c79696701468 doc: Document new 'colormap' parameter to imshow. Rik <rik@octave.org> parents: 18747 diff changeset	49 ## @item @qcode{"colormap"}
c79696701468 doc: Document new 'colormap' parameter to imshow. Rik <rik@octave.org> parents: 18747 diff changeset	50 ## @var{value1} is the colormap to use when displaying an indexed image.
19630 0e1f5a750d00 maint: Periodic merge of gui-release to default. John W. Eaton <jwe@octave.org> parents: 18773 19627 diff changeset	51 ##
17753 887df64e54e4 doc: Final grammarcheck of docstrings for 3.8 release. Rik <rik@octave.org> parents: 17744 diff changeset	52 ## @item @qcode{"xdata"}
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	53 ## If @var{value1} is a two element vector, it must contain horizontal axis
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	54 ## limits in the form [xmin xmax]; Otherwise @var{value1} must be a
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	55 ## vector and only the first and last elements will be used for xmin and
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	56 ## xmax respectively.
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 18546 diff changeset	57 ##
17753 887df64e54e4 doc: Final grammarcheck of docstrings for 3.8 release. Rik <rik@octave.org> parents: 17744 diff changeset	58 ## @item @qcode{"ydata"}
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	59 ## If @var{value1} is a two element vector, it must contain vertical axis
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	60 ## limits in the form [ymin ymax]; Otherwise @var{value1} must be a
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	61 ## vector and only the first and last elements will be used for ymin and
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	62 ## ymax respectively.
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	63 ##
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	64 ## @end table
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13738 diff changeset	65 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13738 diff changeset	66 ## The optional return value @var{h} is a graphics handle to the image.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5443 diff changeset	67 ## @seealso{image, imagesc, colormap, gray2ind, rgb2ind}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	68 ## @end deftypefn
904 3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe] jwe parents: 559 diff changeset	69
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	70 ## Author: Stefan van der Walt <stefan@sun.ac.za>
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	71 ## Author: Soren Hauberg <hauberg at gmail dot com>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	72 ## Adapted-By: jwe
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	73
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	74 function h = imshow (im, varargin)
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	75
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	76 if (nargin == 0)
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	77 print_usage ();
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	78 endif
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	79
7328 d0784e593d39 [project @ 2007-12-20 07:24:02 by jwe] jwe parents: 7321 diff changeset	80 display_range = NA;
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	81 truecolor = false;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	82 indexed = false;
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	83 xdata = ydata = [];
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	84
5935 01ff100fcd64 [project @ 2006-08-17 20:40:58 by jwe] jwe parents: 5934 diff changeset	85 ## Get the image.
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	86 if (ischar (im))
7931 de26beacb20f imread.m: simplify; loadimage.m: deprecate John W. Eaton <jwe@octave.org> parents: 7930 diff changeset	87 [im, map] = imread (im);
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	88 indexed = true;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	89 colormap (map);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	90 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	91
10286 8cf666139297 imshow for logical matrices John W. Eaton <jwe@octave.org> parents: 9273 diff changeset	92 nd = ndims (im);
8cf666139297 imshow for logical matrices John W. Eaton <jwe@octave.org> parents: 9273 diff changeset	93
8cf666139297 imshow for logical matrices John W. Eaton <jwe@octave.org> parents: 9273 diff changeset	94 if (! ((isnumeric (im) \|\| islogical (im)) && (nd == 2 \|\| nd == 3)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 11324 diff changeset	95 error ("imshow: IM must be an image or the filename of an image");
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	96 endif
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	97
10286 8cf666139297 imshow for logical matrices John W. Eaton <jwe@octave.org> parents: 9273 diff changeset	98 if (nd == 2)
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	99 if (! indexed)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	100 colormap (gray ());
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	101 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	102 elseif (size (im, 3) == 3)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	103 if (ismember (class (im), {"uint8", "uint16", "double", "single"}))
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	104 truecolor = true;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	105 else
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	106 error ("imshow: TrueColor image must be uint8, uint16, double, or single");
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	107 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	108 else
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	109 error ("imshow: expecting MxN or MxNx3 matrix for image");
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	110 endif
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	111
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	112 narg = 1;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	113 while (narg <= numel (varargin))
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	114 arg = varargin{narg++};
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	115 if (isnumeric (arg))
7331 3ed85de5922c [project @ 2007-12-21 17:40:20 by jwe] jwe parents: 7328 diff changeset	116 if (numel (arg) == 2 \|\| isempty (arg))
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	117 display_range = arg;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	118 elseif (columns (arg) == 3)
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	119 indexed = true;
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	120 if (iscolormap (arg))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	121 colormap (arg);
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	122 else
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	123 error ("imshow: invalid colormap MAP");
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	124 endif
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	125 elseif (! isempty (arg))
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	126 error ("imshow: argument number %d is invalid", narg);
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	127 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	128 elseif (ischar (arg))
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	129 switch (tolower (arg))
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	130 case "colormap"
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	131 map = varargin{narg++};
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	132 if (iscolormap (map))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	133 colormap (map);
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	134 else
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	135 error ("imshow: invalid colormap");
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	136 endif
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	137 case "displayrange"
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	138 display_range = varargin{narg++};
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	139 case "parent"
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	140 warning ("imshow: parent argument is not implemented");
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	141 case {"truesize", "initialmagnification"}
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	142 warning ("image: zoom argument ignored -- use GUI features");
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	143 case "xdata"
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	144 xdata = varargin{narg++};
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	145 if (! isvector (xdata))
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	146 error ("imshow: xdata must be a vector")
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	147 endif
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	148 xdata = [xdata(1) xdata(end)];
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	149 case "ydata"
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	150 ydata = varargin{narg++};
18546 8e384416ebb3 imshow.m: Fix bad input validation of ydata (bug #41773). Rik <rik@octave.org> parents: 17753 diff changeset	151 if (! isvector (ydata))
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	152 error ("imshow: ydata must be a vector")
17734 64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	153 endif
64ad713b3a64 imshow.m: Add support for "xdata" and "ydata" options, make option parser case insensitive Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 17281 diff changeset	154 ydata = [ydata(1) ydata(end)];
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	155 otherwise
2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	156 warning ("imshow: unrecognized property %s", arg);
2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	157 narg++;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	158 endswitch
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	159 else
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	160 error ("imshow: argument number %d is invalid", narg);
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	161 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	162 endwhile
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	163
13738 7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	164 ## Check for complex images.
7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	165 if (iscomplex (im))
7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	166 warning ("imshow: only showing real part of complex image");
7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	167 im = real (im);
7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	168 endif
7ee61e56eaed Periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13705 diff changeset	169
8117 40aa36406a94 Fix for display_range in imshow Kris Thielemans parents: 7931 diff changeset	170 ## Set default display range if display_range not set yet.
7328 d0784e593d39 [project @ 2007-12-20 07:24:02 by jwe] jwe parents: 7321 diff changeset	171 if (isempty (display_range))
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	172 display_range = [min(im(:)), max(im(:))];
8117 40aa36406a94 Fix for display_range in imshow Kris Thielemans parents: 7931 diff changeset	173 elseif (isna (display_range))
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	174 t = class (im);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	175 switch (t)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	176 case {"double", "single", "logical"}
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	177 display_range = [0, 1];
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	178 case {"uint8", "uint16", "int16"}
11597 a066673566da set clim to [0,1] so that scaled cdatamapping works as intended. Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11595 diff changeset	179 display_range = [intmin(t), intmax(t)];
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	180 otherwise
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10286 diff changeset	181 error ("imshow: invalid data type for image");
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	182 endswitch
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	183 endif
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	184
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	185 if (isfloat (im))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	186 nans = isnan (im(:));
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	187 if (any (nans))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	188 warning ("Octave:imshow-NaN",
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	189 "imshow: pixels with NaN or NA values are set to minimum pixel value");
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	190 im(nans) = display_range(1);
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	191 endif
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	192 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	193
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	194 ## FIXME: Commented out 2014/05/01. imagesc and 'clim' will automatically
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	195 ## take care of displaying out-of-range data clamped to the limits.
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	196 ## Eventually, this can be deleted if no problems arise.
11597 a066673566da set clim to [0,1] so that scaled cdatamapping works as intended. Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11595 diff changeset	197 ## Clamp the image to the range boundaries
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	198 ##if (! (truecolor \|\| indexed \|\| islogical (im)))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	199 ## low = display_range(1);
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	200 ## high = display_range(2);
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	201 ## im(im < low) = low;
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	202 ## im(im > high) = high;
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	203 ##endif
6368 ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe] jwe parents: 6310 diff changeset	204
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	205 if (truecolor \|\| indexed)
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	206 htmp = image (xdata, ydata, im);
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	207 else
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	208 htmp = imagesc (xdata, ydata, im, display_range);
11597 a066673566da set clim to [0,1] so that scaled cdatamapping works as intended. Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11595 diff changeset	209 set (gca (), "clim", display_range);
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	210 endif
18753 b1f092e1a887 imshow.m: Ignore hold state and set axis variables for image display for Matlab compatibility. Rik <rik@octave.org> parents: 18748 diff changeset	211 set (gca (), "visible", "off", "view", [0, 90], "ydir", "reverse", "layer", "top");
7511 f028e7aa77a7 imshow.m: use axis ("image") John W. Eaton <jwe@octave.org> parents: 7331 diff changeset	212 axis ("image");
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	213
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	214 if (nargout > 0)
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	215 h = htmp;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	216 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	217
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	218 endfunction
4836 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	219
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	220
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	221 %!demo
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	222 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	223 %! imshow ("default.img");
4836 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	224
518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	225 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	226 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	227 %! imshow ("default.img");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	228 %! colormap (autumn (64));
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	229
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	230 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	231 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	232 %! [I, M] = imread ("default.img");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	233 %! imshow (I, M);
4836 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	234
518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	235 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	236 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	237 %! [I, M] = imread ("default.img");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	238 %! [R, G, B] = ind2rgb (I, M);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	239 %! imshow (cat (3, R, G0.5, B0.8));
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	240
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	241 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	242 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	243 %! imshow (rand (100, 100));
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	244
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	245 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	246 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	247 %! imshow (rand (100, 100, 3));
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	248
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	249 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	250 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	251 %! imshow (100*rand (100, 100, 3));
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	252
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	253 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	254 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	255 %! imshow (rand (100, 100));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	256 %! colormap (jet (64));
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	257
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	258 %% Test input validation
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	259 %!error imshow ()
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	260 %!error <IM must be an image> imshow ({"cell"})
18747 0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	261 %!error <TrueColor image must be uint8> imshow (ones (3,3,3, "uint32"))
0585787aa8ae imshow.m: Overhaul function and support integer images (bug #41240). Rik <rik@octave.org> parents: 18746 diff changeset	262 %!error <TrueColor image must be uint8> imshow (ones (3,3,3, "int16"))
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	263 %!error <expecting MxN or MxNx3 matrix> imshow (ones (4,4,4))
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	264
18773 0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	265 %!test
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	266 %! hf = figure ("visible", "off");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	267 %! unwind_protect
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	268 %! fail ("imshow ([1,1], [2 0 0])", "invalid colormap MAP");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	269 %! fail ("imshow ([1,1], [1 0 0 0])", "argument number 2 is invalid");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	270 %! fail ('imshow ([1,1], "colormap", [2 0 0])', "invalid colormap");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	271 %! fail ('imshow ([1,1], "xdata", ones (2,2))', "xdata must be a vector");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	272 %! fail ('imshow ([1,1], "ydata", ones (2,2))', "ydata must be a vector");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	273 %! fail ('imshow ([1,1], "foobar")', "warning", "unrecognized property foobar")
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	274 %! fail ("imshow ([1,1], {1})", "argument number 2 is invalid");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	275 %! fail ("imshow ([1+i,1-i])", "warning", "only showing real part of complex image");
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	276 %! unwind_protect_cleanup
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	277 %! close (hf);
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	278 %! end_unwind_protect
0461fe1d2a01 imshow.m: Don't popup blank figure during 'make check' Rik <rik@octave.org> parents: 18753 diff changeset	279

Mercurial > octave-nkf

annotate scripts/image/imshow.m @ 19630:0e1f5a750d00