Mercurial > octave

comparison scripts/image/imfinfo.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents eb63fbe60fab
children 74d5c1a4ca96
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
20 ## @deftypefn {Function File} {@var{info} =} imfinfo (@var{filename}) 20 ## @deftypefn {Function File} {@var{info} =} imfinfo (@var{filename})
21 ## @deftypefnx{Function File} {@var{info} =} imfinfo (@var{url}) 21 ## @deftypefnx{Function File} {@var{info} =} imfinfo (@var{url})
22 ## Read image information from a file. 22 ## Read image information from a file.
23 ## 23 ##
24 ## @code{imfinfo} returns a structure containing information about the image 24 ## @code{imfinfo} returns a structure containing information about the image
25 ## stored in the file @var{filename}. The output structure contains the 25 ## stored in the file @var{filename}. The output structure contains the
26 ## following fields. 26 ## following fields.
27 ## 27 ##
28 ## @table @samp 28 ## @table @samp
29 ## @item Filename 29 ## @item Filename
30 ## The full name of the image file. 30 ## The full name of the image file.
37 ## @item Width 37 ## @item Width
38 ## Image Width in pixels. 38 ## Image Width in pixels.
39 ## @item BitDepth 39 ## @item BitDepth
40 ## Number of bits per channel per pixel. 40 ## Number of bits per channel per pixel.
41 ## @item Format 41 ## @item Format
42 ## Image format (e.g. @code{"jpeg"}). 42 ## Image format (e.g., @code{"jpeg"}).
43 ## @item LongFormat 43 ## @item LongFormat
44 ## Long form image format description. 44 ## Long form image format description.
45 ## @item XResolution 45 ## @item XResolution
46 ## X resolution of the image. 46 ## X resolution of the image.
47 ## @item YResolution 47 ## @item YResolution
52 ## Tile name. 52 ## Tile name.
53 ## @item AnimationDelay 53 ## @item AnimationDelay
54 ## Time in 1/100ths of a second (0 to 65535) which must expire before displaying 54 ## Time in 1/100ths of a second (0 to 65535) which must expire before displaying
55 ## the next image in an animated sequence. 55 ## the next image in an animated sequence.
56 ## @item AnimationIterations 56 ## @item AnimationIterations
57 ## Number of iterations to loop an animation (e.g. Netscape loop extension) for. 57 ## Number of iterations to loop an animation (e.g., Netscape loop extension) for.
58 ## @item ByteOrder 58 ## @item ByteOrder
59 ## Endian option for formats that support it. Is either @code{"little-endian"}, 59 ## Endian option for formats that support it. Is either @code{"little-endian"},
60 ## @code{"big-endian"}, or @code{"undefined"}. 60 ## @code{"big-endian"}, or @code{"undefined"}.
61 ## @item Gamma 61 ## @item Gamma
62 ## Gamma level of the image. The same color image displayed on two different 62 ## Gamma level of the image. The same color image displayed on two different
63 ## workstations may look different due to differences in the display monitor. 63 ## workstations may look different due to differences in the display monitor.
64 ## @item Matte 64 ## @item Matte
65 ## @code{true} if the image has transparency. 65 ## @code{true} if the image has transparency.
66 ## @item ModulusDepth 66 ## @item ModulusDepth
67 ## Image modulus depth (minimum number of bits required to support red/green/blue 67 ## Image modulus depth (minimum number of bits required to support red/green/blue
68 ## components without loss of accuracy). 68 ## components without loss of accuracy).
69 ## @item Quality 69 ## @item Quality
70 ## JPEG/MIFF/PNG compression level. 70 ## JPEG/MIFF/PNG compression level.
71 ## @item QuantizeColors 71 ## @item QuantizeColors
72 ## Preferred number of colors in the image. 72 ## Preferred number of colors in the image.
73 ## @item ResolutionUnits 73 ## @item ResolutionUnits
74 ## Units of image resolution. Is either @code{"pixels per inch"}, 74 ## Units of image resolution. Is either @code{"pixels per inch"},
75 ## @code{"pixels per centimeter"}, or @code{"undefined"}. 75 ## @code{"pixels per centimeter"}, or @code{"undefined"}.
76 ## @item ColorType 76 ## @item ColorType
77 ## Image type. Is either @code{"grayscale"}, @code{"indexed"}, @code{"truecolor"}, 77 ## Image type. Is either @code{"grayscale"}, @code{"indexed"}, @code{"truecolor"},
78 ## or @code{"undefined"}. 78 ## or @code{"undefined"}.
79 ## @item View 79 ## @item View
80 ## FlashPix viewing parameters. 80 ## FlashPix viewing parameters.
81 ## @end table 81 ## @end table
82 ## 82 ##