source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 13.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>placedessin.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="placecolor.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="projsegment.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/DIVERS/</font></h1>
58    <h2>placedessin.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Putting into place of the drawing/ opening of the window or of the PS
65
66
67   
68
69     
70      <a name="#_placedessin"></a>
71
72      <h2>placedessin  <font size="-1" color="#006633">
73 Utilities
74</font></h2>
75
76      <p><font face="Courier">placedessin<i>, <a href="#_placedessin_keyword_typedessin">typedessin</a>, <a href="#_placedessin_keyword_posfenetre">posfenetre</a>, <a href="#_placedessin_keyword_posbar">posbar</a>[, <a href="#_placedessin_keyword_dtasize">dtasize</a>]</i>, <a href="#_placedessin_keyword_BARMARGES">BARMARGES</a>=<i>BARMARGES</i>, <a href="#_placedessin_keyword_NOCOLORBAR">NOCOLORBAR</a>=<i>NOCOLORBAR</i>, <a href="#_placedessin_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_placedessin_keyword_COLOR_c">COLOR_c</a>=<i>COLOR_c</i>, <a href="#_placedessin_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_placedessin_keyword_VECTEUR">VECTEUR</a>=<i>vector</i>, <a href="#_placedessin_keyword_PORTRAIT">PORTRAIT</a>=<i>PORTRAIT</i>, <a href="#_placedessin_keyword_LANDSCAPE">LANDSCAPE</a>=<i>LANDSCAPE</i>, <a href="#_placedessin_keyword_SMALL">SMALL</a>=<i>SMALL</i>, <a href="#_placedessin_keyword_MARGES">MARGES</a>=<i>MARGES</i>, <a href="#_placedessin_keyword_MAP">MAP</a>=<i>MAP</i>, <a href="#_placedessin_keyword_REMPLI">REMPLI</a>=<i>REMPLI</i>, <a href="#_placedessin_keyword_POST">POST</a>=<i>POST</i>, <a href="#_placedessin_keyword_WINDOW">WINDOW</a>=<i>WINDOW</i>, <a href="#_placedessin_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_placedessin_keyword_TYPE">TYPE</a>=<i>TYPE</i>, <a href="#_placedessin_keyword_BASICMARGES">BASICMARGES</a>=<i>BASICMARGES</i>, <a href="#_placedessin_keyword_NOERASE">NOERASE</a>=<i>NOERASE</i>, <a href="#_placedessin_keyword_LCT">LCT</a>=<i>integer</i>, <a href="#_placedessin_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_placedessin_keyword_CB_TITLE">CB_TITLE</a>=<i>CB_TITLE</i>, <a href="#_placedessin_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_placedessin_keyword_typedessin"></a>
88    <h4>typedessin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89     
90     
91     
92     
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
95     
96     
97    </h4>
98
99   
100 It specify what procedure is called by <a href="../../..//ToBeReviewed/PLOTS/DIVERS/placedessin.html">placedessin</a> :
101 'plt', 'pltz' or 'pltt'
102
103   
104
105    <a name="#_placedessin_keyword_posfenetre"></a>
106    <h4>posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107     
108      <font size="-1" color="#006633">out</font>
109     
110     
111     
112      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
113     
114     
115    </h4>
116
117   
118 containing captions and the graph in normalized coordinates.
119
120 Comment: To position the drawing, we have to do !p.position=posfenetre
121 after the call of the caliber
122
123   
124
125    <a name="#_placedessin_keyword_posbar"></a>
126    <h4>posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127     
128      <font size="-1" color="#006633">out</font>
129     
130     
131     
132      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
133     
134     
135    </h4>
136
137   
138 Like POSFENETRE but for the color bar.
139
140 Same comment to position the color bar, !p.position=posbar
141
142   
143
144    <a name="#_placedessin_keyword_dtasize"></a>
145    <h4>dtasize&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146      <font size="-1" color="#006633">in</font>
147     
148      <font size="-1" color="#006633">optional</font>
149     
150     
151      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font>
152     
153     
154    </h4>
155
156   
157 used by <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltv.html">pltv</a> to specify the size of the array that will be plotted
158 and therefore the default yxaspect to be used.
159
160   
161   
162
163   
164    <h3>Keywords</h3>
165
166   
167    <a name="#_placedessin_keyword_BARMARGES"></a>
168    <h4>BARMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169     
170     
171     
172     
173     
174     
175     
176     
177    </h4>
178
179   
180   
181    <a name="#_placedessin_keyword_NOCOLORBAR"></a>
182    <h4>NOCOLORBAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183     
184     
185     
186     
187     
188     
189     
190     
191    </h4>
192
193   
194 We active it if we do not want the colorbar.
195
196   
197    <a name="#_placedessin_keyword_NOFILL"></a>
198    <h4>NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
200     
201     
202     
203     
204     
205     
206     
207    </h4>
208
209   
210 We active it if we only want contours in black and white with a white background.
211
212   
213    <a name="#_placedessin_keyword_COLOR_c"></a>
214    <h4>COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215     
216     
217     
218     
219     
220     
221     
222     
223    </h4>
224
225   
226 To draw the contour in color instead of in black with filling in color
227
228   
229    <a name="#_placedessin_keyword_CONTOUR"></a>
230    <h4>CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231     
232     
233     
234     
235     
236     
237     
238     
239    </h4>
240
241   
242 If we want to trace contours of a different field than the one
243 whose we have the colored drawing (by example E-P in color and QSR in contours).
244
245 It must be a field respecting same characteristics than the argument number
246 one of <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
247
248   
249    <a name="#_placedessin_keyword_VECTEUR"></a>
250    <h4>VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251     
252     
253     
254     
255     
256      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
257     
258     
259    </h4>
260
261     is also appropriated.
262
263   
264    <a name="#_placedessin_keyword_PORTRAIT"></a>
265    <h4>PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266     
267     
268     
269     
270     
271     
272     
273     
274    </h4>
275
276   
277 Force the page or the window to be in standing position.
278
279   
280    <a name="#_placedessin_keyword_LANDSCAPE"></a>
281    <h4>LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
282     
283     
284     
285     
286     
287     
288     
289     
290    </h4>
291
292   
293 Force the page or the window on the screen to be in lengthened position.
294
295   
296    <a name="#_placedessin_keyword_SMALL"></a>
297    <h4>SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
298     
299     
300     
301     
302     
303     
304     
305     
306    </h4>
307
308   
309 Vector composed of 3 or 4 elements, applied to make a drawing on a
310 small portion of a page or screen. It delimit the zone where the drawing will be done.
311
312 If there is 4 elements then is constituted of coordinates (expressed in cm
313 located from the up and left corner of the page or the window (in portrait
314 like in landscape) of the bottom and left corner and of the up and right
315 corner of the drawing zone.
316
317 If there is 3 elements, we divide the page or the screen in small[0] columns
318 and in small[1] lines, the drawing is made in the box numbered small[2].
319
320 The numerotation starting up and left by
321 the number 1 and then, following the writing direction.
322
323 By default, we make the largest drawing we can do, conserving the aspect
324 ratio (except when REMPLI is activated).
325
326   
327    <a name="#_placedessin_keyword_MARGES"></a>
328    <h4>MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
329     
330     
331     
332     
333     
334     
335     
336     
337    </h4>
338
339   
340   
341    <a name="#_placedessin_keyword_MAP"></a>
342    <h4>MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
343     
344     
345     
346     
347     
348     
349     
350     
351    </h4>
352
353   
354 We use it when we want to do a projection.
355
356 This keyword can be of two types:
357     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <a href="/Applications/itt/idl64/help/online_help/MAP_SET.html">MAP_SET</a>).
358     /MAP: In this case, map is automatically calculated have the value:
359          map = [0, (lon1+lon2)/2., 0]
360
361 Comment 1: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
362   IDL> demo
363 Then choose "Mapping" and "Global Mapping Demo"
364
365 Comment 2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
366 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
367
368 For example, for a polar projection centered on the south pole:
369   IDL> domdef,-180,180,-90,-45
370   IDL> plt, tab, /stereo,map=[-90,0,0]
371       
372   
373    <a name="#_placedessin_keyword_REMPLI"></a>
374    <h4>REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
375     
376     
377     
378     
379     
380     
381     
382     
383    </h4>
384
385   
386 Force the drawing to fill the whole space defined by small.
387
388   
389    <a name="#_placedessin_keyword_POST"></a>
390    <h4>POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
391     
392     
393     
394     
395     
396     
397     
398     
399    </h4>
400
401   
402 Make a postscript.
403
404 Only works if we made one drawing on the page.
405
406 If we make several drawing, use @<a href="../../..//ToBeReviewed/POSTSCRIPT/ps.html">ps</a>.
407
408   
409    <a name="#_placedessin_keyword_WINDOW"></a>
410    <h4>WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411     
412     
413     
414     
415     
416     
417     
418     
419    </h4>
420
421   
422 Number of the window on which we want to do the graph (Allow to open several windows).
423
424 By default, we open 'IDL0'
425
426   
427    <a name="#_placedessin_keyword_ENDPOINTS"></a>
428    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
429     
430     
431     
432     
433     
434     
435     
436     
437    </h4>
438
439   
440 keyword specifying that we want to make a vertical cut in diagonal.
441
442 Then coordinated of extremities of these ones are defined by the 4 elements
443 of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates.
444
445   
446    <a name="#_placedessin_keyword_TYPE"></a>
447    <h4>TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
448     
449     
450     
451     
452     
453     
454     
455     
456    </h4>
457
458   
459   
460    <a name="#_placedessin_keyword_BASICMARGES"></a>
461    <h4>BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
462     
463     
464     
465     
466     
467     
468     
469     
470    </h4>
471
472   
473   
474    <a name="#_placedessin_keyword_NOERASE"></a>
475    <h4>NOERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476     
477     
478     
479     
480     
481     
482     
483     
484    </h4>
485
486   
487 We active it to make a drawing without creating a new frame.
488
489   
490    <a name="#_placedessin_keyword_LCT"></a>
491    <h4>LCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
492     
493     
494     
495     
496     
497      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
498     
499     
500    </h4>
501
502   
503 It designate the number of the palette of color we want to use for the plot.
504       
505   
506    <a name="#_placedessin_keyword_DIREC"></a>
507    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
508     
509     
510     
511     
512     
513     
514     
515     
516    </h4>
517
518   
519 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
520 'xzt' 'yzt' 'xyzt' Direction on which do averages
521
522   
523    <a name="#_placedessin_keyword_CB_TITLE"></a>
524    <h4>CB_TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
525     
526     
527     
528     
529     
530     
531     
532     
533    </h4>
534
535   
536 The colorbar's title
537
538   
539    <a name="#_placedessin_keyword__EXTRA"></a>
540    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
541     
542     
543     
544     
545     
546     
547     
548     
549    </h4>
550
551   
552 Used to pass keywords
553
554   
555   
556
557   
558    </pre><h3>Version history</h3>
559   
560    <h4>Version</h4>
561 $Id: placedessin.pro 378 2008-08-12 12:35:46Z pinsard $
562
563    <h4>History</h4>
564 Sebastien Masson (smasson@lodyc.jussieu.fr)
565                       26/4/1999
566
567   
568
569   
570   
571   
572   
573   
574
575    <h3>Other attributes</h3>
576   
577   
578    <h4>Uses routines</h4>
579 <a href="../../..//Obsolete/common.html">common</a>
580
581   
582   
583   
584
585    <font size="-3"><p>&nbsp;</p></font>
586    <hr size="1" color="#CCCCCC"/>
587     
588
589   
590
591    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
592
593  </body>
594</html>
Note: See TracBrowser for help on using the repository browser.