17538593b930c7cde13c1b63eeea78f39b22f331
[scilab.git] / scilab / modules / elementary_functions / help / en_US / elementarymatrices / ndgrid.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:ns5="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="ndgrid" xml:lang="en">
3     <refnamediv>
4         <refname>ndgrid</refname>
5         <refpurpose>build matrices or N-D arrays by replicating some template vectors
6             
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Syntax</title>
11         <synopsis>
12                [X, Y] = ndgrid(x,y)
13             [X, Y, Z] = ndgrid(x,y,z)
14          [X, Y, Z, T] = ndgrid(x,y,z,t)
15     [X1, X2, ..., Xm] = ndgrid(x1,x2,...,xm)
16         </synopsis>
17     </refsynopsisdiv>
18     <refsection role="arguments">
19         <title>Arguments</title>
20         <variablelist>
21             <varlistentry>
22                 <term>x, y, z, ...</term>
23                 <listitem>
24                     <para>vectors of any data types. They may have distinct data types.</para>
25                 </listitem>
26             </varlistentry>
27             <varlistentry>
28                 <term>X, Y, Z, ...</term>
29                 <listitem>
30                     <para>
31                         matrices in case of 2 input arguments, or hypermatrices otherwise. They all have the same sizes: <code>size(x,"*")</code> rows, <code>size(y,"*")</code> columns, <code>size(z,"*")</code> layers, etc. They have the datatypes of respective input vectors: <literal>typeof(X)==typeof(x)</literal>, <literal>typeof(Y)==typeof(y)</literal>, etc.
32                     </para>
33                 </listitem>
34             </varlistentry>
35         </variablelist>
36     </refsection>
37     <refsection role="description">
38         <title>Description</title>
39         <para>
40             The first application of <function>ndgrid</function> is to build a grid of nodes meshing the 2D or 3D or N-D space according to 2, 3, or more sets <literal>x</literal>, <literal>y</literal>, etc.. of "template" coordinates sampled along each direction/dimension of the space that you want to mesh.
41         </para>
42         <para>
43             Hence, the matrix or hypermatrix <literal>X</literal> is made by replicating the vector <literal>x</literal> as all its columns ; the matrix or hypermatrix <literal>Y</literal> is made by replicating the vector <literal>y</literal> as all its rows ; <literal>Z</literal> is made of replicating the vector <literal>z</literal> along all its local thicknesses (3rd dimension); etc.
44         </para>
45         <screen><![CDATA[--> [X, Y] = ndgrid([1 3 4], [0 2 4 6])
46  X  = 
47    1.   1.   1.   1.
48    3.   3.   3.   3.
49    4.   4.   4.   4.
50
51    Y  = 
52    0.   2.   4.   6.
53    0.   2.   4.   6.
54    0.   2.   4.   6.
55 ]]></screen>
56         <para>
57             Then, the coordinates of the node(i,j) in the 2D space will be simply <literal>[x(i), y(j)]</literal> now given by <literal>[X(i,j), Y(i,j)]</literal>. As well, the coordinates of a <literal>node(i,j,k)</literal> of a 3D grid will be <literal>[x(i), y(j), z(k)]</literal> now given by <literal>[X(i,j,k), Y(i,j,k), Z(i,j,k)]</literal>.
58         </para>
59         <para>This replication scheme can be generalized to any number of dimensions, as well to any type of uniform data. Let's for instance consider 2 attributes:
60             <orderedlist>
61                 <listitem>
62                     The first is a number, to be chosen from the vector say <literal>n= [ 3 7 ]</literal>
63                 </listitem>
64                 <listitem>
65                     The second is a letter, to be chosen from the vector say <literal>c= ["a" "e" "i" "o" "u" "y"]</literal>
66                 </listitem>
67             </orderedlist>
68             Then we want to build the set of all {n,c} possible pairs. It will just be the 2D grid:
69         </para>
70         <screen><![CDATA[--> [N, C] = ndgrid([3 7],["a" "e" "i" "o" "u" "y"])
71  C  = 
72 !a  e  i  o  u  y  !
73 !a  e  i  o  u  y  !
74
75  N  = 
76    3.   3.   3.   3.   3.   3.
77    7.   7.   7.   7.   7.   7.
78 ]]></screen>
79         <para>
80             Then, the object(i,j) will have the properties <literal>{n(i) c(j)}</literal> that now can be addressed with <literal>{N(i,j) C(i,j)}</literal>. This kind of grid may be useful to initialize an array of structures.
81         </para>
82         <para>
83             Following examples show how to use <varname>X, Y, Z</varname> in most frequent applications.
84         </para>
85     </refsection>
86     <refsection role="examples">
87         <title>Examples</title>
88         <para>
89             <emphasis role="bold">Example #1:</emphasis>
90         </para>
91         <programlisting role="example"><![CDATA[  
92 // Create a simple 2d grid
93 x = linspace(-10,2,40);
94 y = linspace(-5,5,40);
95 [X,Y] = ndgrid(x,y);
96
97 // Compute ordinates Z(X,Y) on the {X, Y} grid and plot Z(X,Y)
98 Z = X - 3*X.*sin(X).*cos(Y-4) ;
99 clf()
100 plot3d(x,y,Z, flag=[color("green") 2 4], alpha=7, theta=60); show_window()
101  ]]></programlisting>
102         <scilab:image><![CDATA[  
103 x = linspace(-10,2,40);
104 y = linspace(-5,5,40);
105
106 [X,Y] = ndgrid(x,y);
107 Z = X - 3*X.*sin(X).*cos(Y-4) ;
108
109 clf()
110 plot3d(x,y,Z, flag=[color("green") 2 4], alpha=7, theta=60); show_window()
111 ]]></scilab:image>
112         <para>
113             <emphasis role="bold">Example #2:</emphasis>
114         </para>
115         <programlisting role="example"><![CDATA[  
116 // Create a simple 3d grid
117 nx = 10; ny = 6; nz = 4;
118 x = linspace(0,2,nx);
119 y = linspace(0,1,ny);
120 z = linspace(0,0.5,nz);
121 [X,Y,Z] = ndgrid(x,y,z);
122
123 // Try to display this 3d grid
124 XF=[]; YF=[]; ZF=[];
125
126 for k=1:nz
127    [xf,yf,zf] = nf3d(X(:,:,k),Y(:,:,k),Z(:,:,k));
128    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
129 end
130
131 for j=1:ny
132    [xf,yf,zf] = nf3d(matrix(X(:,j,:),[nx,nz]),...
133                      matrix(Y(:,j,:),[nx,nz]),...
134                      matrix(Z(:,j,:),[nx,nz]));
135    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
136 end
137
138 clf()
139 plot3d(XF,YF,ZF, flag=[0 6 3], 66, 61,leg="X@Y@Z")
140 xtitle("A 3d grid !"); show_window()
141  ]]></programlisting>
142         <scilab:image><![CDATA[
143 nx = 10; ny = 6; nz = 4;
144 x = linspace(0,2,nx);
145 y = linspace(0,1,ny);
146 z = linspace(0,0.5,nz);
147
148 [X,Y,Z] = ndgrid(x,y,z);
149 XF=[]; YF=[]; ZF=[];
150
151 for k=1:nz
152         [xf,yf,zf] = nf3d(X(:,:,k),Y(:,:,k),Z(:,:,k));
153         XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
154 end
155
156 for j=1:ny
157         [xf,yf,zf] = nf3d(matrix(X(:,j,:),[nx,nz]),...
158         matrix(Y(:,j,:),[nx,nz]),...
159         matrix(Z(:,j,:),[nx,nz]));
160
161         XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
162 end
163
164 plot3d(XF,YF,ZF, flag=[0 6 3], 66, 61, leg="X@Y@Z")
165 xtitle("A 3d grid !");
166          ]]></scilab:image>
167         <para>
168             <emphasis role="bold">Example #3: Creates a table of digrams:</emphasis>
169         </para>
170         <programlisting role="example"><![CDATA[  
171 [c1, c2] = ndgrid(["a" "b" "c"], ["a" "b" "c" "d" "e" "f" "g" "h"])
172 c1+c2
173  ]]></programlisting>
174         <screen><![CDATA[--> [c1, c2] = ndgrid(["a" "b" "c"], ["a" "b" "c" "d" "e" "f" "g" "h"])
175  c2  = 
176 !a  b  c  d  e  f  g  h  !
177 !a  b  c  d  e  f  g  h  !
178 !a  b  c  d  e  f  g  h  !
179
180  c1  = 
181 !a  a  a  a  a  a  a  a  !
182 !b  b  b  b  b  b  b  b  !
183 !c  c  c  c  c  c  c  c  !
184
185 --> c1+c2
186  ans  =
187 !aa  ab  ac  ad  ae  af  ag  ah  !
188 !ba  bb  bc  bd  be  bf  bg  bh  !
189 !ca  cb  cc  cd  ce  cf  cg  ch  !
190 ]]></screen>
191     </refsection>
192     <refsection role="see also">
193         <title>See also</title>
194         <simplelist type="inline">
195             <member>
196                 <link linkend="meshgrid">meshgrid</link>
197             </member>
198             <member>
199                 <link linkend="kron">kron</link>
200             </member>
201             <member>
202                 <link linkend="feval">feval</link>
203             </member>
204             <member>
205                 <link linkend="eval3d">eval3d</link>
206             </member>
207             <member>
208                 <link linkend="nf3d">nf3d</link>
209             </member>
210         </simplelist>
211     </refsection>
212     <refsection role="history">
213         <title>History</title>
214         <revhistory>
215             <revision>
216                 <revnumber>6.0</revnumber>
217                 <revdescription>Extension to all homogeneous datatypes ([], booleans, encoded integers, polynomials, rationals, strings). Revision of the help page.</revdescription>
218             </revision>
219         </revhistory>
220     </refsection>
221 </refentry>