source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/GRILLE/grille.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 11.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>grille.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="fmask.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="t2v.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/GRILLE/</font></h1>
58    <h2>grille.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Choose the grid which must be used to do the graph in function of
65 vargrid and send back corresponding parameters calculated in
66 domdef.pro and reduced at the domain defined by domdef (contrarily
67 to grandegrille.pro)
68 BEWARE!! The choice of the grid is made from the value of the
69 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
70
71
72   
73
74     
75      <a name="#_grille"></a>
76
77      <h2>grille  <font size="-1" color="#006633">
78</font></h2>
79
80      <p><font face="Courier">grille<i>[, <a href="#_grille_keyword_mask">mask</a>][, <a href="#_grille_keyword_glam">glam</a>][, <a href="#_grille_keyword_gphi">gphi</a>][, <a href="#_grille_keyword_gdep">gdep</a>][, <a href="#_grille_keyword_nx">nx</a>][, <a href="#_grille_keyword_ny">ny</a>][, <a href="#_grille_keyword_nz">nz</a>][, <a href="#_grille_keyword_firstx">firstx</a>][, <a href="#_grille_keyword_firsty">firsty</a>][, <a href="#_grille_keyword_firstz">firstz</a>][, <a href="#_grille_keyword_lastx">lastx</a>][, <a href="#_grille_keyword_lasty">lasty</a>][, <a href="#_grille_keyword_lastz">lastz</a>][, <a href="#_grille_keyword_e1">e1</a>][, <a href="#_grille_keyword_e2">e2</a>][, <a href="#_grille_keyword_e3">e3</a>]</i>, <a href="#_grille_keyword_TRI">TRI</a>=<i>TRI</i>, <a href="#_grille_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_grille_keyword_TOUT">TOUT</a>=<i>TOUT</i>, <a href="#_grille_keyword_FORPLT">FORPLT</a>=<i>FORPLT</i>, <a href="#_grille_keyword_IFPLTZ">IFPLTZ</a>=<i>IFPLTZ</i>, <a href="#_grille_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_grille_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
81
82   
83
84
85   
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_grille_keyword_mask"></a>
92    <h4>mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93     
94      <font size="-1" color="#006633">out</font>
95      <font size="-1" color="#006633">optional</font>
96     
97     
98     
99     
100     
101    </h4>
102
103   
104 For the definition, see domdef and the management of subdomains on the web.
105 
106   
107
108    <a name="#_grille_keyword_glam"></a>
109    <h4>glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110     
111      <font size="-1" color="#006633">out</font>
112      <font size="-1" color="#006633">optional</font>
113     
114     
115     
116     
117     
118    </h4>
119
120   
121 For the definition, see domdef and the management of subdomains on the web.
122 
123   
124
125    <a name="#_grille_keyword_gphi"></a>
126    <h4>gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127     
128      <font size="-1" color="#006633">out</font>
129      <font size="-1" color="#006633">optional</font>
130     
131     
132     
133     
134     
135    </h4>
136
137   
138 For the definition, see domdef and the management of subdomains on the web.
139 
140   
141
142    <a name="#_grille_keyword_gdep"></a>
143    <h4>gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144     
145      <font size="-1" color="#006633">out</font>
146      <font size="-1" color="#006633">optional</font>
147     
148     
149     
150     
151     
152    </h4>
153
154   
155 For the definition, see domdef and the management of subdomains on the web.
156 
157   
158
159    <a name="#_grille_keyword_nx"></a>
160    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161     
162      <font size="-1" color="#006633">out</font>
163      <font size="-1" color="#006633">optional</font>
164     
165     
166     
167     
168     
169    </h4>
170
171   
172 For the definition, see domdef and the management of subdomains on the web.
173 
174   
175
176    <a name="#_grille_keyword_ny"></a>
177    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178     
179      <font size="-1" color="#006633">out</font>
180      <font size="-1" color="#006633">optional</font>
181     
182     
183     
184     
185     
186    </h4>
187
188   
189 For the definition, see domdef and the management of subdomains on the web.
190 
191   
192
193    <a name="#_grille_keyword_nz"></a>
194    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195     
196      <font size="-1" color="#006633">out</font>
197      <font size="-1" color="#006633">optional</font>
198     
199     
200     
201     
202     
203    </h4>
204
205   
206 For the definition, see domdef and the management of subdomains on the web.
207 
208   
209
210    <a name="#_grille_keyword_firstx"></a>
211    <h4>firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212     
213      <font size="-1" color="#006633">out</font>
214      <font size="-1" color="#006633">optional</font>
215     
216     
217     
218     
219     
220    </h4>
221
222   
223 For the definition, see domdef and the management of subdomains on the web.
224 
225   
226
227    <a name="#_grille_keyword_firsty"></a>
228    <h4>firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229     
230      <font size="-1" color="#006633">out</font>
231      <font size="-1" color="#006633">optional</font>
232     
233     
234     
235     
236     
237    </h4>
238
239   
240 For the definition, see domdef and the management of subdomains on the web.
241 
242   
243
244    <a name="#_grille_keyword_firstz"></a>
245    <h4>firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246     
247      <font size="-1" color="#006633">out</font>
248      <font size="-1" color="#006633">optional</font>
249     
250     
251     
252     
253     
254    </h4>
255
256   
257 For the definition, see domdef and the management of subdomains on the web.
258         
259   
260
261    <a name="#_grille_keyword_lastx"></a>
262    <h4>lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263     
264      <font size="-1" color="#006633">out</font>
265      <font size="-1" color="#006633">optional</font>
266     
267     
268     
269     
270     
271    </h4>
272
273   
274 For the definition, see domdef and the management of subdomains on the web.
275 
276   
277
278    <a name="#_grille_keyword_lasty"></a>
279    <h4>lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280     
281      <font size="-1" color="#006633">out</font>
282      <font size="-1" color="#006633">optional</font>
283     
284     
285     
286     
287     
288    </h4>
289
290   
291 For the definition, see domdef and the management of subdomains on the web.
292 
293   
294
295    <a name="#_grille_keyword_lastz"></a>
296    <h4>lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
297     
298      <font size="-1" color="#006633">out</font>
299      <font size="-1" color="#006633">optional</font>
300     
301     
302     
303     
304     
305    </h4>
306
307   
308 For the definition, see domdef and the management of subdomains on the web.
309 
310   
311
312    <a name="#_grille_keyword_e1"></a>
313    <h4>e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
314     
315      <font size="-1" color="#006633">out</font>
316      <font size="-1" color="#006633">optional</font>
317     
318     
319     
320     
321     
322    </h4>
323
324   
325 For the definition, see domdef and the management of subdomains on the web.
326
327   
328
329    <a name="#_grille_keyword_e2"></a>
330    <h4>e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
331     
332      <font size="-1" color="#006633">out</font>
333      <font size="-1" color="#006633">optional</font>
334     
335     
336     
337     
338     
339    </h4>
340
341   
342 For the definition, see domdef and the management of subdomains on the web.
343 
344   
345
346    <a name="#_grille_keyword_e3"></a>
347    <h4>e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
348     
349      <font size="-1" color="#006633">out</font>
350      <font size="-1" color="#006633">optional</font>
351     
352     
353     
354     
355     
356    </h4>
357
358   
359 For the definition, see domdef and the management of subdomains on the web.
360
361   
362   
363
364   
365    <h3>Keywords</h3>
366
367   
368    <a name="#_grille_keyword_TRI"></a>
369    <h4>TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
370     
371     
372     
373     
374     
375     
376     
377     
378    </h4>
379
380     
381 This keyword serve to obtain, thanks to grille, the triangulation which
382 refer to the grid but only on the part of the zoom. This of triangulation
383 is passed in the variable we have equate at TRI.
384 For example: grille,...,tri=triangulation_reduite.
385 This keyword is used in plt.pro
386
387   
388    <a name="#_grille_keyword_NOTRI"></a>
389    <h4>NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
390     
391     
392     
393     
394     
395     
396     
397     
398    </h4>
399
400   
401 Useful only when TRI is activated. In this case, grill send back -1 in the
402 variable tri even if the variable of the common triangles_list is defined
403 and different of-1
404 
405   
406    <a name="#_grille_keyword_TOUT"></a>
407    <h4>TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
408     
409     
410     
411     
412     
413     
414     
415     
416    </h4>
417
418   
419
420   
421    <a name="#_grille_keyword_FORPLT"></a>
422    <h4>FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
423     
424     
425     
426     
427     
428     
429     
430     
431    </h4>
432
433   
434 In plt, we want that land points, glam and gphi, be equal to glamt and
435 gphit regardless of the grid.
436
437   
438    <a name="#_grille_keyword_IFPLTZ"></a>
439    <h4>IFPLTZ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
440     
441     
442     
443     
444     
445     
446     
447     
448    </h4>
449
450   
451   
452    <a name="#_grille_keyword_WDEPTH"></a>
453    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
454     
455     
456     
457     
458     
459     
460     
461     
462    </h4>
463
464   
465 To specify that the field is at W depth instead of T
466 depth (automatically activated if vargrid eq 'W')
467 
468   
469    <a name="#_grille_keyword__EXTRA"></a>
470    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
471     
472     
473     
474     
475     
476     
477     
478     
479    </h4>
480
481     
482 Used to pass your keywords
483
484   
485   
486
487   
488    <h3>Version history</h3>
489   
490    <h4>Version</h4>
491 $Id: grille.pro 157 2006-08-21 09:01:50Z navarro $
492
493    <h4>History</h4>
494  Sebastien Masson (smasson@lodyc.jussieu.fr)
495                        12/2/1999
496                       10/11/1999 /forplt
497
498   
499
500    <h3>Known issues</h3>
501   
502   
503    <h4>Todo items</h4> Comment ecrire la remarque sur les inputs?
504 
505    <h4>Restrictions</h4> 
506 Use the variable vargrid
507
508
509 Vargrid must be 'T', 'W', 'U', 'V' or 'F'
510
511
512    <h3>Other attributes</h3>
513   
514   
515    <h4>Uses routines</h4>
516 cm_4mesh
517 cm_4data
518
519   
520   
521   
522
523    <font size="-3"><p>&nbsp;</p></font>
524    <hr size="1" color="#CCCCCC"/>
525     
526
527   
528
529    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:56 2006.</font></p>
530
531  </body>
532</html>
Note: See TracBrowser for help on using the repository browser.