From: <rla...@us...> - 2004-02-22 21:10:58
|
Update of /cvsroot/plplot/plplot/doc/docbook/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23737/doc/docbook/src Modified Files: Tag: CFDIR api-fortran.xml api.xml plplotdoc.xml.in Log Message: Merged with HEAD. Documentation for the CFDIR branch is extensively added to cf/README. The CFDIR branch is now ready for testing. Index: api-fortran.xml =================================================================== RCS file: /cvsroot/plplot/plplot/doc/docbook/src/api-fortran.xml,v retrieving revision 1.7 retrieving revision 1.7.4.1 diff -u -d -r1.7 -r1.7.4.1 --- api-fortran.xml 17 Jan 2004 16:41:38 -0000 1.7 +++ api-fortran.xml 22 Feb 2004 20:57:22 -0000 1.7.4.1 @@ -4,6 +4,7 @@ Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun Copyright (C) 1999, 2000, 2001, 2002, 2003 Alan W. Irwin and Rafael Laboissiere Copyright (C) 2003 Joao Cardoso + Copyright (C) 2004 Andrew Ross Redistribution and use in source (XML DocBook) and "compiled" forms (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without @@ -486,6 +487,315 @@ </sect1> + <sect1 id="plvec0" renderas="sect3"> + <title> + <function>plvec0</function>: Vector plot, identity mapping for fortran + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plvec0</function> + </funcdef> + <paramdef><parameter>u</parameter></paramdef> + <paramdef><parameter>v</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>scale</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Draws a vector plot of the data in + <literal>(<parameter>u</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>], <parameter>v</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>])</literal>. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>u, v</parameter> + (<literal>PLFLT **</literal>, input) + </term> + <listitem> + <para> + Pointer to a pair of vectored two-dimensional arrays containing + the x and y components of the vector to be plotted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nx, ny</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Physical dimensions of the arrays + <literal><parameter>u</parameter></literal> and + <literal><parameter>v</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>scale</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Parameter to control the scaling factor of the vectors for plotting. + If <literal><parameter>scale</parameter> = 0</literal> then + the scaling factor is automatically calculated for the data. + If <literal><parameter>scale</parameter> < 0</literal> then + the scaling factor is automatically calculated for the data and + then multiplied by <literal>-<parameter>scale</parameter></literal>. + If <literal><parameter>scale</parameter> > 0</literal> then + the scaling factor is set to <literal><parameter>scale</parameter></literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + NOTE: this function is intended for use from a Fortran caller only. + The C user should instead call &plvect; using the built-in + transformation function <function>pltr0</function> for the same + capability. + </para> + </sect1> + + <sect1 id="plvec1" renderas="sect3"> + <title> + <function>plvec1</function>: Vector plot, general 1-d mapping for +fortran + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plvec1</function> + </funcdef> + <paramdef><parameter>u</parameter></paramdef> + <paramdef><parameter>v</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>scale</parameter></paramdef> + <paramdef><parameter>xg</parameter></paramdef> + <paramdef><parameter>yg</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Draws a vector plot of the data in + <literal>(<parameter>u</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>], <parameter>v</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>])</literal>. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>u, v</parameter> + (<literal>PLFLT **</literal>, input) + </term> + <listitem> + <para> + Pointer to a pair of vectored two-dimensional arrays containing + the x and y components of the vector to be plotted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nx, ny</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Physical dimensions of the arrays + <literal><parameter>u</parameter></literal> and + <literal><parameter>v</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>scale</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Parameter to control the scaling factor of the vectors for plotting. + If <literal><parameter>scale</parameter> = 0</literal> then + the scaling factor is automatically calculated for the data. + If <literal><parameter>scale</parameter> < 0</literal> then + the scaling factor is automatically calculated for the data and + then multiplied by <literal>-<parameter>scale</parameter></literal>. + If <literal><parameter>scale</parameter> > 0</literal> then + the scaling factor is set to <literal><parameter>scale</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>xg, yg</parameter> + (<literal>PLFLT *</literal>, input) + </term> + <listitem> + <para> + Pointers to arrays which specify the transformation from array + indices to world coordinates. These must be one-dimensional + arrays, used for a transformation of the form: + <literal>tx</literal> = <literal>f(x)</literal>, + <literal>ty</literal> = <literal>f(y)</literal>. Function + values at locations between grid points are obtained via linear + interpolation. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + NOTE: this function is intended for use from a Fortran caller only. + The C user should instead call &plvect; using the built-in + transformation function <function>pltr1</function> for the same + capability. + </para> + + </sect1> + + <sect1 id="plvec2" renderas="sect3"> + <title> + <function>plvec2</function>: Vector plot, general 2-d mapping for +fortran + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plvec2</function> + </funcdef> + <paramdef><parameter>u</parameter></paramdef> + <paramdef><parameter>v</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>scale</parameter></paramdef> + <paramdef><parameter>xg</parameter></paramdef> + <paramdef><parameter>yg</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + <para> + Draws a vector plot of the data in + <literal>(<parameter>u</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>], <parameter>v</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>])</literal>. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>u, v</parameter> + (<literal>PLFLT **</literal>, input) + </term> + <listitem> + <para> + Pointer to a pair of vectored two-dimensional arrays containing + the x and y components of the vector to be plotted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nx, ny</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Physical dimensions of the arrays + <literal><parameter>u</parameter></literal> and + <literal><parameter>v</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>scale</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Parameter to control the scaling factor of the vectors for plotting. + If <literal><parameter>scale</parameter> = 0</literal> then + the scaling factor is automatically calculated for the data. + If <literal><parameter>scale</parameter> < 0</literal> then + the scaling factor is automatically calculated for the data and + then multiplied by <literal>-<parameter>scale</parameter></literal>. + If <literal><parameter>scale</parameter> > 0</literal> then + the scaling factor is set to <literal><parameter>scale</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>xg, yg</parameter> + (<literal>PLFLT *</literal>, input) + </term> + <listitem> + <para> + Pointers to arrays which specify the transformation from array + indices to world coordinates. These must be two-dimensional + arrays, used for a transformation of the form: + <literal>tx</literal> = <literal>f(x, y)</literal>, + <literal>ty</literal> = <literal>f(x, y)</literal>. Function + values at locations between grid points are obtained via linear + interpolation. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + NOTE: this function is intended for use from a Fortran caller only. + The C user should instead call &plvect; using the built-in + transformation function <function>pltr2</function> for the same + capability. + </para> + + </sect1> + + <sect1 id="plvectfortran" renderas="sect3"> + <title> + <function>plvect</function>: Vector plot, fixed linear mapping for +fortran + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plvect</function> + </funcdef> + <paramdef><parameter>u</parameter></paramdef> + <paramdef><parameter>v</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>scale</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + When called from Fortran, this routine has the same effect as when + invoked from C. The interpretation of all parameters (see &plvect;) + is also the same except there is no transformation function supplied + as the last parameter. Instead, a 6-element array specifying + coefficients to use in the transformation is supplied via the named + common block <literal>plplot</literal> (see code). Since this + approach is somewhat inflexible, the user is recommended to call + either of &plvec0;, &plvec1;, or &plvec2; instead. + </para> + + </sect1> + <sect1 id="plmeshfortran" renderas="sect3"> <title> <function>plmesh</function>: Plot surface mesh for fortran Index: api.xml =================================================================== RCS file: /cvsroot/plplot/plplot/doc/docbook/src/api.xml,v retrieving revision 1.62 retrieving revision 1.62.4.1 diff -u -d -r1.62 -r1.62.4.1 --- api.xml 17 Jan 2004 16:41:38 -0000 1.62 +++ api.xml 22 Feb 2004 20:57:22 -0000 1.62.4.1 @@ -5,6 +5,7 @@ Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Alan W. Irwin Copyright (C) 1999, 2000, 2001, 2002, 2003 Rafael Laboissiere Copyright (C) 2003 Joao Cardoso + Copyright (C) 2004 Andrew Ross Redistribution and use in source (XML DocBook) and "compiled" forms (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without @@ -9651,6 +9652,75 @@ </sect1> + <sect1 id="plsvect" renderas="sect3"> + <title> + <function>plsvect</function>: Set arrow style for vector plots + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plsvect</function> + </funcdef> + <paramdef><parameter>arrowx</parameter></paramdef> + <paramdef><parameter>arrowy</parameter></paramdef> + <paramdef><parameter>npts</parameter></paramdef> + <paramdef><parameter>fill</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Set the style for the arrow used by &plvect; to plot vectors. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>arrowx, arrowy</parameter> + (<literal>PLFLT *</literal>,input) + </term> + <listitem> + <para> + Pointers to a pair of arrays containing the x and y points + which make up the arrow. The arrow is plotted by joining these + points to form a polygon. The scaling assumes that the x and y + points in the arrow lie in the range + <literal>-0.5 <= x,y <= 0.5</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>npts</parameter> + (<literal>PLINT</literal>,input) + </term> + <listitem> + <para> + Number of points in the arrays + <literal><parameter>arrowx</parameter></literal> and + <literal><parameter>arrowy</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>fill</parameter> + (<literal>PLINT</literal>,input) + </term> + <listitem> + <para> + If <literal><parameter>fill</parameter> = 0</literal> then the + arrow is open, if <literal><parameter>fill</parameter> = 1</literal> + then the arrow is filled. + </para> + </listitem> + </varlistentry> + </variablelist> + + </sect1> + <sect1 id="plsvpa" renderas="sect3"> <title> <function>plsvpa</function>: Specify viewport in absolute coordinates @@ -10046,6 +10116,126 @@ </sect1> + <sect1 id="plvect" renderas="sect3"> + <title> + <function>plvect</function>: Vector plot + </title> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef> + <function>plvect</function> + </funcdef> + <paramdef><parameter>u</parameter></paramdef> + <paramdef><parameter>v</parameter></paramdef> + <paramdef><parameter>nx</parameter></paramdef> + <paramdef><parameter>ny</parameter></paramdef> + <paramdef><parameter>scale</parameter></paramdef> + <paramdef><parameter>pltr</parameter></paramdef> + <paramdef><parameter>pltr_data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </para> + + <para> + Draws a vector plot of the vector + <literal>(<parameter>u</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>],<parameter>v</parameter>[<parameter>nx</parameter>][<parameter>ny</parameter>])</literal>. + The scaling factor for the vectors is given by + <literal><parameter>scale</parameter></literal>. A + transformation routine pointed to by <literal><parameter>pltr</parameter></literal> + with a pointer <literal><parameter>pltr_data</parameter></literal> + for additional data required by the transformation routine + is used to map indices within the array + to the world coordinates. The style of the vector arrow may be set using + &plsvect;. + </para> + + <variablelist> + <varlistentry> + <term> + <parameter>u, v</parameter> + (<literal>PLFLT **</literal>, input) + </term> + <listitem> + <para> + Pointers to a pair of vectored two-dimensional arrays + containing the x and y components of the vector data to be + plotted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>nx, ny</parameter> + (<literal>PLINT</literal>, input) + </term> + <listitem> + <para> + Physical dimensions of the arrays + <literal><parameter>u</parameter></literal> and + <literal><parameter>v</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>scale</parameter> + (<literal>PLFLT</literal>, input) + </term> + <listitem> + <para> + Parameter to control the scaling factor of the vectors for plotting. + If <literal><parameter>scale</parameter> = 0</literal> then + the scaling factor is automatically calculated for the data. + If <literal><parameter>scale</parameter> < 0</literal> then + the scaling factor is automatically calculated for the data and + then multiplied by <literal>-<parameter>scale</parameter></literal>. + If <literal><parameter>scale</parameter> > 0</literal> then + the scaling factor is set to <literal><parameter>scale</parameter></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>pltr</parameter> + (<literal>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) + </literal>, input) + </term> + <listitem> + <para> + Pointer to function that defines transformation between indices + in array <literal><parameter>z</parameter></literal> and the + world coordinates (C only). Transformation functions are + provided in the PLplot library: + &pltr0; for identity mapping, and &pltr1; and &pltr2; for + arbitrary mappings respectively defined by one- and + two-dimensional arrays. In addition, user-supplied routines + for the transformation can be used as well. Examples of + all of these approaches are given in + <xref linkend="contour-plots-c"/>. + The transformation function should + have the form given by any of &pltr0;, &pltr1;, or &pltr2;. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>pltr_data</parameter> + (<literal>PLPointer</literal>, input) + </term> + <listitem> + <para> + Extra parameter to help + pass information to &pltr0;, &pltr1;, &pltr2;, or whatever routine + that is externally supplied. + </para> + </listitem> + </varlistentry> + </variablelist> + + </sect1> + <sect1 id="plvpas" renderas="sect3"> <title> <function>plvpas</function>: Specify viewport using coordinates and aspect ratio Index: plplotdoc.xml.in =================================================================== RCS file: /cvsroot/plplot/plplot/doc/docbook/src/plplotdoc.xml.in,v retrieving revision 1.33 retrieving revision 1.33.4.1 diff -u -d -r1.33 -r1.33.4.1 --- plplotdoc.xml.in 22 Jan 2004 21:51:45 -0000 1.33 +++ plplotdoc.xml.in 22 Feb 2004 20:57:22 -0000 1.33.4.1 @@ -187,6 +187,7 @@ <!ENTITY plstart '<link linkend="plstart"><function>plstart</function></link>'> <!ENTITY plstyl '<link linkend="plstyl"><function>plstyl</function></link>'> <!ENTITY plsurf3d '<link linkend="plsurf3d"><function>plsurf3d</function></link>'> +<!ENTITY plsvect '<link linkend="plsvect"><function>plsvect</function></link>'> <!ENTITY plsvpa '<link linkend="plsvpa"><function>plsvpa</function></link>'> <!ENTITY plsxax '<link linkend="plsxax"><function>plsxax</function></link>'> <!ENTITY plsyax '<link linkend="plsyax"><function>plsyax</function></link>'> @@ -197,6 +198,11 @@ <!ENTITY pltr1 '<link linkend="pltr1"><function>pltr1</function></link>'> <!ENTITY pltr2 '<link linkend="pltr2"><function>pltr2</function></link>'> <!ENTITY plvasp '<link linkend="plvasp"><function>plvasp</function></link>'> +<!ENTITY plvec0 '<link linkend="plvec0"><function>plvec0</function></link>'> +<!ENTITY plvec1 '<link linkend="plvec1"><function>plvec1</function></link>'> +<!ENTITY plvec2 '<link linkend="plvec2"><function>plvec2</function></link>'> +<!ENTITY plvect '<link linkend="plvect"><function>plvect</function></link>'> +<!ENTITY plvectfortran '<link linkend="plvectfortran"><function>plvectfortran</function></link>'> <!ENTITY plvpas '<link linkend="plvpas"><function>plvpas</function></link>'> <!ENTITY plvpor '<link linkend="plvpor"><function>plvpor</function></link>'> <!ENTITY plvsta '<link linkend="plvsta"><function>plvsta</function></link>'> |