Mercurial > octave-antonio
annotate scripts/image/imshow.m @ 17170:d6499c14021c
doc: Periodic grammarcheck of documentation.
* doc/interpreter/basics.txi, doc/interpreter/expr.txi,
doc/interpreter/install.txi, doc/interpreter/java.txi,
doc/interpreter/plot.txi, doc/interpreter/sparse.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/load-save.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/pr-output.cc, libinterp/parse-tree/oct-parse.in.yy,
liboctave/numeric/LSODE-opts.in, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imwrite.m,
scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m,
scripts/miscellaneous/mex.m, scripts/miscellaneous/mkoctfile.m,
scripts/miscellaneous/warning_ids.m, scripts/prefs/prefdir.m,
scripts/prefs/preferences.m, scripts/signal/fftfilt.m,
scripts/strings/isstrprop.m, scripts/testfun/assert.m:
Periodic grammarcheck of documentation.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 04 Aug 2013 13:08:39 -0700 |
parents | 8e2a6fc55787 |
children | bc924baa2c4e |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14001
diff
changeset
|
1 ## Copyright (C) 1994-2012 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{}) |
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 | 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 | 29 ## |
30 ## If @var{limits} is a 2-element vector @code{[@var{low}, @var{high}]}, | |
31 ## the image is shown using a display range between @var{low} and | |
32 ## @var{high}. If an empty matrix is passed for @var{limits}, the | |
33 ## display range is computed as the range between the minimal and the | |
34 ## maximal value in the image. | |
3426 | 35 ## |
5934 | 36 ## If @var{map} is a valid color map, the image will be shown as an indexed |
37 ## image using the supplied color map. | |
38 ## | |
39 ## If a file name is given instead of an image, the file will be read and | |
40 ## shown. | |
3426 | 41 ## |
5934 | 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 |
6368 | 46 ## @item "displayrange" |
5934 | 47 ## @var{value1} is the display range as described above. |
48 ## @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
|
49 ## |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13738
diff
changeset
|
50 ## The optional return value @var{h} is a graphics handle to the image. |
5642 | 51 ## @seealso{image, imagesc, colormap, gray2ind, rgb2ind} |
3373 | 52 ## @end deftypefn |
904 | 53 |
7074 | 54 ## Author: Stefan van der Walt <stefan@sun.ac.za> |
5934 | 55 ## Author: Soren Hauberg <hauberg at gmail dot com> |
2312 | 56 ## Adapted-By: jwe |
559 | 57 |
7074 | 58 function h = imshow (im, varargin) |
559 | 59 |
5934 | 60 if (nargin == 0) |
61 print_usage (); | |
5318 | 62 endif |
63 | |
7328 | 64 display_range = NA; |
7074 | 65 true_color = false; |
66 indexed = false; | |
67 | |
5935 | 68 ## Get the image. |
5934 | 69 if (ischar (im)) |
7931
de26beacb20f
imread.m: simplify; loadimage.m: deprecate
John W. Eaton <jwe@octave.org>
parents:
7930
diff
changeset
|
70 [im, map] = imread (im); |
7074 | 71 indexed = true; |
72 colormap (map); | |
73 endif | |
74 | |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
75 nd = ndims (im); |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
76 |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
77 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
|
78 error ("imshow: IM must be an image or the filename of an image"); |
5318 | 79 endif |
7074 | 80 |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
81 if (nd == 2) |
7074 | 82 if (! indexed) |
83 colormap (gray ()); | |
84 endif | |
85 elseif (size (im, 3) == 3) | |
86 if (ismember (class (im), {"uint8", "uint16", "double", "single"})) | |
87 true_color = true; | |
88 else | |
89 error ("imshow: color image must be uint8, uint16, double, or single"); | |
90 endif | |
91 else | |
92 error ("imshow: expecting MxN or MxNx3 matrix for image"); | |
5318 | 93 endif |
94 | |
7074 | 95 narg = 1; |
96 while (narg <= numel (varargin)) | |
97 arg = varargin{narg++}; | |
98 if (isnumeric (arg)) | |
7331 | 99 if (numel (arg) == 2 || isempty (arg)) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
100 display_range = arg; |
7074 | 101 elseif (columns (arg) == 3) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
102 indexed = true; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
103 colormap (arg); |
7074 | 104 elseif (! isempty (arg)) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
105 error ("imshow: argument number %d is invalid", narg+1); |
7074 | 106 endif |
107 elseif (ischar (arg)) | |
108 switch (arg) | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
109 case "displayrange"; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
110 display_range = varargin{narg++}; |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
111 case {"truesize", "initialmagnification"} |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
112 warning ("image: zoom argument ignored -- use GUI features"); |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
113 otherwise |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
114 warning ("imshow: unrecognized property %s", arg); |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
115 narg++; |
7074 | 116 endswitch |
117 else | |
118 error ("imshow: argument number %d is invalid", narg+1); | |
119 endif | |
120 endwhile | |
121 | |
13738
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
122 ## Check for complex images. |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
123 if (iscomplex (im)) |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
124 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
|
125 im = real (im); |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
126 endif |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
127 |
8117 | 128 ## Set default display range if display_range not set yet. |
7328 | 129 if (isempty (display_range)) |
7074 | 130 display_range = [min(im(:)), max(im(:))]; |
8117 | 131 elseif (isna (display_range)) |
7074 | 132 t = class (im); |
133 switch (t) | |
134 case {"double", "single", "logical"} | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
135 display_range = [0, 1]; |
7074 | 136 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
|
137 display_range = [intmin(t), intmax(t)]; |
7074 | 138 otherwise |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
139 error ("imshow: invalid data type for image"); |
7074 | 140 endswitch |
141 endif | |
5934 | 142 |
6219 | 143 nans = isnan (im(:)); |
144 if (any (nans)) | |
145 warning ("Octave:imshow-NaN", | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
146 "imshow: pixels with NaN or NA values are set to minimum pixel value"); |
6219 | 147 im(nans) = display_range(1); |
148 endif | |
149 | |
7074 | 150 ## 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
|
151 if (! (indexed || (true_color && isinteger (im))) || islogical (im)) |
7074 | 152 im = double (im); |
153 endif | |
154 | |
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 ## Clamp the image to the range boundaries |
7315 | 156 if (! (true_color || indexed || islogical (im))) |
7328 | 157 low = display_range(1); |
158 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
|
159 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
|
160 im(im > high) = high; |
4836 | 161 endif |
6368 | 162 |
9269
06518194dba0
fix displaying indexed images
Jaroslav Hajek <highegg@gmail.com>
parents:
9245
diff
changeset
|
163 if (true_color || indexed) |
06518194dba0
fix displaying indexed images
Jaroslav Hajek <highegg@gmail.com>
parents:
9245
diff
changeset
|
164 tmp = image ([], [], im); |
5934 | 165 else |
10648
bc4eb29e0cb4
Scale image point color according to colormap. Bug #29926.
Rik <octave@nomad.inbox5.com>
parents:
10433
diff
changeset
|
166 tmp = image (im); |
bc4eb29e0cb4
Scale image point color according to colormap. Bug #29926.
Rik <octave@nomad.inbox5.com>
parents:
10433
diff
changeset
|
167 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
|
168 ## 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
|
169 set (gca (), "clim", display_range); |
5934 | 170 endif |
11324 | 171 set (gca (), "visible", "off", "ydir", "reverse"); |
7511
f028e7aa77a7
imshow.m: use axis ("image")
John W. Eaton <jwe@octave.org>
parents:
7331
diff
changeset
|
172 axis ("image"); |
7074 | 173 |
174 if (nargout > 0) | |
175 h = tmp; | |
176 endif | |
177 | |
559 | 178 endfunction |
4836 | 179 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
180 |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
181 %!demo |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
182 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
183 %! imshow ("default.img"); |
4836 | 184 |
185 %!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
|
186 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
187 %! 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
|
188 %! colormap (autumn (64)); |
7074 | 189 |
190 %!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
|
191 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
192 %! [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
|
193 %! imshow (I, M); |
4836 | 194 |
195 %!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
|
196 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
197 %! [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
|
198 %! [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
|
199 %! imshow (cat (3, R, G*0.5, B*0.8)); |
5318 | 200 |
201 %!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
|
202 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
203 %! imshow (rand (100, 100)); |
5318 | 204 |
205 %!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
|
206 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
207 %! imshow (rand (100, 100, 3)); |
7074 | 208 |
209 %!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
|
210 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
211 %! imshow (100*rand (100, 100, 3)); |
7074 | 212 |
213 %!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
|
214 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
215 %! 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
|
216 %! colormap (jet (64)); |
7074 | 217 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
218 %% 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
|
219 %!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
|
220 %!error <IM must be an image> imshow ({"cell"}) |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
221 %!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
|
222 |