e57cce49fb0f18afccef138c8cdd600de1364140
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / wintercolormap.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Serge Steer
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="wintercolormap">
17     <refnamediv>
18         <refname>wintercolormap</refname>
19         <refpurpose>blue to green colormap</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>cmap=wintercolormap(n)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>n</term>
30                 <listitem>
31                     <para>integer &gt;= 3, the colormap size.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>cmap</term>
36                 <listitem>
37                     <para>
38                         matrix with 3 columns <literal>[R,G,B]</literal>.
39                     </para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             <literal>wintercolormap</literal> computes a colormap with <literal>n</literal> colors
48             varying from blue to green.
49         </para>
50     </refsection>
51     <refsection>
52         <title>Examples</title>
53         <programlisting role="example"><![CDATA[ 
54 f = scf();
55 plot3d1();
56 f.color_map = wintercolormap(32);
57  ]]></programlisting>
58         <scilab:image> 
59             f = scf();
60             plot3d1();
61             f.color_map = wintercolormap(32);
62         </scilab:image>
63         
64     </refsection>
65     <refsection role="see also">
66         <title>See also</title>
67         <simplelist type="inline">
68             <member>
69                 <link linkend="colormap">colormap</link>
70             </member>
71             <member>
72                 <link linkend="autumncolormap">autumncolormap</link>
73             </member>
74             <member>
75                 <link linkend="bonecolormap">bonecolormap</link>
76             </member>
77             <member>
78                 <link linkend="coolcolormap">coolcolormap</link>
79             </member>
80             <member>
81                 <link linkend="coppercolormap">coppercolormap</link>
82             </member>
83             <member>
84                 <link linkend="graycolormap">graycolormap</link>
85             </member>
86             <member>
87                 <link linkend="hotcolormap">hotcolormap</link>
88             </member>
89             <member>
90                 <link linkend="hsvcolormap">hsvcolormap</link>
91             </member>
92             <member>
93                 <link linkend="jetcolormap">jetcolormap</link>
94             </member>
95             <member>
96                 <link linkend="oceancolormap">oceancolormap</link>
97             </member>
98             <member>
99                 <link linkend="parulacolormap">parulacolormap</link>
100             </member>
101             <member>
102                 <link linkend="pinkcolormap">pinkcolormap</link>
103             </member>
104             <member>
105                 <link linkend="rainbowcolormap">rainbowcolormap</link>
106             </member>
107             <member>
108                 <link linkend="springcolormap">springcolormap</link>
109             </member>
110             <member>
111                 <link linkend="summercolormap">summercolormap</link>
112             </member>
113             <member>
114                 <link linkend="whitecolormap">whitecolormap</link>
115             </member>
116         </simplelist>
117     </refsection>
118 </refentry>