annotate scripts/image/image.m @ 19627:446c46af4b42 stable

strip trailing whitespace from most source files * Makefile.am, NEWS, build-aux/common.mk, configure.ac, doc/Makefile.am, doc/doxyhtml/Makefile.am, doc/interpreter/Makefile.am, doc/interpreter/arith.txi, doc/interpreter/audio.txi, doc/interpreter/basics.txi, doc/interpreter/bugs.txi, doc/interpreter/container.txi, doc/interpreter/cp-idx.txi, doc/interpreter/data.txi, doc/interpreter/debug.txi, doc/interpreter/diagperm.txi, doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README, doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/fn-idx.txi, doc/interpreter/func.txi, doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m, doc/interpreter/gpl.txi, doc/interpreter/grammar.txi, doc/interpreter/gui.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/interpimages.m, doc/interpreter/intro.txi, doc/interpreter/io.txi, doc/interpreter/java.txi, doc/interpreter/linalg.txi, doc/interpreter/macros.texi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi, doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1, doc/interpreter/octave.texi, doc/interpreter/oop.txi, doc/interpreter/op-idx.txi, doc/interpreter/optim.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/poly.txi, doc/interpreter/preface.txi, doc/interpreter/quad.txi, doc/interpreter/set.txi, doc/interpreter/signal.txi, doc/interpreter/sparse.txi, doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m, doc/interpreter/stats.txi, doc/interpreter/stmt.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/testfun.txi, doc/interpreter/tips.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, doc/liboctave/Makefile.am, doc/liboctave/array.texi, doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi, doc/liboctave/dae.texi, doc/liboctave/diffeq.texi, doc/liboctave/error.texi, doc/liboctave/factor.texi, doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi, doc/liboctave/install.texi, doc/liboctave/intro.texi, doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi, doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi, doc/liboctave/ode.texi, doc/liboctave/optim.texi, doc/liboctave/preface.texi, doc/liboctave/quad.texi, doc/liboctave/range.texi, doc/refcard/Makefile.am, doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2, etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog, etc/OLD-ChangeLogs/doc-ChangeLog, etc/OLD-ChangeLogs/scripts-ChangeLog, etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog, etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW, etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am, examples/@polynomial/end.m, examples/@polynomial/subsasgn.m, examples/Makefile.am, examples/standalonebuiltin.cc, libgui/Makefile.am, libgui/qterminal/libqterminal/README, libgui/qterminal/libqterminal/unix/BlockArray.cpp, libgui/qterminal/libqterminal/unix/BlockArray.h, libgui/qterminal/libqterminal/unix/Character.h, libgui/qterminal/libqterminal/unix/CharacterColor.h, libgui/qterminal/libqterminal/unix/Emulation.cpp, libgui/qterminal/libqterminal/unix/Emulation.h, libgui/qterminal/libqterminal/unix/Filter.cpp, libgui/qterminal/libqterminal/unix/Filter.h, libgui/qterminal/libqterminal/unix/History.cpp, libgui/qterminal/libqterminal/unix/History.h, libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp, libgui/qterminal/libqterminal/unix/KeyboardTranslator.h, libgui/qterminal/libqterminal/unix/LineFont.h, libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp, libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h, libgui/qterminal/libqterminal/unix/Screen.cpp, libgui/qterminal/libqterminal/unix/Screen.h, libgui/qterminal/libqterminal/unix/ScreenWindow.cpp, libgui/qterminal/libqterminal/unix/ScreenWindow.h, libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp, libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h, libgui/qterminal/libqterminal/unix/Vt102Emulation.h, libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp, libgui/qterminal/qterminal/main.cpp, libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc, libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc, libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc, libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy, libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc, libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc, libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl, libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add, libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs, libinterp/mkops, libinterp/octave-value/ov-java.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/octave.gperf, liboctave/Makefile.am, liboctave/array/Array.cc, liboctave/array/module.mk, liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f, liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f, liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f, liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f, liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f, liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f, liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f, liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f, liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f, liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f, liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f, liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f, liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f, liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f, liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f, liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f, liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk, liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f, liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f, liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f, liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f, liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f, liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc, liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f, liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f, liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f, liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f, liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc, liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for, liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f, liboctave/cruft/slatec-fn/datanh.f, liboctave/cruft/slatec-fn/xgmainc.f, liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk, liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops, liboctave/operators/sparse-mk-ops.awk, liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops, liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m, scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m, scripts/deprecated/java_new.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m, scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m, scripts/general/display.m, scripts/general/fieldnames.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/isa.m, scripts/general/methods.m, scripts/general/sortrows.m, scripts/geometry/convhull.m, scripts/geometry/delaunay.m, scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m, scripts/geometry/griddata.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/gui/guihandles.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m, scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m, scripts/image/bone.m, scripts/image/cmpermute.m, scripts/image/cmunique.m, scripts/image/colorcube.m, scripts/image/colormap.m, scripts/image/contrast.m, scripts/image/gray2ind.m, scripts/image/image.m, scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m, scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m, scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m, scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m, scripts/mk-pkg-add, scripts/mkdoc.pl, scripts/optimization/fminsearch.m, scripts/optimization/optimset.m, scripts/optimization/sqp.m, scripts/pkg/pkg.m, scripts/pkg/private/create_pkgadddel.m, scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m, scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m, scripts/plot/util/clf.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/gcbo.m, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m, scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m, scripts/polynomial/conv.m, scripts/polynomial/poly.m, scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m, scripts/polynomial/polyval.m, scripts/polynomial/private/__splinefit__.m, scripts/polynomial/spline.m, scripts/prefs/prefdir.m, scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m, scripts/prefs/rmpref.m, scripts/signal/freqz.m, scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/specfun/expint.m, scripts/specfun/factor.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m, scripts/special-matrix/toeplitz.m, scripts/startup/inputrc, scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m, scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m, scripts/statistics/distributions/betarnd.m, scripts/statistics/distributions/binoinv.m, scripts/statistics/distributions/binopdf.m, scripts/statistics/distributions/binornd.m, scripts/statistics/distributions/cauchy_rnd.m, scripts/statistics/distributions/chi2rnd.m, scripts/statistics/distributions/discrete_pdf.m, scripts/statistics/distributions/discrete_rnd.m, scripts/statistics/distributions/empirical_rnd.m, scripts/statistics/distributions/exprnd.m, scripts/statistics/distributions/frnd.m, scripts/statistics/distributions/gamrnd.m, scripts/statistics/distributions/geornd.m, scripts/statistics/distributions/hygernd.m, scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, scripts/statistics/distributions/laplace_cdf.m, scripts/statistics/distributions/laplace_pdf.m, scripts/statistics/distributions/logistic_cdf.m, scripts/statistics/distributions/logistic_pdf.m, scripts/statistics/distributions/lognrnd.m, scripts/statistics/distributions/nbincdf.m, scripts/statistics/distributions/nbininv.m, scripts/statistics/distributions/nbinpdf.m, scripts/statistics/distributions/nbinrnd.m, scripts/statistics/distributions/normrnd.m, scripts/statistics/distributions/poissinv.m, scripts/statistics/distributions/poissrnd.m, scripts/statistics/distributions/tinv.m, scripts/statistics/distributions/trnd.m, scripts/statistics/distributions/unidcdf.m, scripts/statistics/distributions/unidpdf.m, scripts/statistics/distributions/unidrnd.m, scripts/statistics/distributions/unifrnd.m, scripts/statistics/distributions/wblrnd.m, scripts/statistics/models/module.mk, scripts/statistics/tests/kruskal_wallis_test.m, scripts/strings/base2dec.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m, scripts/testfun/test.m, scripts/time/asctime.m, scripts/time/datenum.m, scripts/time/datevec.m, scripts/time/weekday.m, src/Makefile.am, test/Makefile.am, test/build-bc-overload-tests.sh, test/build-sparse-tests.sh, test/jit.tst, test/line-continue.tst: Strip trailing whitespace.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 08:26:57 -0500
parents 3283ce934648
children 0e1f5a750d00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17692
diff changeset
1 ## Copyright (C) 1994-2013 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6368
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: 6368
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: 6368
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: 6368
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: 10704
diff changeset
20 ## @deftypefn {Function File} {} image (@var{img})
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6164
diff changeset
21 ## @deftypefnx {Function File} {} image (@var{x}, @var{y}, @var{img})
17689
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
22 ## @deftypefnx {Function File} {} image (@dots{}, "@var{prop}", @var{val}, @dots{})
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
23 ## @deftypefnx {Function File} {} image ("@var{prop1}", @var{val1}, @dots{})
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13993
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} image (@dots{})
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
25 ## Display a matrix as an indexed color image.
3651
c2305b99fbd7 [project @ 2000-03-31 07:12:29 by jwe]
jwe
parents: 3457
diff changeset
26 ##
14260
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
27 ## The elements of @var{img} are indices into the current colormap.
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
28 ## @var{x} and @var{y} are optional 2-element vectors, @w{@code{[min, max]}},
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
29 ## which specify the range for the axis labels. If a range is specified as
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
30 ## @w{@code{[max, min]}} then the image will be reversed along that axis. For
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
31 ## convenience, @var{x} and @var{y} may be specified as N-element vectors
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
32 ## matching the length of the data in @var{img}. However, only the first and
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
33 ## last elements will be used to determine the axis limits.
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
34 ## @strong{Warning:} @var{x} and @var{y} are ignored when using gnuplot 4.0
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
35 ## or earlier.
10817
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
36 ##
17689
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
37 ## Multiple property/value pairs may be specified for the image object, but
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
38 ## they must appear in pairs.
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
39 ##
14260
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
40 ## The optional return value @var{h} is a graphics handle to the image.
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
41 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
42 ## Implementation Note: The origin (0, 0) for images is located in the
10817
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
43 ## upper left. For ordinary plots, the origin is located in the lower
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
44 ## left. Octave handles this inversion by plotting the data normally,
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
45 ## and then reversing the direction of the y-axis by setting the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17038
diff changeset
46 ## @code{ydir} property to @qcode{"reverse"}. This has implications whenever
10817
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
47 ## an image and an ordinary plot need to be overlaid. The recommended
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
48 ## solution is to display the image and then plot the reversed ydata
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
49 ## using, for example, @code{flipud (ydata)}.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13993
diff changeset
50 ##
17689
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
51 ## Calling Forms: The @code{image} function can be called in two forms:
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
52 ## High-Level and Low-Level. When invoked with normal options, the High-Level
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
53 ## form is used which first calls @code{newplot} to prepare the graphic figure
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
54 ## and axes. When the only inputs to @code{image} are property/value pairs
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
55 ## the Low-Level form is used which creates a new instance of an image object
dd8db3f1c1da doc: Add information about High-Level/Low-Level calling forms for image, imagesc.
Rik <rik@octave.org>
parents: 17648
diff changeset
56 ## and inserts it in the current axes.
11109
41d18f6342f9 remove image_viewer function
John W. Eaton <jwe@octave.org>
parents: 11090
diff changeset
57 ## @seealso{imshow, imagesc, colormap}
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3202
diff changeset
58 ## @end deftypefn
559
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe]
jwe
parents:
diff changeset
59
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 2847
diff changeset
60 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
61 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
62 ## Adapted-By: jwe
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 686
diff changeset
63
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
64 function h = image (varargin)
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
65
17038
db90efd8f32b image.m: Update to use new __plt_get_axis_arg__ without using "axes" and "newplot" function.
Rik <rik@octave.org>
parents: 15764
diff changeset
66 [hax, varargin, nargin] = __plt_get_axis_arg__ ("image", varargin{:});
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18656
diff changeset
67
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
68 chararg = find (cellfun ("isclass", varargin, "char"), 1, "first");
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18656
diff changeset
69
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
70 do_new = true;
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
71 if (nargin == 0)
10650
f0dc41c824ce Replace calls to deprecated functions.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
72 img = imread ("default.img");
7276
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
73 x = y = [];
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18656
diff changeset
74 elseif (chararg == 1)
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
75 ## Low-Level syntax
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
76 do_new = false;
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
77 x = y = img = [];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
78 idx = find (strcmpi (varargin, "cdata"), 1);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
79 if (idx)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
80 img = varargin{idx+1};
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
81 varargin(idx:idx+1) = [];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
82 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
83 idx = find (strcmpi (varargin, "xdata"), 1);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
84 if (idx)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
85 x = varargin{idx+1};
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
86 varargin(idx:idx+1) = [];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
87 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
88 idx = find (strcmpi (varargin, "ydata"), 1);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
89 if (idx)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
90 y = varargin{idx+1};
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
91 varargin(idx:idx+1) = [];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
92 endif
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
93 elseif (nargin == 1 || chararg == 2)
7276
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
94 img = varargin{1};
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
95 x = y = [];
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
96 elseif (nargin == 2 || chararg == 3)
7276
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
97 print_usage ();
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
98 else
7276
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
99 x = varargin{1};
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
100 y = varargin{2};
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
101 img = varargin{3};
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
102 chararg = 4;
15064
489736962e80 image.m: Don't accept complex image data (bug #36866)
Rik <rik@octave.org>
parents: 14872
diff changeset
103 endif
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
104
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
105 oldfig = [];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
106 if (! isempty (hax))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
107 oldfig = get (0, "currentfigure");
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
108 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
109 unwind_protect
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
110 if (do_new)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
111 hax = newplot (hax);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
112 elseif (isempty (hax))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
113 hax = gca ();
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
114 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
115
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
116 htmp = __img__ (hax, do_new, x, y, img, varargin{chararg:end});
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
117
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
118 unwind_protect_cleanup
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
119 if (! isempty (oldfig))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
120 set (0, "currentfigure", oldfig);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
121 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
122 end_unwind_protect
7276
1e8e64d71e34 [project @ 2007-12-10 20:09:59 by jwe]
jwe
parents: 7208
diff changeset
123
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
124 if (nargout > 0)
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
125 h = htmp;
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
126 endif
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
127
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7074
diff changeset
128 endfunction
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
129
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
130 ## Generic image creation.
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
131 ##
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
132 ## The axis values corresponding to the matrix elements are specified in
14260
1f911333ed3d doc: Update docstrings for functions in image/ directory
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
133 ## @var{x} and @var{y}. If you're not using gnuplot 4.2 or later, these
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
134 ## variables are ignored.
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
135
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
136 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
137 ## Created: July 1994
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
138 ## Adapted-By: jwe
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
139
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
140 function h = __img__ (hax, do_new, x, y, img, varargin)
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
141
15764
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
142 ## FIXME: Hack for integer formats which use zero-based indexing
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
143 ## Hack favors correctness of display over size of image in memory.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18656
diff changeset
144 ## True fix must be done in C++ code for renderer.
15764
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
145 if (ndims (img) == 2 && (isinteger (img) || islogical (img)))
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
146 img = single (img) + 1;
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
147 endif
0a27a0e157a6 Temporary fix for display of indexed images of integer class.
Rik <rik@octave.org>
parents: 15683
diff changeset
148
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
149 if (! isempty (img))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
150
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
151 if (isempty (x))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
152 x = [1, columns(img)];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
153 endif
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
154
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
155 if (isempty (y))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
156 y = [1, rows(img)];
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
157 endif
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
158
18443
4bfd44c15145 image.m: Fix axis limit bug when column vectors are used as x,y input (bug #41466).
Rik <rik@octave.org>
parents: 17744
diff changeset
159 xdata = x([1, end])(:).'; # (:).' is a hack to guarantee row vector
4bfd44c15145 image.m: Fix axis limit bug when column vectors are used as x,y input (bug #41466).
Rik <rik@octave.org>
parents: 17744
diff changeset
160 ydata = y([1, end])(:).';
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
161
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
162 if (numel (x) > 2 && numel (y) > 2)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
163 ## Test data for non-linear spacing which is unsupported
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
164 tol = .01; # 1% tolerance. FIXME: this value was chosen without thought.
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
165 dx = diff (x);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
166 dxmean = (max (x) - min (x)) / (numel (x) - 1);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
167 dx = abs ((abs (dx) - dxmean) / dxmean);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
168 dy = diff (y);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
169 dymean = (max (y) - min (y)) / (numel (y) - 1);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
170 dy = abs ((abs (dy) - dymean) / dymean);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
171 if (any (dx > tol) || any (dy > tol))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
172 warning (["image: non-linear X, Y data is ignored. " ...
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
173 "IMG will be shown with linear mapping"]);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
174 endif
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
175 endif
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
176
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
177 endif # ! isempty (img)
13980
bd2be36fd949 image.m: Warn if input coordinates are not linearly spaced.
Ben Abbott <bpabbott@mac.com>
parents: 13173
diff changeset
178
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
179 h = __go_image__ (hax, "cdata", img, "xdata", xdata, "ydata", ydata,
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
180 "cdatamapping", "direct", varargin{:});
11076
b748b86cb8c1 fix images with width or height of 1
Shai Ayal <shaiay@users.sourceforge.net>
parents: 10952
diff changeset
181
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
182 if (do_new && ! ishold (hax))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
183 ## Set axis properties for new images
11090
2adf4736dafa Do not store flipped image property values when x/ydata descends.
Ben Abbott <bpabbott@mac.com>
parents: 11080
diff changeset
184
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
185 if (! isempty (img))
18524
bf0d2e51c8f0 axis.m: make 'tight' embrace whole images (bug #36594).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 18443
diff changeset
186 if (isscalar (get (hax, "children")))
18656
3283ce934648 Set only 'axis tight' for image functions and Matlab compatibility (bug #42043, bug #41886)
Rik <rik@octave.org>
parents: 18524
diff changeset
187 axis (hax, "tight");
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
188 endif
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
189
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
190 if (ndims (img) == 3)
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
191 if (isinteger (img))
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
192 cls = class (img);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
193 mn = intmin (cls);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
194 mx = intmax (cls);
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
195 set (hax, "clim", double ([mn, mx]));
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
196 endif
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
197 endif
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
198
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
199 endif # ! isempty (img)
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
200
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
201 set (hax, "view", [0, 90], "ydir", "reverse", "layer", "bottom");
10817
d9147775da54 image.m: Always reverse 'ydir' property when displaying images.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
202
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
203 endif # do_new
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
204
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
205 endfunction
10942
48a1812fcc3a image.m: Matlab compatible axis limits, add demo.
Ben Abbott <bpabbott@mac.com>
parents: 10818
diff changeset
206
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
207
10942
48a1812fcc3a image.m: Matlab compatible axis limits, add demo.
Ben Abbott <bpabbott@mac.com>
parents: 10818
diff changeset
208 %!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
209 %! clf;
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
210 %! colormap (jet (21));
11080
36ceff79607b image.m: Allow x/ydata to imply a flip of the image. Modify demos.
Ben Abbott <bpabbott@mac.com>
parents: 11076
diff changeset
211 %! img = 1 ./ hilb (11);
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
212 %! x = y = -5:5;
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
213 %! subplot (2,2,1);
15683
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
214 %! h = image (x, y, img);
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
215 %! ylabel ("limits = [-5.5, 5.5]");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers.
Rik <rik@octave.org>
parents: 15202
diff changeset
216 %! title ("image (x, y, img)");
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
217 %! subplot (2,2,2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
218 %! h = image (-x, y, img);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
219 %! title ("image (-x, y, img)");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
220 %! subplot (2,2,3);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
221 %! h = image (x, -y, img);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
222 %! title ("image (x, -y, img)");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
223 %! ylabel ("limits = [-5.5, 5.5]");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
224 %! subplot (2,2,4);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
225 %! h = image (-x, -y, img);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
226 %! title ("image (-x, -y, img)");
10942
48a1812fcc3a image.m: Matlab compatible axis limits, add demo.
Ben Abbott <bpabbott@mac.com>
parents: 10818
diff changeset
227
17692
38cf56b77274 Overhaul image, imagesc to use newplot and support low-level invocation form.
Rik <rik@octave.org>
parents: 17689
diff changeset
228 ## FIXME: Need %!tests for linear