* Bug #12906 fixed - Update help page of champ and champ1. 29/12529/3
Charlotte HECQUET [Fri, 13 Sep 2013 10:26:41 +0000 (12:26 +0200)]
Change-Id: Ib13908343749315e7e6adff5e535d4f9bc57b1e0

scilab/CHANGES_5.5.X
scilab/modules/graphics/help/en_US/2d_plot/champ.xml
scilab/modules/graphics/help/en_US/2d_plot/champ1.xml
scilab/modules/helptools/etc/images_md5.txt
scilab/modules/helptools/images/champ1_2.png [new file with mode: 0644]
scilab/modules/helptools/images/champ_3.png [new file with mode: 0644]

index 83f629d..6734416 100644 (file)
@@ -671,6 +671,8 @@ Bug Fixes
 
 * Bug #12875 fixed - phasemag returned an error for input vector containing zeros.
 
+* Bug #12906 fixed - champ and champ1 help pages updated
+
 * Bug #12909 fixed - Completion on (mt)list led to a crash.
 
 * Bug #12911 fixed - Matlab to Scilab dictionary help page updated for eig.
index 2c34407..1b20613 100644 (file)
         <para>
             Enter the command <code>champ()</code> to see a demo.
         </para>
+        <para>
+            Be cautioned about the fact that using <link linkend="meshgrid">meshgrid</link> function before
+            using <code>champ</code> requires adjustment. For more details, see the last example below.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -129,6 +133,24 @@ champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
         <scilab:image>
             champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
         </scilab:image>
+        <programlisting role="example"><![CDATA[
+// using meshgrid to get fx and fy
+clf()
+x = linspace(-1,1,30);
+y = linspace(-1,1,30);
+[X,Y] = meshgrid(x,y);
+fy = 2.*Y;
+fx = 2.*X;
+champ(x,y,fx',fy'); //here we have transposed fx and fy
+]]></programlisting>
+        <scilab:image>
+            x = linspace(-1,1,30);
+            y = linspace(-1,1,30);
+            [X,Y] = meshgrid(x,y);
+            fy = 2.*Y;
+            fx = 2.*X;
+            champ(x,y,fx',fy');
+        </scilab:image>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index c3636ec..930fa92 100644 (file)
         <para>
             Enter the command <code>champ1()</code> to see a demo.
         </para>
+        <para>
+            Be cautioned about the fact that using <link linkend="meshgrid">meshgrid</link> function before
+            using <code>champ1</code> requires adjustment. For more details, see the last example below.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -113,6 +117,24 @@ champ1(-5:5,-5:5,rand(11,11),rand(11,11),rect=[-10,-10,10,10],arfact=2)
         <scilab:image>
             champ1(-5:5,-5:5,rand(11,11),rand(11,11),rect=[-10,-10,10,10],arfact=2)
         </scilab:image>
+        <programlisting role="example"><![CDATA[
+// using meshgrid to get fx and fy
+clf()
+x = linspace(-1,1,30);
+y = linspace(-1,1,30);
+[X,Y] = meshgrid(x,y);
+fy = 2.*Y;
+fx = 2.*X;
+champ1(x,y,fx',fy'); //here we have transposed fx and fy
+]]></programlisting>
+        <scilab:image>
+            x = linspace(-1,1,30);
+            y = linspace(-1,1,30);
+            [X,Y] = meshgrid(x,y);
+            fy = 2.*Y;
+            fx = 2.*X;
+            champ1(x,y,fx',fy'); //here we have transposed fx and fy
+        </scilab:image>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index b0e1eca..3c74518 100644 (file)
@@ -667,8 +667,10 @@ cdfnor_1.png=3ff24d742eb574cda6f7ca5f8aa38ffe
 cdfnor_2.png=f6deb7f340aad408031249884d3849e0
 cepstrum_1.png=455b8e394db80f8bb6fb8c656a069af3
 champ1_1.png=d2aacf45d80c8edf7c95a54af1533ce4
+champ1_2.png=bc00271f4944a350125eb5b3c40d48c1
 champ_1.png=c0e293f757cc87203308abb3d0bd5823
 champ_2.png=83eb5af09a3e46812639bf482ce290e4
+champ_3.png=e46cb90fcd5bcc2552ee046eb1a1f216
 cheb1mag_1.png=3b26f5856ff8a2bcfbcf78e2d77cb5c1
 cheb2mag_1.png=d53206e41bccd28401ab6309ce2f941a
 color_1.png=8c94d2cd086d9ccb4ebc994bfd2dcf32
diff --git a/scilab/modules/helptools/images/champ1_2.png b/scilab/modules/helptools/images/champ1_2.png
new file mode 100644 (file)
index 0000000..98519b4
Binary files /dev/null and b/scilab/modules/helptools/images/champ1_2.png differ
diff --git a/scilab/modules/helptools/images/champ_3.png b/scilab/modules/helptools/images/champ_3.png
new file mode 100644 (file)
index 0000000..f0fd09b
Binary files /dev/null and b/scilab/modules/helptools/images/champ_3.png differ