Mercurial > octave-antonio

annotate scripts/image/imread.m @ 17338:1c89599167a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: End m-files with 1 blank line. Simplifies automated grammarchecking script. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/close.m, scripts/@ftp/delete.m, scripts/@ftp/dir.m, scripts/@ftp/display.m, scripts/@ftp/ftp.m, scripts/@ftp/loadobj.m, scripts/@ftp/mget.m, scripts/@ftp/mkdir.m, scripts/@ftp/mput.m, scripts/@ftp/rename.m, scripts/@ftp/rmdir.m, scripts/@ftp/saveobj.m, scripts/audio/lin2mu.m, scripts/audio/loadaudio.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/saveaudio.m, scripts/audio/setaudio.m, scripts/deprecated/__error_text__.m, scripts/deprecated/cut.m, scripts/deprecated/error_text.m, scripts/deprecated/isstr.m, scripts/deprecated/polyderiv.m, scripts/deprecated/studentize.m, scripts/deprecated/sylvester_matrix.m, scripts/general/bicubic.m, scripts/general/celldisp.m, scripts/general/colon.m, scripts/general/cplxpair.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/isdir.m, scripts/general/isequaln.m, scripts/general/loadobj.m, scripts/general/private/__isequal__.m, scripts/general/private/__splinen__.m, scripts/general/profexplore.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/repmat.m, scripts/general/saveobj.m, scripts/geometry/delaunay.m, scripts/help/__unimplemented__.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/print_usage.m, scripts/help/private/__additional_help_message__.m, scripts/help/private/__strip_html_tags__.m, scripts/help/type.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/image/private/__imfinfo__.m, scripts/image/private/__imread__.m, scripts/image/private/__imwrite__.m, scripts/image/private/imageIO.m, scripts/image/private/imwrite_filename.m, scripts/image/private/ind2x.m, scripts/io/beep.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/subspace.m, scripts/miscellaneous/bug_report.m, scripts/miscellaneous/bunzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dump_prefs.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isdeployed.m, scripts/miscellaneous/ismac.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mexext.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/namelengthmax.m, scripts/miscellaneous/news.m, scripts/miscellaneous/pack.m, scripts/miscellaneous/perl.m, scripts/miscellaneous/private/display_info_file.m, scripts/miscellaneous/python.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/run.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tempname.m, scripts/miscellaneous/untar.m, scripts/miscellaneous/unzip.m, scripts/miscellaneous/what.m, scripts/miscellaneous/zip.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/optimget.m, scripts/optimization/optimset.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/path/pathdef.m, scripts/pkg/pkg.m, scripts/pkg/private/build.m, scripts/pkg/private/describe.m, scripts/pkg/private/dirempty.m, scripts/pkg/private/get_forge_download.m, scripts/pkg/private/get_forge_pkg.m, scripts/pkg/private/get_unsatisfied_deps.m, scripts/pkg/private/install.m, scripts/pkg/private/is_architecture_dependent.m, scripts/pkg/private/list_forge_packages.m, scripts/pkg/private/rebuild.m, scripts/pkg/private/shell.m, scripts/pkg/private/uninstall.m, scripts/plot/axes.m, scripts/plot/box.m, scripts/plot/closereq.m, scripts/plot/diffuse.m, scripts/plot/ezpolar.m, scripts/plot/findfigs.m, scripts/plot/gco.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/linkprop.m, scripts/plot/peaks.m, scripts/plot/print.m, scripts/plot/private/__add_datasource__.m, scripts/plot/private/__axis_label__.m, scripts/plot/private/__clabel__.m, scripts/plot/private/__color_str_rgb__.m, scripts/plot/private/__contour__.m, scripts/plot/private/__default_plot_options__.m, scripts/plot/private/__errcomm__.m, scripts/plot/private/__file_filter__.m, scripts/plot/private/__fltk_file_filter__.m, scripts/plot/private/__getlegenddata__.m, scripts/plot/private/__gnuplot_open_stream__.m, scripts/plot/private/__gnuplot_print__.m, scripts/plot/private/__go_draw_axes__.m, scripts/plot/private/__interp_cube__.m, scripts/plot/private/__is_function__.m, scripts/plot/private/__line__.m, scripts/plot/private/__marching_cube__.m, scripts/plot/private/__next_line_style__.m, scripts/plot/private/__patch__.m, scripts/plot/private/__pie__.m, scripts/plot/private/__pltopt__.m, scripts/plot/private/__quiver__.m, scripts/plot/private/__scatter__.m, scripts/plot/private/__stem__.m, scripts/plot/private/__uigetdir_fltk__.m, scripts/plot/private/__uigetfile_fltk__.m, scripts/plot/private/__uiobject_split_args__.m, scripts/plot/private/__uiputfile_fltk__.m, scripts/plot/refresh.m, scripts/plot/saveas.m, scripts/plot/shg.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/uicontextmenu.m, scripts/plot/uicontrol.m, scripts/plot/uipanel.m, scripts/plot/uipushtool.m, scripts/plot/uiresume.m, scripts/plot/uitoggletool.m, scripts/plot/uitoolbar.m, scripts/plot/uiwait.m, scripts/plot/waitforbuttonpress.m, scripts/polynomial/pchip.m, scripts/polynomial/polyeig.m, scripts/polynomial/ppval.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/private/loadprefs.m, scripts/prefs/private/prefsfile.m, scripts/prefs/private/saveprefs.m, scripts/prefs/setpref.m, scripts/set/private/validargs.m, scripts/set/unique.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arch_test.m, scripts/signal/arma_rnd.m, scripts/signal/durbinlevinson.m, scripts/signal/fractdiff.m, scripts/signal/freqz.m, scripts/signal/freqz_plot.m, scripts/signal/hurst.m, scripts/signal/periodogram.m, scripts/signal/private/rectangle_lw.m, scripts/signal/private/rectangle_sw.m, scripts/signal/private/triangle_sw.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/yulewalker.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/spdiags.m, scripts/sparse/sprandn.m, scripts/specfun/bessel.m, scripts/specfun/betaln.m, scripts/specfun/expint.m, scripts/special-matrix/gallery.m, scripts/startup/__finish__.m, scripts/statistics/base/qqplot.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/logistic_regression.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/bartlett_test.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/hotelling_test_2.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.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/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m, scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m, scripts/testfun/__run_test_suite__.m, scripts/time/clock.m, scripts/time/datenum.m, scripts/ui/errordlg.m, scripts/ui/private/message_dialog.m: End m-files with 1 blank line.
author Rik <rik@octave.org>
date Wed, 28 Aug 2013 08:33:02 -0700
parents bc924baa2c4e
children ba79ba4e83ab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
1 ## Copyright (C) 2013 Carnë Draug
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
2 ## Copyright (C) 2008-2012 Thomas L. Scofield
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
3 ## Copyright (C) 2008 Kristian Rumberg
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
4 ## Copyright (C) 2006 Thomas Weber
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
5 ## Copyright (C) 2005 Stefan van der Walt
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8664
diff changeset
6 ## Copyright (C) 2002 Andy Adler
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
7 ##
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
8 ## This file is part of Octave.
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
9 ##
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
10 ## Octave is free software; you can redistribute it and/or modify it
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
12 ## the Free Software Foundation; either version 3 of the License, or (at
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
13 ## your option) any later version.
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
14 ##
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
18 ## General Public License for more details.
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
19 ##
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
22 ## <http://www.gnu.org/licenses/>.
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
23
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
24 ## -*- texinfo -*-
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
25 ## @deftypefn {Function File} {[@var{img}, @var{map}, @var{alpha}] =} imread (@var{filename})
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
26 ## @deftypefnx {Function File} {[@dots{}] =} imread (@var{filename}, @var{ext})
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
27 ## @deftypefnx {Function File} {[@dots{}] =} imread (@var{url})
16962
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
28 ## @deftypefnx {Function File} {[@dots{}] =} imread (@dots{}, @var{idx})
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
29 ## @deftypefnx {Function File} {[@dots{}] =} imread (@dots{}, @var{param1}, @var{val1}, @dots{})
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
30 ## Read images from various file formats.
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
31 ##
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
32 ## Reads an image as a matrix from the file @var{filename}. If there is
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
33 ## no file @var{filename}, and @var{ext} was specified, it will look for
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
34 ## a file named @var{filename} and extension @var{ext}, i.e., a file named
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
35 ## @var{filename}.@var{ext}.
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
36 ##
16962
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
37 ## The size and class of the output depends on the
9072
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
38 ## format of the image. A color image is returned as an
11591
1d13679b587e Use @nospell macro on certain words in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
39 ## @nospell{MxNx3} matrix. Gray-level and black-and-white images are
16962
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
40 ## of size @nospell{MxN}. Multipage images will have an additional 4th
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
41 ## dimension.
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
42 ## The bit depth of the image determines the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
43 ## class of the output: @qcode{"uint8"} or @qcode{"uint16"} for gray
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
44 ## and color, and @qcode{"logical"} for black and white.
16996
a1d091243d11 Read alpha values from indexed images. Always read indexes from indexed images.
Carnë Draug <carandraug@octave.org>
parents: 16984
diff changeset
45 ## Note that indexed images always return the indexes for a colormap,
a1d091243d11 Read alpha values from indexed images. Always read indexes from indexed images.
Carnë Draug <carandraug@octave.org>
parents: 16984
diff changeset
46 ## independent if @var{map} is a requested output. To obtain the actual
a1d091243d11 Read alpha values from indexed images. Always read indexes from indexed images.
Carnë Draug <carandraug@octave.org>
parents: 16984
diff changeset
47 ## RGB image, use @code{ind2rgb}.
16962
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
48 ## See the Octave manual for more information in representing images.
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
49 ##
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
50 ## Some file formats, such as TIFF and GIF, are able to store multiple
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
51 ## images in a single file. @var{idx} can be a scalar or vector
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
52 ## specifying the index of the images to read. By default, Octave
fb940d48c6f7 doc: document index argument for reading multipage images.
Carnë Draug <carandraug@octave.org>
parents: 16944
diff changeset
53 ## will only read the first page.
8148
213dd524f96b Improve documentation for image I/O.
sh@sh-laptop
parents: 7931
diff changeset
54 ##
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
55 ## Depending on the file format, it is possible to configure the reading
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
56 ## of images with @var{param}, @var{val} pairs. The following options
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
57 ## are supported:
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
58 ##
16996
a1d091243d11 Read alpha values from indexed images. Always read indexes from indexed images.
Carnë Draug <carandraug@octave.org>
parents: 16984
diff changeset
59 ## @table @samp
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
60 ## @item @qcode{"Frames"} or @qcode{"Index"}
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
61 ## This is an alternative method to specify @var{idx}. When specifying it
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
62 ## in this way, its value can also be the string @qcode{"all"}.
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
63 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
64 ## @item @qcode{"Info"}
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17118
diff changeset
65 ## This option exists for @sc{matlab} compatibility and has no effect. For
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
66 ## maximum performance while reading multiple images from a single file,
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
67 ## use the Index option.
17118
c97a26408ee0 Implement PixelRegion option for imread().
Carnë Draug <carandraug@octave.org>
parents: 17086
diff changeset
68 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17171
diff changeset
69 ## @item @qcode{"PixelRegion"}
17118
c97a26408ee0 Implement PixelRegion option for imread().
Carnë Draug <carandraug@octave.org>
parents: 17086
diff changeset
70 ## Controls the image region that is read. Takes as value a cell array
c97a26408ee0 Implement PixelRegion option for imread().
Carnë Draug <carandraug@octave.org>
parents: 17086
diff changeset
71 ## with two arrays of 3 elements @code{@{@var{rows} @var{cols}@}}. The
c97a26408ee0 Implement PixelRegion option for imread().
Carnë Draug <carandraug@octave.org>
parents: 17086
diff changeset
72 ## elements in the array are the start, increment and end pixel to be
17171
c3bd7314643c doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents: 17170
diff changeset
73 ## read. If the increment value is omitted, defaults to 1.
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
74 ## @end table
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
75 ##
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
76 ## @seealso{imwrite, imfinfo, imformats}
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
77 ## @end deftypefn
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
78
16984
997efb8d0b19 imread: implement options Index, Frames, and Info.
Carnë Draug <carandraug@octave.org>
parents: 16967
diff changeset
79 ## Author: Carnë Draug <carandraug@octave.org>
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
80 ## Author: Thomas L. Scofield <scofield@calvin.edu>
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
81 ## Author: Kristian Rumberg <kristianrumberg@gmail.com>
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
82 ## Author: Thomas Weber <thomas.weber.mail@gmail.com>
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
83 ## Author: Stefan van der Walt <stefan@sun.ac.za>
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
84 ## Author: Andy Adler
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
85
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
86 function varargout = imread (varargin)
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
87 if (nargin < 1)
7931
de26beacb20f imread.m: simplify; loadimage.m: deprecate
John W. Eaton <jwe@octave.org>
parents: 7925
diff changeset
88 print_usage ();
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
89 elseif (! ischar (varargin{1}))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
90 error ("imread: FILENAME must be a string");
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
91 endif
16944
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
92 ## In case the file format was specified as a separate argument we
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
93 ## do this. imageIO() will ignore the second part if filename on its
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
94 ## own is enough. And if the second argument was a parameter name instead
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
95 ## of an extension, it is still going to be passed to the next function
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
96 ## since we are passing the whole function input as well.
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
97 filename = {varargin{1}};
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
98 if (nargin > 1 && ischar (varargin {2}))
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
99 filename{2} = varargin{2};
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
100 endif
1b3b3ee88284 Add optional extension argument to image IO functions.
Carnë Draug <carandraug@octave.org>
parents: 16913
diff changeset
101
17086
3db796f89695 Rename private core_imfnc functions to follow the __fnc__ convention style.
Carnë Draug <carandraug@octave.org>
parents: 16996
diff changeset
102 [varargout{1:nargout}] = imageIO (@__imread__, "read", filename, varargin{:});
7925
9316b59903c9 Add original imread() files (from octave-forge) to core octave.
Thomas L. Scofield <scofield AT calvin DOT edu>
parents:
diff changeset
103 endfunction
9382
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
104
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
105
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
106 %!testif HAVE_MAGICK
9382
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
107 %! vpng = [ ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
108 %! 137, 80, 78, 71, 13, 10, 26, 10, 0, 0, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
109 %! 0, 13, 73, 72, 68, 82, 0, 0, 0, 3, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
110 %! 0, 0, 0, 3, 8, 2, 0, 0, 0, 217, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
111 %! 74, 34, 232, 0, 0, 0, 1, 115, 82, 71, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
112 %! 66, 0, 174, 206, 28, 233, 0, 0, 0, 4, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
113 %! 103, 65, 77, 65, 0, 0, 177, 143, 11, 252, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
114 %! 97, 5, 0, 0, 0, 32, 99, 72, 82, 77, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
115 %! 0, 0, 122, 38, 0, 0, 128, 132, 0, 0, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
116 %! 250, 0, 0, 0, 128, 232, 0, 0, 117, 48, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
117 %! 0, 0, 234, 96, 0, 0, 58, 152, 0, 0, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
118 %! 23, 112, 156, 186, 81, 60, 0, 0, 0, 25, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
119 %! 73, 68, 65, 84, 24, 87, 99, 96, 96, 96, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
120 %! 248, 255, 255, 63, 144, 4, 81, 111, 101, 84, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
121 %! 16, 28, 160, 16, 0, 197, 214, 13, 34, 74, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
122 %! 117, 213, 17, 0, 0, 0, 0, 73, 69, 78, ...
ab563d2adc10 image/imread.m Test added.
Alexander Mamonov <mamonov@gmail.com>
parents: 9268
diff changeset
123 %! 68, 174, 66, 96, 130];
16967
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
124 %! filename = [tmpnam() ".png"];
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
125 %! unwind_protect
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
126 %! fid = fopen (filename, "wb");
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
127 %! fwrite (fid, vpng);
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
128 %! fclose (fid);
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
129 %! A = imread (filename);
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
130 %! unwind_protect_cleanup
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
131 %! unlink (filename);
52c1b832d98e imread: make sure test file is removed if imread() errors.
Carnë Draug <carandraug@octave.org>
parents: 16962
diff changeset
132 %! end_unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
133 %! assert (A(:,:,1), uint8 ([0, 255, 0; 255, 237, 255; 0, 255, 0]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
134 %! assert (A(:,:,2), uint8 ([0, 255, 0; 255, 28, 255; 0, 255, 0]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
135 %! assert (A(:,:,3), uint8 ([0, 255, 0; 255, 36, 255; 0, 255, 0]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
136