Mercurial > octave
annotate scripts/image/imshow.m @ 25054:6652d3823428 stable
maint: Update copyright dates in all source files.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 30 Mar 2018 09:19:05 -0400 |
parents | 194eb4bd202b |
children | 9578af67a0d4 |
rev | line source |
---|---|
25054
6652d3823428
maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents:
24534
diff
changeset
|
1 ## Copyright (C) 1994-2018 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 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24057
diff
changeset
|
5 ## Octave is free software: you can redistribute it and/or modify it |
2313 | 6 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24057
diff
changeset
|
7 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22392
diff
changeset
|
8 ## (at 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 | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22392
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22392
diff
changeset
|
13 ## GNU General Public License for more details. |
2313 | 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 |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24057
diff
changeset
|
17 ## <https://www.gnu.org/licenses/>. |
1024 | 18 |
3381 | 19 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
20 ## @deftypefn {} {} imshow (@var{im}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
21 ## @deftypefnx {} {} imshow (@var{im}, @var{limits}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
22 ## @deftypefnx {} {} imshow (@var{im}, @var{map}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
23 ## @deftypefnx {} {} imshow (@var{rgb}, @dots{}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
24 ## @deftypefnx {} {} imshow (@var{filename}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
25 ## @deftypefnx {} {} imshow (@dots{}, @var{string_param1}, @var{value1}, @dots{}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20735
diff
changeset
|
26 ## @deftypefnx {} {@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 ## |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
30 ## If @var{limits} is a 2-element vector @code{[@var{low}, @var{high}]}, the |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
31 ## image is shown using a display range between @var{low} and @var{high}. If |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
32 ## an empty matrix is passed for @var{limits}, the display range is computed |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
33 ## as the range between the minimal and the 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 ## | |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
38 ## If a filename is given instead of an image, the file will be read and shown. |
3426 | 39 ## |
20181
aa36fb998a4d
maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
40 ## If given, the parameter @var{string_param1} has value @var{value1}. |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
41 ## @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
|
42 ## |
11595
5ec6aa05638d
Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
43 ## @table @asis |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14897
diff
changeset
|
44 ## @item @qcode{"displayrange"} |
5934 | 45 ## @var{value1} is the display range as described above. |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18546
diff
changeset
|
46 ## |
18714
c79696701468
doc: Document new 'colormap' parameter to imshow.
Rik <rik@octave.org>
parents:
18713
diff
changeset
|
47 ## @item @qcode{"colormap"} |
c79696701468
doc: Document new 'colormap' parameter to imshow.
Rik <rik@octave.org>
parents:
18713
diff
changeset
|
48 ## @var{value1} is the colormap to use when displaying an indexed image. |
19596
0e1f5a750d00
maint: Periodic merge of gui-release to default.
John W. Eaton <jwe@octave.org>
diff
changeset
|
49 ## |
17753
887df64e54e4
doc: Final grammarcheck of docstrings for 3.8 release.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
50 ## @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
|
51 ## If @var{value1} is a two element vector, it must contain horizontal axis |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
52 ## limits in the form [xmin xmax]; Otherwise @var{value1} must be a vector and |
21546
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21385
diff
changeset
|
53 ## only the first and last elements will be used for xmin and xmax |
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21385
diff
changeset
|
54 ## respectively. |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18546
diff
changeset
|
55 ## |
17753
887df64e54e4
doc: Final grammarcheck of docstrings for 3.8 release.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
56 ## @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
|
57 ## If @var{value1} is a two element vector, it must contain vertical axis |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
58 ## limits in the form [ymin ymax]; Otherwise @var{value1} must be a vector and |
21546
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21385
diff
changeset
|
59 ## only the first and last elements will be used for ymin and ymax |
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21385
diff
changeset
|
60 ## respectively. |
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
|
61 ## |
5934 | 62 ## @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
|
63 ## |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13738
diff
changeset
|
64 ## The optional return value @var{h} is a graphics handle to the image. |
5642 | 65 ## @seealso{image, imagesc, colormap, gray2ind, rgb2ind} |
3373 | 66 ## @end deftypefn |
904 | 67 |
7074 | 68 ## Author: Stefan van der Walt <stefan@sun.ac.za> |
5934 | 69 ## Author: Soren Hauberg <hauberg at gmail dot com> |
2312 | 70 ## Adapted-By: jwe |
559 | 71 |
7074 | 72 function h = imshow (im, varargin) |
559 | 73 |
5934 | 74 if (nargin == 0) |
75 print_usage (); | |
5318 | 76 endif |
77 | |
7328 | 78 display_range = NA; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
79 truecolor = false; |
7074 | 80 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
|
81 xdata = ydata = []; |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
82 prop_val_args = {}; |
7074 | 83 |
5935 | 84 ## Get the image. |
5934 | 85 if (ischar (im)) |
7931
de26beacb20f
imread.m: simplify; loadimage.m: deprecate
John W. Eaton <jwe@octave.org>
parents:
7930
diff
changeset
|
86 [im, map] = imread (im); |
7074 | 87 indexed = true; |
23524
7c278572db66
Implement colormap property for axes objects (bug #48667).
Markus Muetzel <markus.muetzel@gmx.de>
parents:
23220
diff
changeset
|
88 colormap (gca, map); |
7074 | 89 endif |
90 | |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
91 nd = ndims (im); |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
92 |
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
93 if (! ((isnumeric (im) || islogical (im)) && (nd == 2 || nd == 3))) |
22760
c4d80b9d2898
maint: Capitalize variable names appearing in error() messages of m-files.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
94 error ("imshow: IM must be an image or the FILENAME of an image"); |
5318 | 95 endif |
7074 | 96 |
10286
8cf666139297
imshow for logical matrices
John W. Eaton <jwe@octave.org>
parents:
9273
diff
changeset
|
97 if (nd == 2) |
7074 | 98 if (! indexed) |
23524
7c278572db66
Implement colormap property for axes objects (bug #48667).
Markus Muetzel <markus.muetzel@gmx.de>
parents:
23220
diff
changeset
|
99 colormap (gca, gray ()); |
7074 | 100 endif |
101 elseif (size (im, 3) == 3) | |
102 if (ismember (class (im), {"uint8", "uint16", "double", "single"})) | |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
103 truecolor = true; |
7074 | 104 else |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
105 error ("imshow: TrueColor image must be uint8, uint16, double, or single"); |
7074 | 106 endif |
107 else | |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20357
diff
changeset
|
108 error ("imshow: image must be MxN or MxNx3 matrix"); |
5318 | 109 endif |
110 | |
7074 | 111 narg = 1; |
112 while (narg <= numel (varargin)) | |
113 arg = varargin{narg++}; | |
114 if (isnumeric (arg)) | |
7331 | 115 if (numel (arg) == 2 || isempty (arg)) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
116 display_range = arg; |
7074 | 117 elseif (columns (arg) == 3) |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
118 indexed = true; |
20357
a3bf503652b2
iscolormap: relax input check - specially in [0 1] range.
Carnë Draug <carandraug@octave.org>
parents:
20302
diff
changeset
|
119 if (iscolormap (arg) && min (arg) >= 0 || max (arg) <= 1) |
23524
7c278572db66
Implement colormap property for axes objects (bug #48667).
Markus Muetzel <markus.muetzel@gmx.de>
parents:
23220
diff
changeset
|
120 colormap (gca, arg); |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
121 else |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
122 error ("imshow: invalid colormap MAP"); |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
123 endif |
7074 | 124 elseif (! isempty (arg)) |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
125 error ("imshow: argument number %d is invalid", narg); |
7074 | 126 endif |
127 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
|
128 switch (tolower (arg)) |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
129 case "border" |
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
130 warning ("imshow: border argument is not implemented"); |
20735
418ae0cb752f
Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
131 narg += 1; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
132 case "colormap" |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
133 map = varargin{narg++}; |
20357
a3bf503652b2
iscolormap: relax input check - specially in [0 1] range.
Carnë Draug <carandraug@octave.org>
parents:
20302
diff
changeset
|
134 if (iscolormap (map) && min (map) >= 0 || max (map) <= 1) |
23524
7c278572db66
Implement colormap property for axes objects (bug #48667).
Markus Muetzel <markus.muetzel@gmx.de>
parents:
23220
diff
changeset
|
135 colormap (gca, map); |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
136 else |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
137 error ("imshow: invalid colormap"); |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
138 endif |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
139 case "displayrange" |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
140 display_range = varargin{narg++}; |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
141 case {"initialmagnification"} |
20302
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
142 warning ("imshow: zoom argument ignored -- use GUI features"); |
20735
418ae0cb752f
Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
143 narg += 1; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
144 case "parent" |
20715
5b7643257978
Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents:
20713
diff
changeset
|
145 prop_val_args(end+(1:2)) = {"parent", varargin{narg++}}; |
20302
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
146 if (! isaxes (prop_val_args{end})) |
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
147 error ("imshow: parent must be an axes handle"); |
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
148 endif |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
149 case "reduce" |
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
150 warning ("imshow: reduce argument is not implemented"); |
20735
418ae0cb752f
Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
151 narg += 1; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
152 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
|
153 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
|
154 if (! isvector (xdata)) |
21385
89fa0694aa2e
Fix check-missing-semicolon QA target (bug #47277).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
155 error ("imshow: xdata 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
|
156 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
|
157 xdata = [xdata(1) xdata(end)]; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
158 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
|
159 ydata = varargin{narg++}; |
18546
8e384416ebb3
imshow.m: Fix bad input validation of ydata (bug #41773).
Rik <rik@octave.org>
parents:
17753
diff
changeset
|
160 if (! isvector (ydata)) |
21385
89fa0694aa2e
Fix check-missing-semicolon QA target (bug #47277).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
161 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
|
162 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
|
163 ydata = [ydata(1) ydata(end)]; |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
164 otherwise |
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
165 warning ("imshow: unrecognized property %s", arg); |
20735
418ae0cb752f
Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
166 narg += 1; |
7074 | 167 endswitch |
168 else | |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
169 error ("imshow: argument number %d is invalid", narg); |
7074 | 170 endif |
171 endwhile | |
172 | |
13738
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
173 ## Check for complex images. |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
174 if (iscomplex (im)) |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
175 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
|
176 im = real (im); |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
177 endif |
7ee61e56eaed
Periodic merge of stable to default
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13705
diff
changeset
|
178 |
8117 | 179 ## Set default display range if display_range not set yet. |
7328 | 180 if (isempty (display_range)) |
24056
ae35d50d9756
Ensure numeric values are passed for the axes "clim" property (bug #52053).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
23219
diff
changeset
|
181 display_range = double ([min(im(:)), max(im(:))]); |
8117 | 182 elseif (isna (display_range)) |
7074 | 183 t = class (im); |
184 switch (t) | |
185 case {"double", "single", "logical"} | |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
186 display_range = [0, 1]; |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
187 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
|
188 display_range = [intmin(t), intmax(t)]; |
7074 | 189 otherwise |
10433
2c01d24459fb
Detabify scripts in 'scripts/image/'
Soren Hauberg <hauberg@gmail.com>
parents:
10286
diff
changeset
|
190 error ("imshow: invalid data type for image"); |
7074 | 191 endswitch |
192 endif | |
5934 | 193 |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
194 if (isfloat (im)) |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
195 nans = isnan (im(:)); |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
196 if (any (nans)) |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
197 warning ("Octave:imshow-NaN", |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
198 "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:
18712
diff
changeset
|
199 im(nans) = display_range(1); |
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
200 endif |
7074 | 201 endif |
202 | |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
203 if (truecolor || indexed) |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
204 htmp = image (xdata, ydata, im, prop_val_args{:}); |
5934 | 205 else |
20301
eca5aa3225f4
imshow.m: Add support for 'parent' property (bug #45473).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
206 htmp = imagesc (xdata, ydata, im, display_range, prop_val_args{:}); |
20302
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
207 set (get (htmp, "parent"), "clim", display_range); |
5934 | 208 endif |
20302
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
209 set (get (htmp, "parent"), "visible", "off", "view", [0, 90], |
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
210 "ydir", "reverse", "layer", "top"); |
7511
f028e7aa77a7
imshow.m: use axis ("image")
John W. Eaton <jwe@octave.org>
parents:
7331
diff
changeset
|
211 axis ("image"); |
7074 | 212 |
213 if (nargout > 0) | |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
214 h = htmp; |
7074 | 215 endif |
216 | |
559 | 217 endfunction |
4836 | 218 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
219 |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
220 %!demo |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
221 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
222 %! imshow ("default.img"); |
4836 | 223 |
224 %!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
|
225 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
226 %! imshow ("default.img"); |
23931
b208e1a7dd02
imshow.m: fix colormap related demos (bug #51825)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
23524
diff
changeset
|
227 %! colormap (gca, autumn (64)); |
7074 | 228 |
229 %!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
|
230 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
231 %! [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
|
232 %! imshow (I, M); |
4836 | 233 |
234 %!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
|
235 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
236 %! [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
|
237 %! [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
|
238 %! imshow (cat (3, R, G*0.5, B*0.8)); |
5318 | 239 |
240 %!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
|
241 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
242 %! imshow (rand (100, 100)); |
22312
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
243 %! title ({"imshow with random 100x100 matrix", "black and white"}); |
7074 | 244 |
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)); |
23931
b208e1a7dd02
imshow.m: fix colormap related demos (bug #51825)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
23524
diff
changeset
|
248 %! colormap (gca, jet (64)); |
22314
a1840b139c37
dump_demos.m: Remove dummy assert function.
Rik <rik@octave.org>
parents:
22312
diff
changeset
|
249 %! title ({"imshow with random 100x100 matrix", "colormap() makes color image"}); |
22312
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
250 |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
251 %!demo |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
252 %! clf; |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
253 %! imshow (rand (100, 100, 3)); |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
254 %! title ({"imshow with random 100x100x3 matrix", "RGB color"}); |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
255 |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
256 %!demo |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
257 %! clf; |
533c3c4059a3
Add titles to more of the graphic demos.
Rik <rik@octave.org>
parents:
21580
diff
changeset
|
258 %! imshow (100*rand (100, 100, 3)); |
22392
4dfb28724863
Clip double RGB data before passing to gl2psDrawPixels (bug #48873).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
22323
diff
changeset
|
259 %! title ({"imshow with random 100x100x3 matrix", "RGB values > 1 are clipped"}); |
7074 | 260 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
261 ## Test input validation |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
262 %!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
|
263 %!error <IM must be an image> imshow ({"cell"}) |
18713
0585787aa8ae
imshow.m: Overhaul function and support integer images (bug #41240).
Rik <rik@octave.org>
parents:
18712
diff
changeset
|
264 %!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:
18712
diff
changeset
|
265 %!error <TrueColor image must be uint8> imshow (ones (3,3,3, "int16")) |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20357
diff
changeset
|
266 %!error <image must be MxN or MxNx3 matrix> imshow (ones (4,4,4)) |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
267 |
18739
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
268 %!test |
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
269 %! hf = figure ("visible", "off"); |
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
270 %! unwind_protect |
20357
a3bf503652b2
iscolormap: relax input check - specially in [0 1] range.
Carnë Draug <carandraug@octave.org>
parents:
20302
diff
changeset
|
271 %! fail ("imshow ([1,1], [2 0 0])", "all MAP values must be in the range"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
272 %! fail ("imshow ([1,1], [1 0 0 0])", "argument number 2 is invalid"); |
20357
a3bf503652b2
iscolormap: relax input check - specially in [0 1] range.
Carnë Draug <carandraug@octave.org>
parents:
20302
diff
changeset
|
273 %! fail ('imshow ([1,1], "colormap", [2 0 0])', "all MAP values must be in the range"); |
20302
928e2c6f888e
imshow.m: Respect new 'parent' property when setting axis properties.
Rik <rik@octave.org>
parents:
20301
diff
changeset
|
274 %! fail ('imshow ([1,1], "parent", -1)', "must be an axes handle"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
275 %! fail ('imshow ([1,1], "xdata", ones (2,2))', "xdata must be a vector"); |
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
276 %! fail ('imshow ([1,1], "ydata", ones (2,2))', "ydata must be a vector"); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21546
diff
changeset
|
277 %! fail ('imshow ([1,1], "foobar")', "warning", "unrecognized property foobar"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
278 %! fail ("imshow ([1,1], {1})", "argument number 2 is invalid"); |
18739
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
279 %! 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:
18719
diff
changeset
|
280 %! unwind_protect_cleanup |
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
281 %! close (hf); |
0461fe1d2a01
imshow.m: Don't popup blank figure during 'make check'
Rik <rik@octave.org>
parents:
18719
diff
changeset
|
282 %! end_unwind_protect |