source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

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