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

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

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 8.6 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_calibre">
103
104          <h2><a class="top" href="#container">top</a>calibre </h2>
105       
106          <p class="header">
107            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>
108       
109          <div class="comments">
110 NAME: calibre
111
112 PURPOSE:a partir d''un rapport d''aspect et des valeurs (en ligne de
113 characteres) des differentes marges, calcul posfenetre et posbar qui
114 servent a placer le dessin et la barre de couleur grace a
115 !p.position sur une feuille ou
116 sur une sortie ecran dont la fenetre a les memes proportions
117
118 CATEGORY: positionnement du graphe
119
120 CALLING SEQUENCE:
121     calibre, rapportyx,marge,margebar, smalldraw,posfenetre, posbar
122
123 INPUTS:
124        rapportyx: rapport d''echelle entre la longueur de l''axe des
125        y et celle des x. par ex pour une carte xy,
126       rapportyx=(lat2-lat1)/(lon2-lon1)
127
128        marge: vecteur de 4 elements contenant la taille des marges a gauche,
129 a droite, en bas et en haut devant entourer le graphe. tout est
130 mesure en lignes de characteres
131
132        margebar: vecteur de 4 elements contenant la taille des marges a gauche,
133 a droite, en bas et -ATTENTION- le dernier element est cette fois-ci
134 la position de coin en haut a droite, devant entourer la barre de
135 couleur. tout est mesure en lignes de characteres
136
137       smalldraw: 2 possiblites
138             un vecteur de 4 elements donnant (en portrait ou
139 en landscape) la position de cadre ds lequel doit rentrer le
140 dessin. cette position est donne par les coordonnes des 2 coins du
141 cadre: en bas a gauche et en haut a droite. elle s''exprime tjs
142 (pour un postscript ou une sortie ecran) en cm, l''origine etant le
143 coin en bas a gauche.
144             un vecteur de 3 elements donnant le nombre de colonnes a
145 faire de le dessin, le nombre de lignes et enfin le numero de la
146 case que doit occuper le dessin (cf matlab). par ex pour faire 6
147 dessin en 2 colonnes et 3 lignes et occuper la 4 eme case, small=[2,3,4]
148
149 KEYWORD PARAMETERS:
150
151        /REMPLI:oblige le dessin a occuper l'espace maximum definit
152 par smalldraw sans resperter le rapport y sur x.
153
154        YXASPECT: force le rapport y sur x a prendre la valeur
155 rapportyx*yxaspect. ce mot cle est utile ds deux cas:
156   1) yxaspect=1 : oblige rapportyx a etre bien respecte sinon
157         calibre se reserve le droit de changer un peu celui-ci dans
158         le cas ou le rapport d''aspect de small dessin est trop
159         different de celui de smalldraw.
160   2) yxaspect=n : multiplie par n le rapport d''aspect donne par
161         defaut.par ex ds plt, rapportyx est calcule pour que le
162         repere soit orthonorme, pour avoir un repere ou l''axe des y
163         est 2 fois plus dilate que celui des y YXASPECT=2
164       
165       PORTRAIT et LANDSCAPE: mots cles plus utilises mais tjs fonctionnels
166
167 OUTPUTS:
168       posfenetre: un vecteur de 4 elements contenant la position de
169       cadre contenant les legendes + le graphe en coordonnes
170       normalises. Rq: pour positionner le dessin il faut apres
171       l''appelle de calibre faire !p.position=posfenetre
172
173       posbar: cf posfentre mais pour la barre de couleur. meme
174       remarque pour positionner la barre de couleur, !p.position=posbar
175
176 COMMON BLOCKS:
177        common.pro             
178
179 SIDE EFFECTS:
180
181 RESTRICTIONS:
182
183 EXAMPLE:
184</div>
185
186         
187
188         
189            <h3>Parameters</h3>
190       
191           
192            <h4 id="_calibre_param_rapportyx">rapportyx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193             
194             
195             
196             
197             
198             
199             
200             
201            </h4>
202       
203          <div class="comments"></div>
204           
205            <h4 id="_calibre_param_marge">marge&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211             
212             
213             
214            </h4>
215       
216          <div class="comments"></div>
217           
218            <h4 id="_calibre_param_margebar">margebar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
229          <div class="comments"></div>
230           
231            <h4 id="_calibre_param_smalldraw">smalldraw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233             
234             
235             
236             
237             
238             
239             
240            </h4>
241       
242          <div class="comments"></div>
243           
244            <h4 id="_calibre_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
245             
246             
247             
248             
249             
250             
251             
252             
253            </h4>
254       
255          <div class="comments"></div>
256           
257            <h4 id="_calibre_param_posbar">posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268          <div class="comments"></div>
269           
270
271         
272
273         
274
275            <h3>Keywords</h3>
276           
277            <h4 id="_calibre_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
278             
279             
280             
281             
282             
283             
284             
285             
286            </h4>
287       
288            <div class="comments"></div>
289           
290            <h4 id="_calibre_keyword_YXASPECT">YXASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291             
292             
293             
294             
295             
296             
297             
298             
299            </h4>
300       
301            <div class="comments"></div>
302           
303            <h4 id="_calibre_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
304             
305             
306             
307             
308             
309             
310             
311             
312            </h4>
313       
314            <div class="comments"></div>
315           
316            <h4 id="_calibre_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
317             
318             
319             
320             
321             
322             
323             
324             
325            </h4>
326       
327            <div class="comments"></div>
328           
329            <h4 id="_calibre_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
330             
331             
332             
333             
334             
335             
336             
337             
338            </h4>
339       
340            <div class="comments"></div>
341           
342         
343
344         
345         
346         
347         
348         
349         
350         
351         
352         
353         
354         
355         
356       
357         
358         
359         
360         
361         
362         
363         
364       
365         
366       
367        </div>
368       
369      </div>
370
371     
372
373      <div id="tagline">Produced by IDLdoc 2.0.</div>
374
375    </div>
376
377  </body>
378</html>
Note: See TracBrowser for help on using the repository browser.