annotate scripts/image/imshow.m @ 4914:1c0442da75fd

[project @ 2004-07-23 16:55:13 by jwe]
author jwe
date Fri, 23 Jul 2004 16:55:13 +0000
parents 048db020498c
children 4c8a2e4e0717
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2313
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
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
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ## any later version.
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
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
18 ## 02111-1307, USA.
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 -*-
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
21 ## @deftypefn {Function File} {} imshow (@var{i})
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
22 ## @deftypefnx {Function File} {} imshow (@var{x}, @var{map})
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
23 ## @deftypefnx {Function File} {} imshow (@var{x}, @var{n})
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
24 ## @deftypefnx {Function File} {} imshow (@var{i}, @var{n})
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
25 ## @deftypefnx {Function File} {} imshow (@var{r}, @var{g}, @var{b})
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
26 ## Display an image.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
27 ##
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
28 ## @code{imshow (@var{x})} displays an intensity image, estimating the
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
29 ## number of gray levels.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
30 ##
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
31 ## @code{imshow (@var{x}, @var{map})} displays an indexed image using the
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
32 ## specified colormap.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
33 ##
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
34 ## @code{imshow (@var{i}, @var{N})} displays a gray scale intensity image of
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
35 ## N levels.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3381
diff changeset
36 ##
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
37 ## @code{imshow (@var{r}, @var{g}, @var{b})} displays an RGB image.
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
38 ##
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
39 ## The string @code{truesize} can always be used as an optional
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
40 ## final argument to prevent automatic zooming of the image.
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
41 ## @end deftypefn
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
42 ##
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3426
diff changeset
43 ## @seealso{image, imagesc, colormap, gray2ind, and rgb2ind}
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 559
diff changeset
44
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 2847
diff changeset
45 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
46 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
47 ## Adapted-By: jwe
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
48
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
49 function imshow (varargin)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
50
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
51 usage_str = "imshow (x) or imshow (x, map) or imshow (i, N) or imshow (r, g, b)";
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
52
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
53 if (nargin == 0 || nargin > 4)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
54 usage (usage_str);
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
55 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
56
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
57 ## Count nr of matrix arguments.
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
58 mvars = 0;
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
59 while (mvars < nargin && ismatrix (varargin{mvars+1}))
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
60 mvars++;
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
61 endwhile
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
62
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
63 if (mvars < 1 || mvars > 3)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
64 usage (usage_str);
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
65 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
66
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
67 ## All except imshow (r, g, b)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
68
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
69 if (mvars != 3)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
70 I = varargin{1};
4912
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
71 if (iscomplex (I))
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4912
diff changeset
72 warning ("imshow: displaying real part of complex image");
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4912
diff changeset
73 I = real (I);
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
74 endif
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
75 if (max (I(:)) <= 1)
4912
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
76 ## image in [0-1]; scale to [0-255]
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
77 I = I * 255;
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
78 M = gray (256);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
79 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
80 endif
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
81
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
82 if (mvars == 1)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
83 ## imshow (x)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
84 ## Grayscale image [0-N] -- estimate gray levels.
4912
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
85 N = 2 ^ ceil (log2 (max (I(:))));
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
86 if (N <= 65536)
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
87 M = gray (N);
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
88 else
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
89 M = gray (256);
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
90 I = I / max (I(:)) * 255;
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
91 endif
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
92 elseif (mvars == 2)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
93 ## imshow (x, map) or imshow (x, N)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
94 M = varargin{2};
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
95 if (isscalar (M))
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
96 M = gray (M);
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
97 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
98 elseif (mvars == 3)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
99 ## imshow (r, g, b)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
100 r = varargin{1};
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
101 g = varargin{2};
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
102 b = varargin{3};
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
103 tmp = [r; g; b];
4912
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
104 if (iscomplex (tmp))
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
105 warning ("imshow: displaying real part of complex rgb image");
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
106 r = real (r);
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
107 g = real (g);
048db020498c [project @ 2004-07-22 20:45:59 by jwe]
jwe
parents: 4911
diff changeset
108 b = real (b);
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4836
diff changeset
109 endif
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
110 if (max (tmp(:)) > 1)
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
111 ## Normalise to [0-1].
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4912
diff changeset
112 r = r / 255;
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4912
diff changeset
113 g = g / 255;
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4912
diff changeset
114 b = b / 255;
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
115 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
116 [I, M] = rgb2ind (r, g, b);
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
117 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
118
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
119 ## Check for "truesize".
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
120 zoom = [];
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
121 for i = mvars+1:nargin
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
122 if (isstr (varargin{i}) && strcmp (varargin{i}, "truesize"))
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
123 zoom = 1;
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
124 endif
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
125 endfor
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
126
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
127 colormap (M);
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
128 image (I, zoom);
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
129
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
130 endfunction
4836
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
131
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
132 %!error imshow () # no arguments
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
133 %!error imshow (1, 2, 3, 4, 5) # too many arguments
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
134 %!error imshow ([1,2], [2,3], [3,4], [4,5]) # too many matrix arguments
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
135 %!error imshow ("image.png") # filename not accepted as argument
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
136
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
137 %!demo
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
138 %! imshow (loadimage ("default.img"));
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
139
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
140 %!demo
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
141 %! I = loadimage ("default.img");
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
142 %! imshow (I, "truesize")
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
143
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
144 %!demo
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
145 %! [I, M] = loadimage ("default.img");
518e495e489f [project @ 2004-03-12 18:16:03 by jwe]
jwe
parents: 3457
diff changeset
146 %! imshow(I, M);