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