source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/POSTSCRIPT/calibre.html @ 402

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

update documentation
File size: 9.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>calibre.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="calibre.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/POSTSCRIPT//calibre.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&lt;&lt; prev file | <a href="chcolps.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="calibre.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/POSTSCRIPT/</a></h1>
82      <h2 class="pro_file">calibre.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 From a ration aspect and values (in line of character) of different margins,
91 it calculate POSFENETRE and POSBAR which serve to place the drawing and the color
92 bar thanks to !p.position on a leaf or a screen output whose the window has the same
93 proportion.
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_calibre">
108
109          <h2><a class="top" href="#container">top</a>calibre <span class="categories">
110 Graphics
111</span></h2>
112       
113          <p class="header">
114            calibre<span class="result">, <a href="#_calibre_param_rapportyx">rapportyx</a>, <a href="#_calibre_param_marge">marge</a>, <a href="#_calibre_param_margebar">margebar</a>, <a href="#_calibre_param_smalldraw">smalldraw</a>, <a href="#_calibre_param_posfenetre">posfenetre</a>, <a href="#_calibre_param_posbar">posbar</a></span>, <a href="#_calibre_keyword_REMPLI">REMPLI</a>=<span class="result">REMPLI</span>, <a href="#_calibre_keyword_YXASPECT">YXASPECT</a>=<span class="result">YXASPECT</span>, <a href="#_calibre_keyword_PORTRAIT">PORTRAIT</a>=<span class="result">PORTRAIT</span>, <a href="#_calibre_keyword_LANDSCAPE">LANDSCAPE</a>=<span class="result">LANDSCAPE</span>, <a href="#_calibre_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
115       
116          <div class="comments">
117</div>
118
119         
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_calibre_param_rapportyx">rapportyx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 Scale ratio between the length of the y axis and the x one. For example,
138 for an xy map: rapportyx=(lat2-lat1)/(lon2-lon1)
139</div>
140           
141            <h4 id="_calibre_param_marge">marge&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147              <span class="attr">type:</span> <span class="value">vector</span>
148             
149             
150            </h4>
151       
152          <div class="comments">
153 Vector made of 4 elements containing the size of the left, right, up and
154 bottom margin having to surround the graph.
155 All is measured in lines of characters.
156</div>
157           
158            <h4 id="_calibre_param_margebar">margebar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159              <span class="attr">in</span>
160             
161             
162              <span class="attr">required</span>
163             
164              <span class="attr">type:</span> <span class="value">vector</span>
165             
166             
167            </h4>
168       
169          <div class="comments">
170 Vector made of 4 elements containing the size of the left, right and bottom
171 margin and -BEWARE- the last element is this time the position of the right up
172 corner, having to surround the color bar. All is measured in lines of characters.
173</div>
174           
175            <h4 id="_calibre_param_smalldraw">smalldraw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176              <span class="attr">in</span>
177             
178             
179              <span class="attr">required</span>
180             
181              <span class="attr">type:</span> <span class="value">vector</span>
182             
183             
184            </h4>
185       
186          <div class="comments">
187 2 possibilities:
188    It is vector made of 4 elements giving (in portrait or landscape) the position
189 of the frame in which the drawing must go in. This position is given by coordinates
190 of the 2 corners of the frame: in the left bottom and the right up. It is always
191 (for a postscript or a screen output) express in cm, the origin being the
192 left bottom corner.
193    It is a vector made of 3 elements giving the number of column to be done in the
194 drawing, the number of line and the number of the case the number have to fill
195 (see matlab). For example, to do 6 drawings in 3 columns and 2 lines and
196 fill the 4th case, small=[2,3,4]
197</div>
198           
199            <h4 id="_calibre_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205              <span class="attr">type:</span> <span class="value">vector</span>
206             
207             
208            </h4>
209       
210          <div class="comments">
211 It is a vector made of 4 elements containing the position of the frame
212 containing captions + the graph in normalized coordinates.
213 Comment: to position the drawing, we have to do !p.position=POSFENETRE
214 after the call of calibre.
215</div>
216           
217            <h4 id="_calibre_param_posbar">posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223              <span class="attr">type:</span> <span class="value">vector</span>
224             
225             
226            </h4>
227       
228          <div class="comments">
229 See POSFENTERE but for the color bar. Same comment to position the color bar, !p.position=POSBAR
230</div>
231           
232
233         
234
235         
236
237            <h3>Keywords</h3>
238           
239            <h4 id="_calibre_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240             
241             
242             
243             
244             
245             
246             
247             
248            </h4>
249       
250            <div class="comments">
251 Force the drawing to fill the biggest possible place defined by
252 SMALLDRAW without respect the y/x ratio.
253</div>
254           
255            <h4 id="_calibre_keyword_YXASPECT">YXASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256             
257             
258             
259             
260             
261             
262             
263             
264            </h4>
265       
266            <div class="comments">
267 Force the y/x ratio to take the value RAPPORTYX*YXASPECT.
268 This keyword can be used in 2 cases:
269   1) YXASPECT=1 : force RAPPORTYX to be respected otherwise, calibre take the
270   initiative to change it a little in the case of the aspect ratio of SMALL
271   is too different of the one of SMALLDRAW.
272   2) YXASPECT=n : multiply by n the aspect ratio given by default.
273   For example in <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>, RAPPORTYX is calculated to the
274   reference be orthonormal,
275   to have a reference where the y axis is 2 time bigger than the x one, YXASPECT=2.
276        </div>
277           
278            <h4 id="_calibre_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279             
280             
281             
282             
283             
284             
285             
286             
287            </h4>
288       
289            <div class="comments">
290 Force the page or the window to be in standing position.
291</div>
292           
293            <h4 id="_calibre_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
294             
295             
296             
297             
298             
299             
300             
301             
302            </h4>
303       
304            <div class="comments">
305 Force the page or the window on the screen to be in lengthened position.
306</div>
307           
308            <h4 id="_calibre_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
309             
310             
311             
312             
313             
314             
315             
316             
317            </h4>
318       
319            <div class="comments">
320 Used to pass keywords
321</div>
322           
323         
324
325         
326          <h3>Version history</h3>
327         
328          <h4>Version</h4><div class="preformat">
329 $Id: calibre.pro 378 2008-08-12 12:35:46Z pinsard $
330</div>
331          <h4>History</h4><div class="preformat">
332 Sebastien Masson (smasson@lodyc.jussieu.fr)
333                        11/12/98
334</div>
335         
336         
337         
338         
339         
340         
341         
342       
343          <h3>Other attributes</h3>
344         
345         
346          <h4>Uses routines</h4><div class="preformat">
347 <a href="../..//Obsolete/common.html">common</a>
348</div>
349         
350         
351         
352       
353          <h3>Statistics</h3>
354          <table class="statistics">
355            <tr><td>McCabe cyclic</td><td>          36</td></tr>
356            <tr><td>McCabe essential</td><td>           1</td></tr>
357            <tr><td>McCabe modular design</td><td>           1</td></tr>
358          </table>
359         
360       
361        </div>
362       
363      </div>
364
365     
366
367      <div id="tagline">Produced by IDLdoc 2.0.</div>
368
369    </div>
370
371  </body>
372</html>
Note: See TracBrowser for help on using the repository browser.