<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry version="5.0-subset Scilab" xml:id="imfinfo" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns5="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <info>
    <pubdate>July, 2006</pubdate>
  </info>

  <refnamediv>
    <refname>imfinfo</refname>

    <refpurpose>Get the information about image file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>info = imfinfo(filename)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>filename</term>

        <listitem>
           A string, the image filename to be read. 
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>info</term>

        <listitem>
           A mlist. The set of fields in the 

          <literal>info</literal>

           structure is shown as follows: 

          <informaltable border="1">
            <tr>
              <td>Field Name</td>

              <td>Description</td>
            </tr>

            <tr>
              <td>Filename</td>

              <td>String containing the image file name.</td>
            </tr>

            <tr>
              <td>FileSize</td>

              <td>Integer indicating the size of the image file in bytes.</td>
            </tr>

            <tr>
              <td>Width</td>

              <td>Integer indicating image width in pixels.</td>
            </tr>

            <tr>
              <td>Height</td>

              <td>Integer indicating image height in pixels.</td>
            </tr>

            <tr>
              <td>BitDepth</td>

              <td>Integer indicating the number of bits per pixel .</td>
            </tr>

            <tr>
              <td>ColorType</td>

              <td>String containing the color type of the image file, which
              can be 'grayscale' or 'truecolor'.</td>
            </tr>
          </informaltable>

           
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Examples</title>

    <programlisting role="example">    info = imfinfo(fullpath(getSIVPpath() + "/images/lena.png"))</programlisting>
  </refsection>

  <refsection>
    <title>Authors</title>

    <simplelist type="vert">
      <member>Shiqi Yu &lt;shiqi.yu[at]gmail.com&gt;</member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Availability</title>

     The latest version of SIVP can be found at 

    <para>http://sivp.sf.net</para>

     
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="imread">imread</link></member>

      <member><link linkend="imwrite">imwrite</link></member>

      <member><link linkend="imshow">imshow</link></member>
    </simplelist>
  </refsection>
</refentry>
