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

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report

File size: 12.5 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></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=".//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 It is a vector composed by 4 elements containing the position of the frame
119 containing captions and the graph in normalized coordinates.
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 Same comment to position the color bar, !p.position=posbar
140
141   
142   
143
144   
145    <h3>Keywords</h3>
146
147   
148    <a name="#_placedessin_keyword_BARMARGES"></a>
149    <h4>BARMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150     
151     
152     
153     
154     
155     
156     
157     
158    </h4>
159
160   
161   
162    <a name="#_placedessin_keyword_NOCOLORBAR"></a>
163    <h4>NOCOLORBAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169     
170     
171     
172    </h4>
173
174   
175 We active it if we do not want the colorbar.
176
177   
178    <a name="#_placedessin_keyword_NOFILL"></a>
179    <h4>NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185     
186     
187     
188    </h4>
189
190   
191 We active it if we only want contours in black and white with a white background.
192
193   
194    <a name="#_placedessin_keyword_COLOR_c"></a>
195    <h4>COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196     
197     
198     
199     
200     
201     
202     
203     
204    </h4>
205
206   
207 To draw the contour in color instead of in black
208 with filling in color
209
210   
211    <a name="#_placedessin_keyword_CONTOUR"></a>
212    <h4>CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213     
214     
215     
216     
217     
218     
219     
220     
221    </h4>
222
223   
224 If we want to trace contours of a different field than the one
225 whose we have the colored drawing (by example E-P in color and QSR in contours).
226 It must be a field respecting same characteristics than the argument number
227 one of <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
228
229   
230    <a name="#_placedessin_keyword_VECTEUR"></a>
231    <h4>VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232     
233     
234     
235     
236     
237      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
238     
239     
240    </h4>
241
242     is also appropriated.
243
244   
245    <a name="#_placedessin_keyword_PORTRAIT"></a>
246    <h4>PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247     
248     
249     
250     
251     
252     
253     
254     
255    </h4>
256
257   
258 Force the page or the window to be in standing position.
259
260   
261    <a name="#_placedessin_keyword_LANDSCAPE"></a>
262    <h4>LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263     
264     
265     
266     
267     
268     
269     
270     
271    </h4>
272
273   
274 Force the page or the window on the screen to be in lengthened position.
275
276   
277    <a name="#_placedessin_keyword_SMALL"></a>
278    <h4>SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279     
280     
281     
282     
283     
284     
285     
286     
287    </h4>
288
289   
290 Vector composed of 3 or 4 elements, applied to make a drawing on a
291 small portion of a page or screen. It delimit the zone where the drawing will be done.
292     If there is 4 elements:
293 then is constituted of coordinates (expressed in cm located from the up and
294 left corner of the page or the window (in portrait like in landscape) of the bottom
295 and left corner and of the up and right corner of the drawing zone.
296     If there is 3 elements:
297 in this case, we divide the page or the screen in small[0] columns and in small[1] lines
298 the drawing made in the box numbered small[2]. The numerotation starting up and left by
299 the number 1 and then, following the writing direction.
300 By default, we make the largest drawing we can do, conserving the aspect rapport
301 (except when REMPLI is activated).
302
303   
304    <a name="#_placedessin_keyword_MARGES"></a>
305    <h4>MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
306     
307     
308     
309     
310     
311     
312     
313     
314    </h4>
315
316   
317   
318    <a name="#_placedessin_keyword_MAP"></a>
319    <h4>MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
320     
321     
322     
323     
324     
325     
326     
327     
328    </h4>
329
330   
331 We use it when we want to do a projection.
332 This keyword can be of two types:
333     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
334     /MAP: In this case, map is automatically calculated have the value:
335          map = [0, (lon1+lon2)/2., 0]
336 Comment 1: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
337 IDL> demo
338 Then choose earth sciences and  mapping.
339 Comment 2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
340 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
341 For example, for a polar projection centered on the south pole:
342 IDL> domdef,-180,180,-90,-45
343 IDL> plt, tab, /stereo,map=[-90,0,0]
344       
345   
346    <a name="#_placedessin_keyword_REMPLI"></a>
347    <h4>REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
348     
349     
350     
351     
352     
353     
354     
355     
356    </h4>
357
358   
359 Force the drawing to occupy the whole space defined by small.
360
361   
362    <a name="#_placedessin_keyword_POST"></a>
363    <h4>POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
364     
365     
366     
367     
368     
369     
370     
371     
372    </h4>
373
374   
375 Make a postscript. Only works if we made one drawing on the page.
376 If we make several drawing, use @<a href="../../..//ToBeReviewed/POSTSCRIPT/ps.html">ps</a>.
377
378   
379    <a name="#_placedessin_keyword_WINDOW"></a>
380    <h4>WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
381     
382     
383     
384     
385     
386     
387     
388     
389    </h4>
390
391   
392 Number of the window on which we want to do the graph (Allow to open several windows).
393 By default, we open 'IDL0'
394
395   
396    <a name="#_placedessin_keyword_ENDPOINTS"></a>
397    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
398     
399     
400     
401     
402     
403     
404     
405     
406    </h4>
407
408   
409 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
410 of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
411 coordinates.
412
413   
414    <a name="#_placedessin_keyword_TYPE"></a>
415    <h4>TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
416     
417     
418     
419     
420     
421     
422     
423     
424    </h4>
425
426   
427   
428    <a name="#_placedessin_keyword_BASICMARGES"></a>
429    <h4>BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
430     
431     
432     
433     
434     
435     
436     
437     
438    </h4>
439
440   
441   
442    <a name="#_placedessin_keyword_NOERASE"></a>
443    <h4>NOERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
444     
445     
446     
447     
448     
449     
450     
451     
452    </h4>
453
454   
455 We active it to make a drawing without creating a new frame.
456
457   
458    <a name="#_placedessin_keyword_LCT"></a>
459    <h4>LCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
460     
461     
462     
463     
464     
465      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
466     
467     
468    </h4>
469
470   
471 It designate the number of the palette of color we want to use for the plot.
472       
473   
474    <a name="#_placedessin_keyword_DIREC"></a>
475    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476     
477     
478     
479     
480     
481     
482     
483     
484    </h4>
485
486   
487 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
488       'xzt' 'yzt' 'xyzt' Direction on which do averages
489
490   
491    <a name="#_placedessin_keyword_CB_TITLE"></a>
492    <h4>CB_TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
493     
494     
495     
496     
497     
498     
499     
500     
501    </h4>
502
503   
504 The colorbar's title
505
506   
507    <a name="#_placedessin_keyword__EXTRA"></a>
508    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
509     
510     
511     
512     
513     
514     
515     
516     
517    </h4>
518
519   
520 Used to pass keywords
521
522   
523   
524
525   
526    </pre><h3>Version history</h3>
527   
528    <h4>Version</h4>
529 $Id: placedessin.pro 237 2007-03-26 15:37:03Z pinsard $
530
531    <h4>History</h4>
532 Sebastien Masson (smasson@lodyc.jussieu.fr)
533                       26/4/1999
534
535   
536
537   
538   
539   
540   
541   
542
543    <h3>Other attributes</h3>
544   
545   
546    <h4>Uses routines</h4>
547 common.pro
548
549   
550   
551   
552
553    <font size="-3"><p>&nbsp;</p></font>
554    <hr size="1" color="#CCCCCC"/>
555     
556
557   
558
559    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
560
561  </body>
562</html>
Note: See TracBrowser for help on using the repository browser.