update CHANGES and homepage before the release
[scilab.git] / scilab / modules / graphics / help / pt_BR / color_management / colorbar.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="colorbar" xml:lang="pt">
3     <refnamediv>
4         <refname>colorbar</refname>
5         <refpurpose>Desenha uma barra de cores</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Seqüência de Chamamento</title>
9         <synopsis>colorbar(umin, umax [, colminmax, fmt])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Parâmetros</title>
13         <variablelist>
14             <varlistentry>
15                 <term>umin</term>
16                 <listitem>
17                     <para>escalar real, o valor mínimo associado ao esboço </para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>umax</term>
22                 <listitem>
23                     <para>escalar real, o valor máximo associado ao esboço </para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>colminmax</term>
28                 <listitem>
29                     <para>(opcional) um vetor com dois componentes inteiros</para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>fmt</term>
34                 <listitem>
35                     <para>(optional) um string para se ajustar o formato de exbição para
36                         as graduações da barra de cores
37                     </para>
38                 </listitem>
39             </varlistentry>
40         </variablelist>
41     </refsection>
42     <refsection>
43         <title>Descrição</title>
44         <para>Desenha uma barra de cores para um plot3d, fec, Sgrayplot, etc...
45             Esta função deve ser chamada <emphasis role="bold">BEFORE</emphasis> do
46             plot3d, fec, Sgrayplot,... porque ela ajusta e modifica a moldura para o
47             esboço. Desta forma, a barra de cores não é parte do esboço associado e,
48             assim, não é modificada por uma ampliação/diminuição ou rotação. 
49         </para>
50         <para>
51             O argumento opcional <literal>colminmax</literal> pode ser utilizado
52             para precisar a primeira cor (associada a umin) e a última cor (associada
53             a umax) do mapa de cores corrente. Por padrão <literal>colminmax=[1
54                 nb_colors]
55             </literal>
56             onde nb_colors é o número de cores do mapa de cores
57             corrente. 
58         </para>
59         <para>
60             O argumento opcional <literal>fmt</literal> é um string com formato
61             C, como <literal>"%.2f"</literal>, <literal>"%e"</literal>, etc...
62         </para>
63         <para>Para os dois argumentos opcionais, você pode utilizar a sintaxe
64             <literal>keyword=value</literal> que é útil para fornecer o formato sem
65             fornecer <literal>colminmax</literal> (veja o útilmo exemplo).
66         </para>
67     </refsection>
68     <refsection>
69         <title>Examples</title>
70         <programlisting role="example"><![CDATA[
71 // exemplo 1
72 x = linspace(0,1,81);
73 z = cos(2*%pi*x)'*sin(2*%pi*x);
74 zm = min(z); zM = max(z);
75 clf()
76 gcf().color_map = jetcolormap(64);
77 colorbar(zm,zM)
78 Sgrayplot(x,x,z)
79 xtitle("The function cos(2 pi x)sin(2 pi y)")
80
81 // exemplo 2
82 x = linspace(0,1,81);
83 z = cos(2*%pi*x)'*sin(2*%pi*x);
84 zm = min(z); zM = max(z);
85 zz = abs(0.5*cos(2*%pi*x)'*cos(2*%pi*x));
86 zzm = min(zz); zzM = max(zz);
87 clf();
88 gcf().color_map = jetcolormap(64);
89
90 drawlater() ;
91 subplot(2,2,1)
92    colorbar(zm,zM)
93    Sgrayplot(x,x,z, strf="031", rect=[0 0 1 1])
94    xtitle("um Sgrayplot com barra de cores")
95 subplot(2,2,2)
96    colorbar(zm,zM)
97    plot3d1(x,x,z)
98    xtitle("um plot3d1 com barra de cores")
99 subplot(2,2,3)
100    colorbar(zzm,zzM)
101    plot3d1(x,x,zz)
102    xtitle("um plot3d1 com barra de cores")
103 subplot(2,2,4)
104    colorbar(zzm,zzM)
105    Sgrayplot(x,x,zz, strf="031", rect=[0 0 1 1])
106    xtitle("um Sgrayplot com barra de cores")
107 drawnow() ;
108
109 // exemplo 3
110 x = linspace(0,1,81);
111 zz = abs(0.5*cos(2*%pi*x)'*cos(2*%pi*x));
112 zzm = min(zz); zzM = max(zz);
113 [xf,yf,zf]=genfac3d(x,x,zz);
114 nb_col = 64;
115 clf()
116 gcf().color_map = hotcolormap(nb_col);
117 drawlater() ;
118 colorbar(zzm,zzM,fmt="%.1f")
119 zcol = dsearch(zf, linspace(zzm, zzM, nb_col+1));
120 plot3d(xf, yf, list(zf, zcol), flag = [-2 6 4])
121 xtitle("um plot3d com cores de gradação interpolada")
122 drawnow() ;
123 show_window()
124  ]]></programlisting>
125     </refsection>
126     <refsection role="see also">
127         <title>See also</title>
128         <simplelist type="inline">
129             <member>
130                 <link linkend="colormap">colormap</link>
131             </member>
132         </simplelist>
133     </refsection>
134 </refentry>