source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/POSTSCRIPT/calibre.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: 9.4 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 rapport of 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
112 </span></h2>
113       
114          <p class="header">
115            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>
116       
117          <div class="comments"></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 rapport 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. All is measured in lines of characters.
155</div>
156           
157            <h4 id="_calibre_param_margebar">margebar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158              <span class="attr">in</span>
159             
160             
161              <span class="attr">required</span>
162             
163              <span class="attr">type:</span> <span class="value">vector</span>
164             
165             
166            </h4>
167       
168          <div class="comments">
169 Vector made of 4 elements containing the size of the left, right and bottom
170 margin and -BEWARE- the last element is this time the position of the right up
171 corner, having to surround the color bar. All is measured in lines of characters.
172</div>
173           
174            <h4 id="_calibre_param_smalldraw">smalldraw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175              <span class="attr">in</span>
176             
177             
178              <span class="attr">required</span>
179             
180              <span class="attr">type:</span> <span class="value">vector</span>
181             
182             
183            </h4>
184       
185          <div class="comments">
186 2 possibilities:
187    It is vector made of 4 elements giving (in portrait or landscape) the position
188 of the frame in which the drawing must go in. This position is given by coordinates
189 of the 2 corners of the frame: in the left bottom and the right up. It is always
190 (for a postscript or a screen output) express in cm, the origin being the
191 left bottom corner.
192    It is a vector made of 3 elements giving the number of column to be done in the
193 drawing, the number of line and the number of the case the number have to occupy
194 (see matlab). For example, to do 6 drawing in 3 columns and 2 lines and occupy
195 the 4th case, small=[2,3,4]
196</div>
197           
198            <h4 id="_calibre_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204              <span class="attr">type:</span> <span class="value">vector</span>
205             
206             
207            </h4>
208       
209          <div class="comments">
210 It is a vector made of 4 elements containing the position of the frame
211 containing captions + the graph in normalized coordinates.
212 Comment: to position the drawing, we have to do !p.position=POSFENETRE
213 after the call of calibre.
214</div>
215           
216            <h4 id="_calibre_param_posbar">posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218             
219             
220             
221             
222              <span class="attr">type:</span> <span class="value">vector</span>
223             
224             
225            </h4>
226       
227          <div class="comments">
228 See POSFENTRE but for the color bar. Same comment to position the color bar, !p.position=POSBAR
229</div>
230           
231
232         
233
234         
235
236            <h3>Keywords</h3>
237           
238            <h4 id="_calibre_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244             
245             
246             
247            </h4>
248       
249            <div class="comments">
250 Force the drawing to occupy the biggest possible place defined by
251 SMALLDRAW without respect the rapport y on x.
252</div>
253           
254            <h4 id="_calibre_keyword_YXASPECT">YXASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
255             
256             
257             
258             
259             
260             
261             
262             
263            </h4>
264       
265            <div class="comments">
266 Force the rapport y on x to take the value RAPPORTYX*YXASPECT.
267 This keyword can be used in 2 cases:
268   1) YXASPECT=1 : force RAPPORTYX to be respected otherwise, Calibre take the
269   initiative to change it a little in the case of the aspect rapport of SMALL
270   is too different of the one of SMALLDRAW.
271   2) YXASPECT=n : multiply by n the aspect rapport given by default.
272   For example in plt, RAPPORTYX is calculated to the reference be orthonormal,
273   to have a reference where the y axis is 2 time bigger than the x one, YXASPECT=2.
274        </div>
275           
276            <h4 id="_calibre_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277             
278             
279             
280             
281             
282             
283             
284             
285            </h4>
286       
287            <div class="comments">       
288 Force the page or the window to be in standing position.
289 </div>
290           
291            <h4 id="_calibre_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292             
293             
294             
295             
296             
297             
298             
299             
300            </h4>
301       
302            <div class="comments">       
303 Force the page or the window on the screen to be in lengthened position.
304 </div>
305           
306            <h4 id="_calibre_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
307             
308             
309             
310             
311             
312             
313             
314             
315            </h4>
316       
317            <div class="comments">
318 Used to pass your keywords
319</div>
320           
321         
322
323         
324          <h3>Version history</h3>
325         
326          <h4>Version</h4><div class="preformat">
327 $Id: calibre.pro 163 2006-08-29 12:59:46Z navarro $</div>
328          <h4>History</h4><div class="preformat">
329 Sebastien Masson (smasson@lodyc.jussieu.fr)
330                        11/12/98
331</div>
332         
333         
334         
335         
336         
337         
338         
339       
340          <h3>Other attributes</h3>
341         
342         
343          <h4>Uses routines</h4><div class="preformat">
344 common.pro
345</div>
346         
347         
348         
349       
350          <h3>Statistics</h3>
351          <table class="statistics">
352            <tr><td>McCabe cyclic</td><td>          35</td></tr>
353            <tr><td>McCabe essential</td><td>           1</td></tr>
354            <tr><td>McCabe modular design</td><td>           1</td></tr>
355          </table>
356         
357       
358        </div>
359       
360      </div>
361
362     
363
364      <div id="tagline">Produced by IDLdoc 2.0.</div>
365
366    </div>
367
368  </body>
369</html>
Note: See TracBrowser for help on using the repository browser.