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

annotate scripts/image/imshow.m @ 17281:bc924baa2c4e

doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.

author	Rik <rik@octave.org>
date	Mon, 19 Aug 2013 20:46:38 -0700
parents	8e2a6fc55787
children	64ad713b3a64

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 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.
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	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 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5443 diff changeset	51 ## @seealso{image, imagesc, colormap, gray2ind, rgb2ind}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	52 ## @end deftypefn
904 3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe] jwe parents: 559 diff changeset	53
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	54 ## 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	55 ## Author: Soren Hauberg <hauberg at gmail dot com>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	56 ## Adapted-By: jwe
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	57
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	58 function h = imshow (im, varargin)
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	59
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	60 if (nargin == 0)
8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	61 print_usage ();
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	62 endif
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	63
7328 d0784e593d39 [project @ 2007-12-20 07:24:02 by jwe] jwe parents: 7321 diff changeset	64 display_range = NA;
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	65 true_color = false;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	66 indexed = false;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	67
5935 01ff100fcd64 [project @ 2006-08-17 20:40:58 by jwe] jwe parents: 5934 diff changeset	68 ## Get the image.
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	71 indexed = true;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	72 colormap (map);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	73 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	79 endif
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	80
10286 8cf666139297 imshow for logical matrices John W. Eaton <jwe@octave.org> parents: 9273 diff changeset	81 if (nd == 2)
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	82 if (! indexed)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	83 colormap (gray ());
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	84 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	85 elseif (size (im, 3) == 3)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	86 if (ismember (class (im), {"uint8", "uint16", "double", "single"}))
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	87 true_color = true;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	88 else
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	89 error ("imshow: color image must be uint8, uint16, double, or single");
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 else
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	92 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	93 endif
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	94
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	95 narg = 1;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	96 while (narg <= numel (varargin))
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	97 arg = varargin{narg++};
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	98 if (isnumeric (arg))
7331 3ed85de5922c [project @ 2007-12-21 17:40:20 by jwe] jwe parents: 7328 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	106 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	107 elseif (ischar (arg))
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	116 endswitch
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	117 else
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	118 error ("imshow: argument number %d is invalid", narg+1);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	119 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	120 endwhile
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 40aa36406a94 Fix for display_range in imshow Kris Thielemans parents: 7931 diff changeset	128 ## 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	129 if (isempty (display_range))
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	130 display_range = [min(im(:)), max(im(:))];
8117 40aa36406a94 Fix for display_range in imshow Kris Thielemans parents: 7931 diff changeset	131 elseif (isna (display_range))
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	132 t = class (im);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	133 switch (t)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	140 endswitch
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	141 endif
5934 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	142
6219 ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	143 nans = isnan (im(:));
ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	144 if (any (nans))
ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	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 ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	147 im(nans) = display_range(1);
ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	148 endif
ba9db82d85a8 [project @ 2006-12-27 17:53:34 by jwe] jwe parents: 6157 diff changeset	149
7074 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	152 im = double (im);
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	153 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 3ceb12c499e9 [project @ 2007-12-13 21:35:36 by jwe] jwe parents: 7074 diff changeset	156 if (! (true_color \|\| indexed \|\| islogical (im)))
7328 d0784e593d39 [project @ 2007-12-20 07:24:02 by jwe] jwe parents: 7321 diff changeset	157 low = display_range(1);
d0784e593d39 [project @ 2007-12-20 07:24:02 by jwe] jwe parents: 7321 diff changeset	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 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	161 endif
6368 ec2a523713b5 [project @ 2007-02-28 22:07:24 by jwe] jwe parents: 6310 diff changeset	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 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	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 8702f00329bf [project @ 2006-08-17 20:29:51 by jwe] jwe parents: 5642 diff changeset	170 endif
11324 e773d57de572 imshow.m: Flip y-axis. Ben Abbott <bpabbott@mac.com> parents: 10793 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	173
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	174 if (nargout > 0)
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	175 h = tmp;
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	176 endif
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	177
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	178 endfunction
4836 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	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 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	184
518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	189
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	194
518e495e489f [project @ 2004-03-12 18:16:03 by jwe] jwe parents: 3457 diff changeset	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, G0.5, B0.8));
5318 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	200
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	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 9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	204
9a72639b62a7 [project @ 2005-04-28 18:44:27 by jwe] jwe parents: 5307 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	208
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	212
87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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 87151f298e6a [project @ 2007-10-26 17:57:34 by jwe] jwe parents: 7017 diff changeset	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

Mercurial > octave-nkf

annotate scripts/image/imshow.m @ 17281:bc924baa2c4e