source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/POSTSCRIPT/calibre.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 8.2 KB
Line 
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   
64 From a rapport of aspect and values (in line of character) of different margins,
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
67 proportion.
68
69
70   
71
72     
73      <a name="#_calibre"></a>
74
75      <h2>calibre  <font size="-1" color="#006633"> 
76 Graphics
77
78 </font></h2>
79
80      <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>
81
82   
83
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   
103 Scale rapport between the length of the y axis and the x one. For example,
104 for an xy map: RAPPORTYX=(lat2-lat1)/(lon2-lon1)
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   
121 Vector made of 4 elements containing the size of the left, right, up and
122 bottom margin having to surround the graph. All is measured in lines of characters.
123
124   
125
126    <a name="#_calibre_keyword_margebar"></a>
127    <h4>margebar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128      <font size="-1" color="#006633">in</font>
129     
130     
131      <font size="-1" color="#006633">required</font>
132     
133      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
134     
135     
136    </h4>
137
138   
139 Vector made of 4 elements containing the size of the left, right and bottom
140 margin and -BEWARE- the last element is this time the position of the right up
141 corner, having to surround the color bar. All is measured in lines of characters.
142
143   
144
145    <a name="#_calibre_keyword_smalldraw"></a>
146    <h4>smalldraw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147      <font size="-1" color="#006633">in</font>
148     
149     
150      <font size="-1" color="#006633">required</font>
151     
152      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
153     
154     
155    </h4>
156
157   
158 2 possibilities:
159    It is vector made of 4 elements giving (in portrait or landscape) the position
160 of the frame in which the drawing must go in. This position is given by coordinates
161 of the 2 corners of the frame: in the left bottom and the right up. It is always
162 (for a postscript or a screen output) express in cm, the origin being the
163 left bottom corner.
164    It is a vector made of 3 elements giving the number of column to be done in the
165 drawing, the number of line and the number of the case the number have to occupy
166 (see matlab). For example, to do 6 drawing in 3 columns and 2 lines and occupy
167 the 4th case, small=[2,3,4]
168
169   
170
171    <a name="#_calibre_keyword_posfenetre"></a>
172    <h4>posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173     
174     
175     
176     
177     
178      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
179     
180     
181    </h4>
182
183   
184 It is a vector made of 4 elements containing the position of the frame
185 containing captions + the graph in normalized coordinates.
186 Comment: to position the drawing, we have to do !p.position=POSFENETRE
187 after the call of calibre.
188
189   
190
191    <a name="#_calibre_keyword_posbar"></a>
192    <h4>posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193     
194     
195     
196     
197     
198      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
199     
200     
201    </h4>
202
203   
204 See POSFENTRE but for the color bar. Same comment to position the color bar, !p.position=POSBAR
205
206   
207   
208
209   
210    <h3>Keywords</h3>
211
212   
213    <a name="#_calibre_keyword_REMPLI"></a>
214    <h4>REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215     
216     
217     
218     
219     
220     
221     
222     
223    </h4>
224
225   
226 Force the drawing to occupy the biggest possible place defined by
227 SMALLDRAW without respect the rapport y on x.
228
229   
230    <a name="#_calibre_keyword_YXASPECT"></a>
231    <h4>YXASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232     
233     
234     
235     
236     
237     
238     
239     
240    </h4>
241
242   
243 Force the rapport y on x to take the value RAPPORTYX*YXASPECT.
244 This keyword can be used in 2 cases:
245   1) YXASPECT=1 : force RAPPORTYX to be respected otherwise, Calibre take the
246   initiative to change it a little in the case of the aspect rapport of SMALL
247   is too different of the one of SMALLDRAW.
248   2) YXASPECT=n : multiply by n the aspect rapport given by default.
249   For example in plt, RAPPORTYX is calculated to the reference be orthonormal,
250   to have a reference where the y axis is 2 time bigger than the x one, YXASPECT=2.
251       
252   
253    <a name="#_calibre_keyword_PORTRAIT"></a>
254    <h4>PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
255     
256     
257     
258     
259     
260     
261     
262     
263    </h4>
264
265           
266 Force the page or the window to be in standing position.
267 
268   
269    <a name="#_calibre_keyword_LANDSCAPE"></a>
270    <h4>LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271     
272     
273     
274     
275     
276     
277     
278     
279    </h4>
280
281           
282 Force the page or the window on the screen to be in lengthened position.
283 
284   
285    <a name="#_calibre_keyword__extra"></a>
286    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
287     
288     
289     
290     
291     
292     
293     
294     
295    </h4>
296
297   
298 Used to pass your keywords
299
300   
301   
302
303   
304    <h3>Version history</h3>
305   
306    <h4>Version</h4>
307 $Id: calibre.pro 157 2006-08-21 09:01:50Z navarro $
308    <h4>History</h4>
309 Sebastien Masson (smasson@lodyc.jussieu.fr)
310                        11/12/98
311
312   
313
314   
315   
316   
317   
318   
319
320    <h3>Other attributes</h3>
321   
322   
323    <h4>Uses routines</h4>
324 common.pro
325
326   
327   
328   
329
330    <font size="-3"><p>&nbsp;</p></font>
331    <hr size="1" color="#CCCCCC"/>
332     
333
334   
335
336    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:27 2006.</font></p>
337
338  </body>
339</html>
Note: See TracBrowser for help on using the repository browser.