Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/LECTURE/litchamp.html @ 338

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

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>litchamp.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="inverse_binary.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="ncdf_lec.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/LECTURE/</font></h1>
58	<h2>litchamp.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Allows to read an array or a structure corresponding to a field.
65	If we have in input:
66	- an array, litchamp send back the array.
67	- a structure, litchamp send back the first element of the structure
68	which must be the field in an array.
69	litchamp profit of this to look other elements of the structure and
70	update if needed global variables which refer to the field:
71	vargrid, varname, varunit, vardate, varexp , valmask et time
72
73
74
75
76
77	<a name="#_litchamp"></a>
78
79	<h2>litchamp <font size="-1" color="#006633">
80	Graphics
81	</font></h2>
82
83	<p><font face="Courier"><i>result = </i>litchamp(<i><a href="#_litchamp_keyword_struct">struct</a></i>, <a href="#_litchamp_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_litchamp_keyword_NAME">NAME</a>=<i>NAME</i>, <a href="#_litchamp_keyword_UNIT">UNIT</a>=<i>UNIT</i>, <a href="#_litchamp_keyword_EXP">EXP</a>=<i>EXP</i>, <a href="#_litchamp_keyword_DATE">DATE</a>=<i>DATE</i>, <a href="#_litchamp_keyword_LEVEL">LEVEL</a>=<i>LEVEL</i>, <a href="#_litchamp_keyword_MASK">MASK</a>=<i>MASK</i>)</font></p>
84
85
86
87
88	<h3>Return value</h3>
89	It is the array containing the field.
90
91
92
93	<h3>Parameters</h3>
94
95
96	<a name="#_litchamp_keyword_struct"></a>
97	<h4>struct
98	<font size="-1" color="#006633">in</font>
99
100
101	<font size="-1" color="#006633">required</font>
102
103	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array or structure</i></font>
104
105
106	</h4>
107
108
109	If STRUCT is a structure, it must follow following rules:
110	-the first element is the array containing the field.
111	-other elements are strings containing informations on the field except
112	for the one about the date. This one can be either a string to designate
113	a particular date (ex: 'August 1999') or a vector of julian days (of IDL)
114	corresponding to the calendar to be associated with the field if it is a
115	temporal series.
116	-the order of elements (except the first) has not any importance.
117	-the other elements (except the first) are optional.
118	-they are recognized by the first letter of their names:
119	g to update vargrid,
120	u to update varunit,
121	e to update varexp,
122	d to update vardate,
123	n to update varname,
124	m to update valmask
125
126
127
128
129
130	<h3>Keywords</h3>
131
132
133	<a name="#_litchamp_keyword_GRID"></a>
134	<h4>GRID
135
136
137
138
139
140
141
142
143	</h4>
144
145
146	We activate this keyword if we want litchamp to send back the variable
147	associated with the element of the structure starting by 'g' if it exist
148	and '' if it does not.
149
150
151	<a name="#_litchamp_keyword_NAME"></a>
152	<h4>NAME
153
154
155
156
157
158
159
160
161	</h4>
162
163
164	We activate this keyword if we want litchamp to send back the variable
165	associated with the element of the structure starting by 'n' if it exist
166	and '' if it does not.
167
168
169	<a name="#_litchamp_keyword_UNIT"></a>
170	<h4>UNIT
171
172
173
174
175
176
177
178
179	</h4>
180
181
182	We activate this keyword if we want litchamp to send back the variable
183	associated with the element of the structure starting by 'u' if it exist
184	and '' if it does not.
185
186
187	<a name="#_litchamp_keyword_EXP"></a>
188	<h4>EXP
189
190
191
192
193
194
195
196
197	</h4>
198
199
200	We activate this keyword if we want litchamp to send back the variable
201	associated with the element of the structure starting by 'u' if it exist
202	and '' if it does not.
203
204
205	<a name="#_litchamp_keyword_DATE"></a>
206	<h4>DATE
207
208
209
210
211
212
213
214
215	</h4>
216
217
218	We activate this keyword if we want litchamp to send back the variable
219	associated with the element of the structure starting by 'd' if it exist
220	and '' if it does not.
221
222
223	<a name="#_litchamp_keyword_LEVEL"></a>
224	<h4>LEVEL
225
226
227
228
229
230
231
232
233	</h4>
234
235
236	We activate this keyword if we want litchamp to send back the variable
237	associated with the element of the structure starting by 'l' if it exist
238	and -1 if it does not.
239
240
241	<a name="#_litchamp_keyword_MASK"></a>
242	<h4>MASK
243
244
245
246
247
248
249
250
251	</h4>
252
253
254	We activate this keyword if we want litchamp to send back the variable
255	associated with the element of the structure starting by 'm' if it exist
256	and -1 if it does not.
257
258
259
260
261	<h3>Examples</h3><pre>
262
263	IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
264	T, , , 0,
265	IDL> help, litchamp({a:indgen(5), u:'C', name:'toto'})
266	<Expression> INT = Array[5]
267	IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
268	T, toto, C, 0,
269	IDL> help, litchamp({a:indgen(5), da:'1999'})
270	<Expression> INT = Array[5]
271	IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
272	T, toto, C, 1999,
273
274
275	</pre><h3>Version history</h3>
276
277	<h4>Version</h4>
278	$Id: litchamp.pro 327 2007-12-13 16:22:35Z pinsard $
279
280	<h4>History</h4>
281	Sebastien Masson (smasson@lodyc.jussieu.fr)
282	28/5/1999
283
284
285
286	<h3>Known issues</h3>
287
288
289
290	<h4>Restrictions</h4>
291	Update if needed global variables vargrid,
292	varname, varunit, vardate, varexp, valmask and time.
293
294
295	<h3>Other attributes</h3>
296
297
298	<h4>Uses routines</h4>
299	common.pro
300
301
302
303
304
305	<font size="-3"><p> </p></font>
306	<hr size="1" color="#CCCCCC"/>
307
308
309
310
311	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
312
313	</body>
314	</html>

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

Download in other formats: