Mercurial > octave-nkf
annotate scripts/image/imshow.m @ 13705:2da28f71de80
Undo accidental change in 13704:6f779cc391fb
author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
---|---|
date | Fri, 14 Oct 2011 17:33:20 -0500 |
parents | 6f779cc391fb |
children | 7ee61e56eaed |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 1994-2011 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 | 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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 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 | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
1024 | 18 |
3381 | 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 | 21 ## @deftypefnx {Function File} {} imshow (@var{im}, @var{limits}) |
22 ## @deftypefnx {Function File} {} imshow (@var{im}, @var{map}) | |
7074 | 23 ## @deftypefnx {Function File} {} imshow (@var{rgb}, @dots{}) |
5934 | 24 ## @deftypefnx {Function File} {} imshow (@var{filename}) |
6309 | 25 ## @deftypefnx {Function File} {} imshow (@dots{}, @var{string_param1}, @var{value1}, @dots{}) |
6368 | 26 ## Display the image @var{im}, where @var{im} can be a 2-dimensional |
7074 | 27 ## (gray-scale image) or a 3-dimensional (RGB image) matrix. |
5934 | 28 ## |
29 ## If @var{limits} is a 2-element vector @code{[@var{low}, @var{high}]}, | |
30 ## the image is shown using a display range between @var{low} and | |
31 ## @var{high}. If an empty matrix is passed for @var{limits}, the | |
32 ## display range is computed as the range between the minimal and the | |
33 ## maximal value in the image. | |
3426 | 34 ## |
5934 | 35 ## If @var{map} is a valid color map, the image will be shown as an indexed |
36 ## image using the supplied color map. | |
37 ## | |
38 ## If a file name is given instead of an image, the file will be read and | |
39 ## shown. | |
3426 | 40 ## |
5934 | 41 ## 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
|
42 ## @var{value1}. @var{string_param1} can be any of the following: |
11595
5ec6aa05638d
Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
43 ## @table @asis |
6368 | 44 ## @item "displayrange" |
5934 | 45 ## @var{value1} is the display range as described above. |
46 ## @end table | |
5642 | 47 ## @seealso{image, imagesc, colormap, gray2ind, rgb2ind} |
3373 | 48 ## @end deftypefn |
904 | 49 |
7074 | 50 ## Author: Stefan van der Walt <stefan@sun.ac.za> |
5934 | 51 ## Author: Soren Hauberg <hauberg at gmail dot com> |
2312 | 52 ## Adapted-By: jwe |
559 | 53 |
7074 | 54 function h = imshow (im, varargin) |
559 | 55 |
5934 | 56 if (nargin == 0) |
57 print_usage (); | |
5318 | 58 endif |
59 | |
7328 | 60 display_range = NA; |
7074 | 61 true_color = false; |
62 indexed = false; | |
63 | |
5935 | 64 ## Get the image. |
5934 | 65 if (ischar (im)) |
7931
de26beacb20f
imread.m: simplify; loadimage.m: deprecate
John W. Eaton <jwe@octave.org>
parents:
7930
diff
changeset
|
66 [im, map] = imread (im); |
7074 | 67 indexed = true; |
68 colormap (map); | |
69 endif | |
70 | |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
71 nd = ndims (im); |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
72 |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
73 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
|
74 error ("imshow: IM must be an image or the filename of an image"); |
5318 | 75 endif |
7074 | 76 |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
77 if (nd == 2) |
7074 | 78 if (! indexed) |
79 colormap (gray ()); | |
80 endif | |
81 elseif (size (im, 3) == 3) | |
82 if (ismember (class (im), {"uint8", "uint16", "double", "single"})) | |
83 true_color = true; | |
84 else | |
85 error ("imshow: color image must be uint8, uint16, double, or single"); | |
86 endif | |
87 else | |
88 error ("imshow: expecting MxN or MxNx3 matrix for image"); | |
5318 | 89 endif |
90 | |
7074 | 91 narg = 1; |
92 while (narg <= numel (varargin)) | |
93 arg = varargin{narg++}; | |
94 if (isnumeric (arg)) | |
7331 | 95 if (numel (arg) == 2 || isempty (arg)) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
96 display_range = arg; |
7074 | 97 elseif (columns (arg) == 3) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
98 indexed = true; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
99 colormap (arg); |
7074 | 100 elseif (! isempty (arg)) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
101 error ("imshow: argument number %d is invalid", narg+1); |
7074 | 102 endif |
103 elseif (ischar (arg)) | |
104 switch (arg) | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
105 case "displayrange"; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
106 display_range = varargin{narg++}; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
107 case {"truesize", "initialmagnification"} |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
108 warning ("image: zoom argument ignored -- use GUI features"); |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
109 otherwise |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
110 warning ("imshow: unrecognized property %s", arg); |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
111 narg++; |
7074 | 112 endswitch |
113 else | |
114 error ("imshow: argument number %d is invalid", narg+1); | |
115 endif | |
116 endwhile | |
117 | |
8117 | 118 ## Set default display range if display_range not set yet. |
7328 | 119 if (isempty (display_range)) |
7074 | 120 display_range = [min(im(:)), max(im(:))]; |
8117 | 121 elseif (isna (display_range)) |
7074 | 122 t = class (im); |
123 switch (t) | |
124 case {"double", "single", "logical"} | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
125 display_range = [0, 1]; |
7074 | 126 case {"int8", "int16", "int32", "uint8", "uint16", "uint32"} |
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
|
127 display_range = [intmin(t), intmax(t)]; |
7074 | 128 otherwise |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
129 error ("imshow: invalid data type for image"); |
7074 | 130 endswitch |
131 endif | |
5934 | 132 |
13705
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
133 ## Check for complex images. |
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
134 if (iscomplex (im)) |
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
135 warning ("imshow: only showing real part of complex image"); |
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
136 im = real (im); |
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
137 endif |
2da28f71de80
Undo accidental change in 13704:6f779cc391fb
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13704
diff
changeset
|
138 |
6219 | 139 nans = isnan (im(:)); |
140 if (any (nans)) | |
141 warning ("Octave:imshow-NaN", | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
142 "imshow: pixels with NaN or NA values are set to minimum pixel value"); |
6219 | 143 im(nans) = display_range(1); |
144 endif | |
145 | |
7074 | 146 ## This is for compatibility. |
7930
1f6eb3de1c4e
__img__.m, imshow.m, __go_draw_axes__.m: improve handling of truecolor images
John W. Eaton <jwe@octave.org>
parents:
7511
diff
changeset
|
147 if (! (indexed || (true_color && isinteger (im))) || islogical (im)) |
7074 | 148 im = double (im); |
149 endif | |
150 | |
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
|
151 ## Clamp the image to the range boundaries |
7315 | 152 if (! (true_color || indexed || islogical (im))) |
7328 | 153 low = display_range(1); |
154 high = display_range(2); | |
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
|
155 im(im < low) = low; |
a066673566da
set clim to [0,1] so that scaled cdatamapping works as intended.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11595
diff
changeset
|
156 im(im > high) = high; |
4836 | 157 endif |
6368 | 158 |
9269
06518194dba0
fix displaying indexed images
Jaroslav Hajek <highegg@gmail.com>
parents:
9245
diff
changeset
|
159 if (true_color || indexed) |
06518194dba0
fix displaying indexed images
Jaroslav Hajek <highegg@gmail.com>
parents:
9245
diff
changeset
|
160 tmp = image ([], [], im); |
5934 | 161 else |
10648
bc4eb29e0cb4
Scale image point color according to colormap. Bug #29926.
Rik <octave@nomad.inbox5.com>
parents:
10433
diff
changeset
|
162 tmp = image (im); |
bc4eb29e0cb4
Scale image point color according to colormap. Bug #29926.
Rik <octave@nomad.inbox5.com>
parents:
10433
diff
changeset
|
163 set (tmp, "cdatamapping", "scaled"); |
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
|
164 ## The backend is responsible for scaling to clim if necessary. |
a066673566da
set clim to [0,1] so that scaled cdatamapping works as intended.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11595
diff
changeset
|
165 set (gca (), "clim", display_range); |
5934 | 166 endif |
11324 | 167 set (gca (), "visible", "off", "ydir", "reverse"); |
7511
f028e7aa77a7
imshow.m: use axis ("image")
John W. Eaton <jwe@octave.org>
parents:
7331
diff
changeset
|
168 axis ("image"); |
7074 | 169 |
170 if (nargout > 0) | |
171 h = tmp; | |
172 endif | |
173 | |
559 | 174 endfunction |
4836 | 175 |
176 %!error imshow () # no arguments | |
5934 | 177 %!error imshow ({"cell"}) # No image or filename given |
178 %!error imshow (ones(4,4,4)) # Too many dimensions in image | |
4836 | 179 |
180 %!demo | |
7074 | 181 %! imshow ("default.img"); |
182 | |
183 %!demo | |
184 %! imshow ("default.img"); | |
185 %! colormap ("autumn"); | |
4836 | 186 |
187 %!demo | |
9273 | 188 %! [I, M] = imread ("default.img"); |
5318 | 189 %! imshow (I, M); |
190 | |
191 %!demo | |
9273 | 192 %! [I, M] = imread ("default.img"); |
193 %! [R, G, B] = ind2rgb (I, M); | |
194 %! imshow (cat(3, R, G*0.5, B*0.8)); | |
5318 | 195 |
196 %!demo | |
7074 | 197 %! imshow (rand (100, 100)); |
198 | |
199 %!demo | |
200 %! imshow (rand (100, 100, 3)); | |
201 | |
202 %!demo | |
203 %! imshow (100*rand (100, 100, 3)); | |
204 | |
205 %!demo | |
206 %! imshow (rand (100, 100)); | |
207 %! colormap (jet); |