<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>

  <TITLE>polarplot</TITLE>

  <TYPE>Scilab Function</TYPE>

  <DATE>April 2000</DATE>

  <SHORT_DESCRIPTION name="polarplot">Plot polar
  coordinates</SHORT_DESCRIPTION>

  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>polarplot(theta,rho,[style,strf,leg,rect])</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>polarplot(theta,rho,&lt;opt_args&gt;)</CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>

  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>rho</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: a vector, the radius values</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>theta</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: a vector with same size than rho, the angle values.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

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

        <PARAM_DESCRIPTION>
          <SP>: a sequence of statements <VERB>key1=value1, key2=value2</VERB>, ... where keys may be
          <VERB>style</VERB>,<VERB>leg</VERB>,<VERB>rect</VERB>,<VERB>strf</VERB>
          or <VERB>frameflag</VERB></SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>style</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: is a real row vector of size nc. The style to use for curve
          <VERB>i</VERB> is defined by <VERB>style(i)</VERB>. The default
          style is <VERB>1:nc</VERB> (1 for the first curve, 2 for the second,
          etc.).</SP>

          <PARAM_INDENT>
            <PARAM_ITEM>
              <PARAM_NAME>-</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>if <VERB>style(i)</VERB> is negative, the curve is plotted
                using the mark with id <VERB>abs(style(i))+1</VERB>; use
                <VERB>xset()</VERB> to see the mark ids.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>

            <PARAM_ITEM>
              <PARAM_NAME>-</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>if <VERB>style(i)</VERB> is strictly positive, a plain
                line with color id <VERB>style(i)</VERB> or a dashed line with
                dash id <VERB>style(i)</VERB> is used; use <VERB>xset()</VERB>
                to see the color ids.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>

            <PARAM_ITEM>
              <PARAM_NAME>-</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>When only one curve is drawn, <VERB>style</VERB> can be
                the row vector of size 2 <VERB>[sty,pos]</VERB> where
                <VERB>sty</VERB> is used to specify the style and
                <VERB>pos</VERB> is an integer ranging from 1 to 6 which
                specifies a position to use for the caption. This can be
                useful when a user wants to draw multiple curves on a plot by
                calling the function <VERB>plot2d</VERB> several times and
                wants to give a caption for each curve.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
          </PARAM_INDENT>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>strf</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: is a string of length 3 <VERB>"xy0"</VERB>.</SP>

          <PARAM_INDENT>
            <PARAM_ITEM>
              <PARAM_NAME>default</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>The default is <VERB>"030"</VERB>.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>

            <PARAM_ITEM>
              <PARAM_NAME>x</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>: controls the display of captions,</SP>

                <PARAM_INDENT>
                  <PARAM_ITEM>
                    <PARAM_NAME>x=0</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: no captions.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>x=1</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: captions are displayed. They are given by the
                      optional argument <VERB>leg</VERB>.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>
                </PARAM_INDENT>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>

            <PARAM_ITEM>
              <PARAM_NAME>y</PARAM_NAME>

              <PARAM_DESCRIPTION>
                <SP>: controls the computation of the frame. same as
                frameflag</SP>

                <PARAM_INDENT>
                  <PARAM_ITEM>
                    <PARAM_NAME>y=0</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: the current boundaries (set by a previous call to
                      another high level plotting function) are used. Useful
                      when superposing multiple plots.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=1</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: the optional argument <VERB>rect</VERB> is used to
                      specify the boundaries of the plot.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=2</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: the boundaries of the plot are computed using min
                      and max values of <VERB>x</VERB> and
                      <VERB>y</VERB>.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=3</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=1</VERB> but produces isoview
                      scaling.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=4</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=2</VERB> but produces isoview
                      scaling.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=5</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=1</VERB> but <VERB>plot2d</VERB> can
                      change the boundaries of the plot and the ticks of the
                      axes to produce pretty graduations. When the zoom button
                      is activated, this mode is used.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=6</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=2</VERB> but <VERB>plot2d</VERB> can
                      change the boundaries of the plot and the ticks of the
                      axes to produce pretty graduations. When the zoom button
                      is activated, this mode is used.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=7</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=5</VERB> but the scale of the new
                      plot is merged with the current scale.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>

                  <PARAM_ITEM>
                    <PARAM_NAME>y=8</PARAM_NAME>

                    <PARAM_DESCRIPTION>
                      <SP>: like <VERB>y=6</VERB> but the scale of the new
                      plot is merged with the current scale.</SP>
                    </PARAM_DESCRIPTION>
                  </PARAM_ITEM>
                </PARAM_INDENT>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
          </PARAM_INDENT>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>leg</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: a string. It is used when the first character x of argument
          <VERB>strf</VERB> is 1. <VERB>leg</VERB> has the form
          <VERB>"leg1@leg2@...."</VERB> where <VERB>leg1</VERB>,
          <VERB>leg2</VERB>, etc. are respectively the captions of the first
          curve, of the second curve, etc. The default is <VERB>""</VERB>.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>rect</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: This argument is used when the second character y of argument
          <VERB>strf</VERB> is 1, 3 or 5. It is a row vector of size 4 and
          gives the dimension of the frame:
          <VERB>rect=[xmin,ymin,xmax,ymax]</VERB>.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>

  <DESCRIPTION>
    <P>polarplot creates a polar coordinate plot of the angle theta versus the
    radius rho. theta is the angle from the x-axis to the radius vector
    specified in radians; rho is the length of the radius vector specified in
    dataspace units.</P>
  </DESCRIPTION>

  <EXAMPLE><![CDATA[

t= 0:.01:2*%pi;
clf();polarplot(sin(7*t),cos(8*t))

clf();polarplot([sin(7*t') sin(6*t')],[cos(8*t') cos(8*t')],[1,2])

 
  ]]></EXAMPLE>
</MAN>
