<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Allan CORNET
 * 
 * This file is released into the public domain
 *
 -->
<refentry version="5.0-subset Scilab" xml:id="CreateRasterFromBinary" 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:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <info>
    <pubdate>$LastChangedDate: 2013-10-16 12:00:00 +0100 (Wed., October 16, 2013)
    $</pubdate>
  </info>

  <refnamediv>
    <refname>CreateRasterFromBinary</refname>

    <refpurpose>Creates and initializes a single-precision floating-point raster from the content of a binary file.</refpurpose>
  </refnamediv>

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

    <synopsis>handle_ras = CreateRasterFromBinary ( binfile , TYPE [, name] )</synopsis>
  </refsynopsisdiv>


  <refsection>
    <title>Arguments</title>
    <variablelist>

	 <varlistentry>     
      <term>binfile</term>
        <listitem>
          <para>
           character string: path of the binary file to be read. The extension can be anything, but a header file with the same root and with the extension ".hdr" must be present in the same directory.
         </para>
        </listitem>
      </varlistentry>
	  
      <varlistentry>
        <term>TYPE</term>
        <listitem>
          <para>
	character string: type of the data to be read and converted to single-precision
	   </para>
	    <para>
		'c' : char
	    </para>
	    <para>
        'uc' : unsigned char
	    </para>
	    <para>
		's' : short int
	    </para>
	    <para>
        'us' : unsigned short int
	    </para>
	    <para>
        'i' : int
	    </para>
	    <para>
        'ui' : unsigned int
	    </para>
	    <para>
		'f' : float
	    </para>
	    <para>
        'l' : long int
	    </para>
	    <para>
        'ul' : unsigned long int
	    </para>
	    <para>
        'd' : double
	   </para>
	   
        </listitem>
      </varlistentry>

      <varlistentry>     
      <term>Name</term>
        <listitem>
          <para>
            (optional) character string
         </para>
        </listitem>
      </varlistentry>
  
	   <varlistentry>
        <term>handle_ras</term>
        <listitem>
          <para>
		integer: handle on the newly created raster
    	</para>
	  </listitem>
      </varlistentry>

</variablelist>
  </refsection>



  <refsection>
    <title>Description</title>

    <para>Creates and initializes a single-precision floating-point raster from a binary file (e.g., ESRI Binary Grid .flt). Any numerical type is supported and will be converted to single precision.</para>
    <para>Returns a handle on the object created.</para>

  </refsection>

  <refsection>
    <title>Examples</title>
  </refsection>

   <refsection><title>See Also</title><simplelist type='inline'>
    
      <member> 
         <link linkend='CreateFloatRaster'>CreateFloatRaster</link> , <link linkend='DestroyFloatRaster'>DestroyFloatRaster</link>
      </member>
     
   </simplelist></refsection>


  <refsection>
    <title>Authors</title>

    <simplelist type="vert">
      <member>Nicolas LE MOINE</member>
    </simplelist>
  </refsection>
</refentry>
