Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 13.2 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>placedessin.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="placecolor.html"><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="projsegment.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/PLOTS/DIVERS/</font></h1>
58	<h2>placedessin.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Putting into place of the drawing/ opening of the window or of the PS
65
66
67
68
69
70	<a name="#_placedessin"></a>
71
72	<h2>placedessin <font size="-1" color="#006633">
73	Utilities
74	</font></h2>
75
76	<p><font face="Courier">placedessin<i>, <a href="#_placedessin_keyword_typedessin">typedessin</a>, <a href="#_placedessin_keyword_posfenetre">posfenetre</a>, <a href="#_placedessin_keyword_posbar">posbar</a>[, <a href="#_placedessin_keyword_dtasize">dtasize</a>]</i>, <a href="#_placedessin_keyword_BARMARGES">BARMARGES</a>=<i>BARMARGES</i>, <a href="#_placedessin_keyword_NOCOLORBAR">NOCOLORBAR</a>=<i>NOCOLORBAR</i>, <a href="#_placedessin_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_placedessin_keyword_COLOR_c">COLOR_c</a>=<i>COLOR_c</i>, <a href="#_placedessin_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_placedessin_keyword_VECTEUR">VECTEUR</a>=<i>vector</i>, <a href="#_placedessin_keyword_PORTRAIT">PORTRAIT</a>=<i>PORTRAIT</i>, <a href="#_placedessin_keyword_LANDSCAPE">LANDSCAPE</a>=<i>LANDSCAPE</i>, <a href="#_placedessin_keyword_SMALL">SMALL</a>=<i>SMALL</i>, <a href="#_placedessin_keyword_MARGES">MARGES</a>=<i>MARGES</i>, <a href="#_placedessin_keyword_MAP">MAP</a>=<i>MAP</i>, <a href="#_placedessin_keyword_REMPLI">REMPLI</a>=<i>REMPLI</i>, <a href="#_placedessin_keyword_POST">POST</a>=<i>POST</i>, <a href="#_placedessin_keyword_WINDOW">WINDOW</a>=<i>WINDOW</i>, <a href="#_placedessin_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_placedessin_keyword_TYPE">TYPE</a>=<i>TYPE</i>, <a href="#_placedessin_keyword_BASICMARGES">BASICMARGES</a>=<i>BASICMARGES</i>, <a href="#_placedessin_keyword_NOERASE">NOERASE</a>=<i>NOERASE</i>, <a href="#_placedessin_keyword_LCT">LCT</a>=<i>integer</i>, <a href="#_placedessin_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_placedessin_keyword_CB_TITLE">CB_TITLE</a>=<i>CB_TITLE</i>, <a href="#_placedessin_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78
79
80
81
82
83
84	<h3>Parameters</h3>
85
86
87	<a name="#_placedessin_keyword_typedessin"></a>
88	<h4>typedessin
89
90
91
92
93
94	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
95
96
97	</h4>
98
99
100	It specify what procedure is called by <a href="../../..//ToBeReviewed/PLOTS/DIVERS/placedessin.html">placedessin</a> :
101	'plt', 'pltz' or 'pltt'
102
103
104
105	<a name="#_placedessin_keyword_posfenetre"></a>
106	<h4>posfenetre
107
108	<font size="-1" color="#006633">out</font>
109
110
111
112	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
113
114
115	</h4>
116
117
118	It is a vector composed by 4 elements containing the position of the frame
119	containing captions and the graph in normalized coordinates.
120	Comment: To position the drawing; we have to do !p.position=posfenetre
121	after the call of the caliber
122
123
124
125	<a name="#_placedessin_keyword_posbar"></a>
126	<h4>posbar
127
128	<font size="-1" color="#006633">out</font>
129
130
131
132	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
133
134
135	</h4>
136
137
138	Like POSFENETRE but for the color bar.
139	Same comment to position the color bar, !p.position=posbar
140
141
142
143	<a name="#_placedessin_keyword_dtasize"></a>
144	<h4>dtasize
145	<font size="-1" color="#006633">in</font>
146
147	<font size="-1" color="#006633">optional</font>
148
149
150	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font>
151
152
153	</h4>
154
155
156	used by <a href="../../..//ToBeReviewed/PLOTS/DESSINE/pltv.html">pltv</a> to specify the size of the array that will be plotted
157	and therefore the default yxaspect to be used.
158
159
160
161
162
163	<h3>Keywords</h3>
164
165
166	<a name="#_placedessin_keyword_BARMARGES"></a>
167	<h4>BARMARGES
168
169
170
171
172
173
174
175
176	</h4>
177
178
179
180	<a name="#_placedessin_keyword_NOCOLORBAR"></a>
181	<h4>NOCOLORBAR
182
183
184
185
186
187
188
189
190	</h4>
191
192
193	We active it if we do not want the colorbar.
194
195
196	<a name="#_placedessin_keyword_NOFILL"></a>
197	<h4>NOFILL
198
199
200
201
202
203
204
205
206	</h4>
207
208
209	We active it if we only want contours in black and white with a white background.
210
211
212	<a name="#_placedessin_keyword_COLOR_c"></a>
213	<h4>COLOR_c
214
215
216
217
218
219
220
221
222	</h4>
223
224
225	To draw the contour in color instead of in black
226	with filling in color
227
228
229	<a name="#_placedessin_keyword_CONTOUR"></a>
230	<h4>CONTOUR
231
232
233
234
235
236
237
238
239	</h4>
240
241
242	If we want to trace contours of a different field than the one
243	whose we have the colored drawing (by example E-P in color and QSR in contours).
244	It must be a field respecting same characteristics than the argument number
245	one of <a href="../../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
246
247
248	<a name="#_placedessin_keyword_VECTEUR"></a>
249	<h4>VECTEUR
250
251
252
253
254
255	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
256
257
258	</h4>
259
260	is also appropriated.
261
262
263	<a name="#_placedessin_keyword_PORTRAIT"></a>
264	<h4>PORTRAIT
265
266
267
268
269
270
271
272
273	</h4>
274
275
276	Force the page or the window to be in standing position.
277
278
279	<a name="#_placedessin_keyword_LANDSCAPE"></a>
280	<h4>LANDSCAPE
281
282
283
284
285
286
287
288
289	</h4>
290
291
292	Force the page or the window on the screen to be in lengthened position.
293
294
295	<a name="#_placedessin_keyword_SMALL"></a>
296	<h4>SMALL
297
298
299
300
301
302
303
304
305	</h4>
306
307
308	Vector composed of 3 or 4 elements, applied to make a drawing on a
309	small portion of a page or screen. It delimit the zone where the drawing will be done.
310	If there is 4 elements:
311	then is constituted of coordinates (expressed in cm located from the up and
312	left corner of the page or the window (in portrait like in landscape) of the bottom
313	and left corner and of the up and right corner of the drawing zone.
314	If there is 3 elements:
315	in this case, we divide the page or the screen in small[0] columns and in small[1] lines
316	the drawing made in the box numbered small[2]. The numerotation starting up and left by
317	the number 1 and then, following the writing direction.
318	By default, we make the largest drawing we can do, conserving the aspect rapport
319	(except when REMPLI is activated).
320
321
322	<a name="#_placedessin_keyword_MARGES"></a>
323	<h4>MARGES
324
325
326
327
328
329
330
331
332	</h4>
333
334
335
336	<a name="#_placedessin_keyword_MAP"></a>
337	<h4>MAP
338
339
340
341
342
343
344
345
346	</h4>
347
348
349	We use it when we want to do a projection.
350	This keyword can be of two types:
351	MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
352	/MAP: In this case, map is automatically calculated have the value:
353	map = [0, (lon1+lon2)/2., 0]
354	Comment 1: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
355	IDL> demo
356	Then choose earth sciences and mapping.
357	Comment 2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
358	If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
359	For example, for a polar projection centered on the south pole:
360	IDL> domdef,-180,180,-90,-45
361	IDL> plt, tab, /stereo,map=[-90,0,0]
362
363
364	<a name="#_placedessin_keyword_REMPLI"></a>
365	<h4>REMPLI
366
367
368
369
370
371
372
373
374	</h4>
375
376
377	Force the drawing to occupy the whole space defined by small.
378
379
380	<a name="#_placedessin_keyword_POST"></a>
381	<h4>POST
382
383
384
385
386
387
388
389
390	</h4>
391
392
393	Make a postscript. Only works if we made one drawing on the page.
394	If we make several drawing, use @<a href="../../..//ToBeReviewed/POSTSCRIPT/ps.html">ps</a>.
395
396
397	<a name="#_placedessin_keyword_WINDOW"></a>
398	<h4>WINDOW
399
400
401
402
403
404
405
406
407	</h4>
408
409
410	Number of the window on which we want to do the graph (Allow to open several windows).
411	By default, we open 'IDL0'
412
413
414	<a name="#_placedessin_keyword_ENDPOINTS"></a>
415	<h4>ENDPOINTS
416
417
418
419
420
421
422
423
424	</h4>
425
426
427	keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
428	of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
429	coordinates.
430
431
432	<a name="#_placedessin_keyword_TYPE"></a>
433	<h4>TYPE
434
435
436
437
438
439
440
441
442	</h4>
443
444
445
446	<a name="#_placedessin_keyword_BASICMARGES"></a>
447	<h4>BASICMARGES
448
449
450
451
452
453
454
455
456	</h4>
457
458
459
460	<a name="#_placedessin_keyword_NOERASE"></a>
461	<h4>NOERASE
462
463
464
465
466
467
468
469
470	</h4>
471
472
473	We active it to make a drawing without creating a new frame.
474
475
476	<a name="#_placedessin_keyword_LCT"></a>
477	<h4>LCT
478
479
480
481
482
483	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
484
485
486	</h4>
487
488
489	It designate the number of the palette of color we want to use for the plot.
490
491
492	<a name="#_placedessin_keyword_DIREC"></a>
493	<h4>DIREC
494
495
496
497
498
499
500
501
502	</h4>
503
504
505	't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
506	'xzt' 'yzt' 'xyzt' Direction on which do averages
507
508
509	<a name="#_placedessin_keyword_CB_TITLE"></a>
510	<h4>CB_TITLE
511
512
513
514
515
516
517
518
519	</h4>
520
521
522	The colorbar's title
523
524
525	<a name="#_placedessin_keyword__EXTRA"></a>
526	<h4>_EXTRA
527
528
529
530
531
532
533
534
535	</h4>
536
537
538	Used to pass keywords
539
540
541
542
543
544	</pre><h3>Version history</h3>
545
546	<h4>Version</h4>
547	$Id: placedessin.pro 327 2007-12-13 16:22:35Z pinsard $
548
549	<h4>History</h4>
550	Sebastien Masson (smasson@lodyc.jussieu.fr)
551	26/4/1999
552
553
554
555
556
557
558
559
560
561	<h3>Other attributes</h3>
562
563
564	<h4>Uses routines</h4>
565	common.pro
566
567
568
569
570
571	<font size="-3"><p> </p></font>
572	<hr size="1" color="#CCCCCC"/>
573
574
575
576
577	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
578
579	</body>
580	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: