<?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="FillDistanceMap" 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>FillDistanceMap</refname>

    <refpurpose>Computes along-stream distances to an outlet</refpurpose>
  </refnamediv>

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

    <synopsis>FillDistanceMap ( handle_fdr , handle_dst , outlet [, INLETS] )</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Arguments</title>
    <variablelist>
	  
      <varlistentry>
      <term>handle_fdr</term>
        <listitem>
          <para>
	  integer: handle on a flow direction grid</para>
	  </listitem>
      </varlistentry>

      <varlistentry>
      <term>handle_dst</term>
        <listitem>
          <para>
	  integer: handle on the raster that will receive the computed along-stream distances to the outlet. This raster is not created by the function, it must exists before and can be created with functions such as <literal>CreateFloatRaster</literal> or <literal>CreateConstantRaster</literal></para>
	  </listitem>
       </varlistentry>

      <varlistentry>
      <term>outlet</term>
        <listitem>
          <para>
	  integer: ID of the outlet pixel, as returned by <literal>XY2rec</literal></para>
	  </listitem>
      </varlistentry>

      <varlistentry>
      <term>outlet</term>
        <listitem>
          <para>
	  By default, the function computes the along-stream distance to the outlet pixel for all pixels upstream this outlet. If you want to exclude some subcatchments you can provide an additional argument which is a vector of inlet IDs. The recursive distance calculation will not go further upstream whenever one of these inlets is met.</para>
	  </listitem>
      </varlistentry>

</variablelist>
  </refsection>



  <refsection>
    <title>Description</title>

    <para>Computes along-stream distances to an outlet and writes the computed values to a raster.</para>

  </refsection>

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

   <refsection>
    <title>References</title>
    <para>
    </para>
  </refsection>
  
   <refsection><title>See Also</title><simplelist type='inline'>
    
      <member> 
         <link linkend='XY2rec'>XY2rec</link>, <link linkend='CreateFloatRaster'>CreateFloatRaster</link>, <link linkend='CreateConstantRaster'>CreateConstantRaster</link>
      </member>
     
   </simplelist></refsection>


  <refsection>
    <title>Authors</title>

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