<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<?xml-stylesheet type="text/xsl" href="file:///usr/local/lib/scilab/man/eng/html-rev.xsl"?>
<MAN>
  <LANGUAGE>eng</LANGUAGE>

  <TITLE>mesh</TITLE>

  <TYPE>Scilab Function</TYPE>

  <DATE>2005</DATE>

  <SHORT_DESCRIPTION name="mesh">3D mesh plot</SHORT_DESCRIPTION>

  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>mesh(Z)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>mesh(X,Y,Z)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>mesh(...,&lt;GlobalProperty&gt;)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>mesh(...,&lt;color&gt;,&lt;GlobalProperty&gt;)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>mesh(&lt;axes_handle&gt;,...)</CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>

  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>Z</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: a real matrix defining the surface height. It can not be
          omitted. The Z data is a<VERB> m</VERB>x<VERB>n</VERB> matrix.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>X,Y</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: two real matrices : always set together, these data defines a
          new standard grid. This new <VERB>X</VERB> and <VERB>Y</VERB>
          components of the grid must match <VERB>Z</VERB> dimensions (see
          description below).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>color</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: an optional real matrix defining a color value for each
          <VERB>(X(j),Y(i))</VERB> point of the grid (see description
          below).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>&lt;GlobalProperty&gt;</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: This optional argument represents a sequence of couple
          statements <VERB>{PropertyName,PropertyValue}</VERB> that defines
          global objects' properties applied to all the curves created by this
          plot. For a complete view of the available properties (see
          <LINK>GlobalProperty</LINK>).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>&lt;axes_handle&gt;</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: This optional argument forces the plot to appear inside the
          selected axes given by <VERB>axes_handle</VERB> rather than the
          current axes (see <LINK>gca</LINK>).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>

  <DESCRIPTION>
    <P><VERB>mesh</VERB> draws a parametric surface using a rectangular grid
    defined by <VERB>X</VERB> and <VERB>Y</VERB> coordinates (if
    <VERB>{X,Y}</VERB> are not specified, this grid is determined using the
    dimensions of the <VERB>Z</VERB> matrix) ; at each point of this grid, a Z
    coordinate is given using the <VERB>Z</VERB> matrix. <VERB>mesh</VERB> is
    based on the <VERB>surf</VERB> command with default option
    <VERB>color_mode</VERB> = white index (inside the current colormap) and
    <VERB>color_flag</VERB> = 0.</P>

    <P>Data entry specification :</P>

    <P>In this paragraph and to be more clear, we won't mention
    <VERB>GlobalProperty</VERB> optional arguments as they do not interfer
    with entry data (except for <VERB>"Xdata"</VERB>, <VERB>"Ydata"</VERB> and
    <VERB>"Zdata"</VERB> property, see <LINK>GlobalProperty</LINK>). It is
    assumed that all those optional arguments could be present too.</P>

    <P>If <VERB>Z</VERB> is the only matrix specified, (Z) plots the matrix
    <VERB>Z</VERB> versus the grid defined by <VERB>1:size(Z,2)</VERB> along
    the x axis and <VERB>1:size(Z,1)</VERB> along the y axis.</P>
  </DESCRIPTION>

  <SECTION label="Remarks">
    <P>To enable the tranparency mode you should set the <VERB>color_mode
    </VERB>option to 0.</P>
  </SECTION>

  <EXAMPLE><![CDATA[
[X,Y]=meshgrid(-1:.1:1,-1:.1:1);
Z=X.^2-Y.^2;
xtitle('z=x2-y ^2');
mesh(X,Y,Z);
]]></EXAMPLE>

  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>surf</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>meshgrid</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>plot2d</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>LineSpec</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>GlobalProperty</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>

  <AUTHOR>F.Belahcene</AUTHOR>
</MAN>