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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output

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