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

annotate scripts/image/imfinfo.m @ 11191:01ddaedd6ad5

Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.

author	Rik <octave@nomad.inbox5.com>
date	Thu, 04 Nov 2010 12:18:08 -0700
parents	693e22af08ae
children	1740012184f9

rev	line source
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8664 diff changeset	1 ## Copyright (C) 2008, 2009 Soren Hauberg <hauberg@gmail.com>
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	2 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	3 ## This file is part of Octave.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	4 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	8 ## your option) any later version.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	9 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	13 ## General Public License for more details.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	14 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	18
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	19 ## -- texinfo --
9143 74d5c1a4ca96 Eliminate 'unbalanced parentheses in @def...' error during texi2pdf. Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	20 ## @deftypefn {Function File} {@var{info} =} imfinfo (@var{filename})
74d5c1a4ca96 Eliminate 'unbalanced parentheses in @def...' error during texi2pdf. Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	21 ## @deftypefnx {Function File} {@var{info} =} imfinfo (@var{url})
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	22 ## Read image information from a file.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	23 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	24 ## @code{imfinfo} returns a structure containing information about the image
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	25 ## stored in the file @var{filename}. The output structure contains the
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	26 ## following fields.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	27 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	28 ## @table @samp
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	29 ## @item Filename
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	30 ## The full name of the image file.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	31 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	32 ## @item FileSize
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	33 ## Number of bytes of the image on disk
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	34 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	35 ## @item FileModDate
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	36 ## Date of last modification to the file.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	37 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	38 ## @item Height
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	39 ## Image height in pixels.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	40 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	41 ## @item Width
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	42 ## Image Width in pixels.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	43 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	44 ## @item BitDepth
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	45 ## Number of bits per channel per pixel.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	46 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	47 ## @item Format
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	48 ## Image format (e.g., @code{"jpeg"}).
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	49 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	50 ## @item LongFormat
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	51 ## Long form image format description.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	52 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	53 ## @item XResolution
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	54 ## X resolution of the image.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	55 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	56 ## @item YResolution
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	57 ## Y resolution of the image.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	58 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	59 ## @item TotalColors
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	60 ## Number of unique colors in the image.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	61 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	62 ## @item TileName
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	63 ## Tile name.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	64 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	65 ## @item AnimationDelay
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	66 ## Time in 1/100ths of a second (0 to 65535) which must expire before displaying
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	67 ## the next image in an animated sequence.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	68 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	69 ## @item AnimationIterations
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	70 ## Number of iterations to loop an animation (e.g., Netscape loop extension)
be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	71 ## for.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	72 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	73 ## @item ByteOrder
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	74 ## Endian option for formats that support it. Is either @code{"little-endian"},
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	75 ## @code{"big-endian"}, or @code{"undefined"}.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	76 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	77 ## @item Gamma
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	78 ## Gamma level of the image. The same color image displayed on two different
1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	79 ## workstations may look different due to differences in the display monitor.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	80 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	81 ## @item Matte
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	82 ## @code{true} if the image has transparency.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	83 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	84 ## @item ModulusDepth
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	85 ## Image modulus depth (minimum number of bits required to support
be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	86 ## red/green/blue
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	87 ## components without loss of accuracy).
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	88 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	89 ## @item Quality
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	90 ## JPEG/MIFF/PNG compression level.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	91 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	92 ## @item QuantizeColors
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	93 ## Preferred number of colors in the image.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	94 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	95 ## @item ResolutionUnits
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	96 ## Units of image resolution. Is either @code{"pixels per inch"},
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	97 ## @code{"pixels per centimeter"}, or @code{"undefined"}.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	98 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	99 ## @item ColorType
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	100 ## Image type. Is either @code{"grayscale"}, @code{"indexed"},
be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10433 diff changeset	101 ## @code{"truecolor"},
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	102 ## or @code{"undefined"}.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	103 ##
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	104 ## @item View
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	105 ## FlashPix viewing parameters.
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	106 ## @end table
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	107 ##
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	108 ## @seealso{imread, imwrite}
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	109 ## @end deftypefn
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	110
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	111 function info = imfinfo (filename)
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	112
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	113 if (nargin < 1)
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	114 print_usage ();
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	115 endif
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	116
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	117 if (!ischar (filename))
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8152 diff changeset	118 error ("imfinfo: filename must be a string");
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	119 endif
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	120
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	121 filename = tilde_expand (filename);
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	122
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	123 delete_file = false;
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	124
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	125 unwind_protect
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	126
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	127 fn = file_in_path (IMAGE_PATH, filename);
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	128
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	129 if (isempty (fn))
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	130
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	131 ## Couldn't find file. See if it's an URL.
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	132
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	133 tmp = tmpnam ();
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	134
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	135 [fn, status, msg] = urlwrite (filename, tmp);
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	136
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	137 if (! status)
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10333 diff changeset	138 error ("imfinfo: cannot find %s", filename);
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	139 endif
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	140
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	141 if (! isempty (fn))
10433 2c01d24459fb Detabify scripts in 'scripts/image/' Soren Hauberg <hauberg@gmail.com> parents: 10333 diff changeset	142 delete_file = true;
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	143 endif
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	144
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	145 endif
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	146
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	147 info = __magick_finfo__ (fn);
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	148
8152 2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	149 unwind_protect_cleanup
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	150
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	151 if (delete_file)
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	152 unlink (fn);
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	153 endif
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	154
2b48deec1aa2 imfinfo.m: delete temporary files John W. Eaton <jwe@octave.org> parents: 8144 diff changeset	155 end_unwind_protect
8144 01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	156
01fac748b680 Add the 'imfinfo' function for reading image file information. sh@sh-laptop parents: diff changeset	157 endfunction

Mercurial > hg > octave-nkf

annotate scripts/image/imfinfo.m @ 11191:01ddaedd6ad5