source: trunk/SRC/Documentation/idldoc_assistant_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: 8.2 KB
RevLine 
[163]1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>calibre.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href=""><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="chcolps.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/POSTSCRIPT/</font></h1>
58    <h2>calibre.pro</h2>
59
60    <dl>
61    </dl>
62
63   
[402]64 From a ration aspect and values (in line of character) of different margins,
[234]65 it calculate POSFENETRE and POSBAR which serve to place the drawing and the color
66 bar thanks to !p.position on a leaf or a screen output whose the window has the same
[163]67 proportion.
68
69
70   
71
72     
73      <a name="#_calibre"></a>
74
[234]75      <h2>calibre  <font size="-1" color="#006633">
[163]76 Graphics
[234]77</font></h2>
[163]78
[234]79      <p><font face="Courier">calibre<i>, <a href="#_calibre_keyword_rapportyx">rapportyx</a>, <a href="#_calibre_keyword_marge">marge</a>, <a href="#_calibre_keyword_margebar">margebar</a>, <a href="#_calibre_keyword_smalldraw">smalldraw</a>, <a href="#_calibre_keyword_posfenetre">posfenetre</a>, <a href="#_calibre_keyword_posbar">posbar</a></i>, <a href="#_calibre_keyword_REMPLI">REMPLI</a>=<i>REMPLI</i>, <a href="#_calibre_keyword_YXASPECT">YXASPECT</a>=<i>YXASPECT</i>, <a href="#_calibre_keyword_PORTRAIT">PORTRAIT</a>=<i>PORTRAIT</i>, <a href="#_calibre_keyword_LANDSCAPE">LANDSCAPE</a>=<i>LANDSCAPE</i>, <a href="#_calibre_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
[163]80
81   
82
[234]83
[163]84   
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_calibre_keyword_rapportyx"></a>
91    <h4>rapportyx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
[338]103 Scale ratio between the length of the y axis and the x one. For example,
104 for an xy map: rapportyx=(lat2-lat1)/(lon2-lon1)
[163]105
106   
107
108    <a name="#_calibre_keyword_marge"></a>
109    <h4>marge&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
116     
117     
118    </h4>
119
120   
[234]121 Vector made of 4 elements containing the size of the left, right, up and
[338]122 bottom margin having to surround the graph.
123 All is measured in lines of characters.
[163]124
125   
126
127    <a name="#_calibre_keyword_margebar"></a>
128    <h4>margebar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129      <font size="-1" color="#006633">in</font>
130     
131     
132      <font size="-1" color="#006633">required</font>
133     
134      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
135     
136     
137    </h4>
138
139   
[234]140 Vector made of 4 elements containing the size of the left, right and bottom
141 margin and -BEWARE- the last element is this time the position of the right up
[163]142 corner, having to surround the color bar. All is measured in lines of characters.
143
144   
145
146    <a name="#_calibre_keyword_smalldraw"></a>
147    <h4>smalldraw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148      <font size="-1" color="#006633">in</font>
149     
150     
151      <font size="-1" color="#006633">required</font>
152     
153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
154     
155     
156    </h4>
157
158   
159 2 possibilities:
[234]160    It is vector made of 4 elements giving (in portrait or landscape) the position
161 of the frame in which the drawing must go in. This position is given by coordinates
162 of the 2 corners of the frame: in the left bottom and the right up. It is always
163 (for a postscript or a screen output) express in cm, the origin being the
[163]164 left bottom corner.
[234]165    It is a vector made of 3 elements giving the number of column to be done in the
[402]166 drawing, the number of line and the number of the case the number have to fill
167 (see matlab). For example, to do 6 drawings in 3 columns and 2 lines and
168 fill the 4th case, small=[2,3,4]
[163]169
170   
171
172    <a name="#_calibre_keyword_posfenetre"></a>
173    <h4>posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174     
175     
176     
177     
178     
179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
180     
181     
182    </h4>
183
184   
[234]185 It is a vector made of 4 elements containing the position of the frame
186 containing captions + the graph in normalized coordinates.
187 Comment: to position the drawing, we have to do !p.position=POSFENETRE
[163]188 after the call of calibre.
189
190   
191
192    <a name="#_calibre_keyword_posbar"></a>
193    <h4>posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
200     
201     
202    </h4>
203
204   
[234]205 See POSFENTERE but for the color bar. Same comment to position the color bar, !p.position=POSBAR
[163]206
207   
208   
209
210   
211    <h3>Keywords</h3>
212
213   
214    <a name="#_calibre_keyword_REMPLI"></a>
215    <h4>REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216     
217     
218     
219     
220     
221     
222     
223     
224    </h4>
225
226   
[402]227 Force the drawing to fill the biggest possible place defined by
228 SMALLDRAW without respect the y/x ratio.
[163]229
230   
231    <a name="#_calibre_keyword_YXASPECT"></a>
232    <h4>YXASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
233     
234     
235     
236     
237     
238     
239     
240     
241    </h4>
242
243   
[402]244 Force the y/x ratio to take the value RAPPORTYX*YXASPECT.
[163]245 This keyword can be used in 2 cases:
[402]246   1) YXASPECT=1 : force RAPPORTYX to be respected otherwise, calibre take the
247   initiative to change it a little in the case of the aspect ratio of SMALL
[234]248   is too different of the one of SMALLDRAW.
[402]249   2) YXASPECT=n : multiply by n the aspect ratio given by default.
250   For example in <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>, RAPPORTYX is calculated to the
251   reference be orthonormal,
[163]252   to have a reference where the y axis is 2 time bigger than the x one, YXASPECT=2.
253       
254   
255    <a name="#_calibre_keyword_PORTRAIT"></a>
256    <h4>PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263     
264     
265    </h4>
266
[234]267   
[163]268 Force the page or the window to be in standing position.
[234]269
[163]270   
271    <a name="#_calibre_keyword_LANDSCAPE"></a>
272    <h4>LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273     
274     
275     
276     
277     
278     
279     
280     
281    </h4>
282
[234]283   
[163]284 Force the page or the window on the screen to be in lengthened position.
[234]285
[163]286   
[234]287    <a name="#_calibre_keyword__EXTRA"></a>
288    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[163]289     
290     
291     
292     
293     
294     
295     
296     
297    </h4>
298
299   
[234]300 Used to pass keywords
[163]301
302   
303   
304
305   
[234]306    </pre><h3>Version history</h3>
[163]307   
308    <h4>Version</h4>
[402]309 $Id: calibre.pro 378 2008-08-12 12:35:46Z pinsard $
[338]310
[163]311    <h4>History</h4>
312 Sebastien Masson (smasson@lodyc.jussieu.fr)
313                        11/12/98
314
315   
316
317   
318   
319   
320   
321   
322
323    <h3>Other attributes</h3>
324   
325   
326    <h4>Uses routines</h4>
[402]327 <a href="../..//Obsolete/common.html">common</a>
[163]328
329   
330   
331   
332
333    <font size="-3"><p>&nbsp;</p></font>
334    <hr size="1" color="#CCCCCC"/>
335     
336
337   
338
[187]339    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]340
341  </body>
[249]342</html>
Note: See TracBrowser for help on using the repository browser.