Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html @ 338

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

Rev	Line
[89]	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>
[104]	9	<title>xncdf_lec.pro (SAXO Documentation)</title>
[89]	10
	11
[191]	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" />
[89]	14
	15
	16	<script type="text/javascript">
	17	function setTitle() {
[104]	18	parent.document.title="xncdf_lec.pro (SAXO Documentation)";
[89]	19	}
	20	</script>
	21	</head>
	22
	23	<body onload="setTitle();">
	24
	25	<div id="navbar_title">
[104]	26	<h1>SAXO Documentation</h1>
[89]	27	</div>
	28
	29
	30	<div id="main_navbar">
	31
	32	<table cellspacing="0">
	33	<tr>
	34
[189]	35	<td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]	36
	37
	38
	39	<td >Directory</td>
	40
	41
	42
[189]	43	<td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]	44
	45
	46
[189]	47	<td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]	48
	49
	50
[189]	51	<td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]	52
	53
	54	<td id="selected">File</td>
	55
	56
[189]	57	<td><a href="../../../../ToBeReviewed/LECTURE//xncdf_lec.pro" title="Source code of a file">Source</a></td>
[89]	58
	59
	60
[189]	61	<td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]	62
	63
	64	<td >Etc</td>
	65
	66	<td id="flexible">Developer documentation</td>
	67	</tr>
	68	</table>
	69
	70	</div>
	71
	72	<div id="secondary_navbar">
	73
[189]	74	<a href="read_ncdf_varget.html"><<prev file</a> \| next file >>    <a href="xncdf_lec.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
[89]	75
	76	</div>
	77
	78
	79	<div id="container">
	80
[189]	81	<h1 class="directory"><a href="directory-overview.html">ToBeReviewed/LECTURE/</a></h1>
[89]	82	<h2 class="pro_file">xncdf_lec.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[151]	89	<div id="file_comments">
[321]	90	Reading of a NetCdf file with widgets
[89]	91
[151]	92
	93	Procedure called by xmanager when we press on a button of a second widget created by wid_var.
	94
[234]	95
[321]	96	This procedure manage the second created widget when we call xncdf_lec.
[151]	97	This widget concern the reading of the variable.
	98
	99
[234]	100	Procedure called by xmanager when we press a button of the first widget
[151]	101	created by par xncdf_lec
[234]	102	</div>
[151]	103
[89]	104
	105
	106
	107
	108
	109
	110
	111	<div id="routine_summary">
	112	<h2>Routine summary</h2>
	113
	114	<dl>
	115
[163]	116	<dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">[name]</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">vector</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">vector</span>, IODIR=<span class="result">string</span>, SHIFT=<span class="result">vector</span>, STRIDE=<span class="result">vector</span>, VAR=<span class="result">VAR</span>)</a></p><dt>
[151]	117	<dd> </dd>
	118
[89]	119	<dt><p><a href="#_wid_var_event">wid_var_event<span class="result">, event</span></a></p><dt>
[234]	120	<dd> </dd>
[89]	121
	122	<dt><p><a href="#_wid_var">wid_var<span class="result">, widid_pere</span></a></p><dt>
[234]	123	<dd> </dd>
[89]	124
	125	<dt><p><a href="#_xncdf_lec_event">xncdf_lec_event<span class="result">, event</span></a></p><dt>
[234]	126	<dd> </dd>
[89]	127
	128	</dl>
	129	</div>
	130
	131
	132	<div id="routine_details">
	133
	134
[151]	135	<div class="routine_details" id="_xncdf_lec">
[89]	136
[234]	137	<h2><a class="top" href="#container">top</a>xncdf_lec <span class="categories">
[157]	138	Widget
[151]	139	</span></h2>
[89]	140
	141	<p class="header">
[163]	142	<span class="result">result = </span>xncdf_lec(<span class="result">[<a href="#_xncdf_lec_param_name">name</a>]</span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">string</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p>
[89]	143
[151]	144	<div class="comments">
	145	</div>
[89]	146
[151]	147	<h3>Return value</h3><div class="preformat">
	148	2 different cases:
	149	1) None attribute has been selected. In this case, res is the array we
	150	wanted to read.
[234]	151	2) Some attributes has been selected. In this case, res is a structure
	152	whose the first element having the name of the variable is the values
[151]	153	array and the other arguments are the select arguments.
	154	</div>
[89]	155
	156
	157	<h3>Parameters</h3>
	158
	159
[151]	160	<h4 id="_xncdf_lec_param_name">name
	161	<span class="attr">in</span>
[89]	162
[151]	163	<span class="attr">optional</span>
[89]	164
	165
[163]	166	<span class="attr">type:</span> <span class="value">string</span>
[89]	167
	168
	169	</h4>
	170
[234]	171	<div class="comments">
	172	It give the name of the file to be opened. If NAME
	173	does not contain the separating character of directories ('/' under
[151]	174	unix for example), the file will be looked for in the current directory.
	175	</div>
[89]	176
	177
	178
	179
	180
	181
[151]	182	<h3>Keywords</h3>
	183
	184	<h4 id="_xncdf_lec_keyword_ATT">ATT
	185
	186
	187
	188
	189
	190
	191
	192
	193	</h4>
	194
	195	<div class="comments"></div>
	196
	197	<h4 id="_xncdf_lec_keyword_COUNT">COUNT
	198
	199
	200
	201
	202
[163]	203	<span class="attr">type:</span> <span class="value">vector</span>
[151]	204
	205
	206	</h4>
	207
	208	<div class="comments">
	209	An optional vector containing the counts to be used in
	210	reading Value. COUNT is a 1-based vector with an element for
	211	each dimension of the data to be written.The default matches
	212	the size of the variable so that all data is written out.
	213	</div>
	214
	215	<h4 id="_xncdf_lec_keyword_GROUP">GROUP
	216
	217
	218
	219
	220
	221
	222
	223
	224	</h4>
	225
	226	<div class="comments">
	227	The widget ID of the widget that calls XNCDF_LEC. When
	228	this ID is specified, a death of the caller results in a death
[234]	229	of XNCDF_LEC.
[151]	230	</div>
	231
	232	<h4 id="_xncdf_lec_keyword_OFFSET">OFFSET
	233
	234
	235
	236
	237
[163]	238	<span class="attr">type:</span> <span class="value">vector</span>
	239	<span class="attr">default:</span> <span class="value">[0, 0,...]</span>
[151]	240
	241	</h4>
	242
	243	<div class="comments">
	244	An optional vector containing the starting position
	245	for the read. The default start position is [0, 0, ...].
	246	</div>
	247
	248	<h4 id="_xncdf_lec_keyword_IODIR">IODIR
	249
	250
	251
	252
	253
[163]	254	<span class="attr">type:</span> <span class="value">string</span>
[151]	255
	256
	257	</h4>
	258
	259	<div class="comments">
[163]	260	It contains the directory where to go look for the file to be read.
[234]	261	If NAME does not contain the separating character of directories ('/' under
[151]	262	unix for example), the file will be called iodir+nom_fichier.
	263	</div>
	264
	265	<h4 id="_xncdf_lec_keyword_SHIFT">SHIFT
	266
	267
	268
	269
	270
[163]	271	<span class="attr">type:</span> <span class="value">vector</span>
	272	<span class="attr">default:</span> <span class="value">[0, 0,...]</span>
[151]	273
	274	</h4>
	275
	276	<div class="comments">
[234]	277	A vector of integers, specifying for each dimension how much we have to shift it.
[321]	278	By default, it is [0,0,...]. See the function <proidl>shift</proidl> for more explanations. BEWARE,
[234]	279	the shift is done on the biggest array before a possible reduction determined
	280	by OFFSET and COUNT. On the other hand, it is done after the possible extraction
[151]	281	created by the STRIDE.
	282	</div>
	283
	284	<h4 id="_xncdf_lec_keyword_STRIDE">STRIDE
	285
	286
	287
	288
	289
[163]	290	<span class="attr">type:</span> <span class="value">vector</span>
	291	<span class="attr">default:</span> <span class="value">[1, 1,...]</span>
[151]	292
	293	</h4>
	294
	295	<div class="comments">
	296	An optional vector containing the strides, or sampling
	297	intervals, between accessed values of the netCDF variable. The
	298	default stride vector is that for a contiguous read, [1, 1,...].
	299	</div>
	300
	301	<h4 id="_xncdf_lec_keyword_VAR">VAR
	302
	303
	304
	305
	306
	307
	308
	309
	310	</h4>
	311
	312	<div class="comments"></div>
	313
[89]	314
[151]	315
	316	<h3>Examples</h3><div class="preformat">
[321]	317	IDL> help, xncdf_lec()
[151]	318	</div>
	319	<h3>Version history</h3>
[89]	320
[151]	321	<h4>Version</h4><div class="preformat">
[338]	322	$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
	323	</div>
[157]	324	<h4>History</h4><div class="preformat">
	325	Sebastien Masson (smasson@lodyc.jussieu.fr)
	326	24/8/1999
	327	</div>
[89]	328
	329
	330
	331
	332
	333
	334
	335
	336	<h3>Other attributes</h3>
	337
	338
[151]	339	<h4>Uses routines</h4><div class="preformat">
	340	wididbase, infovariable, resultat, motcle
	341	</div>
[89]	342
	343
[138]	344	<h4>Common blocks used</h4><div class="preformat">wididbase
[151]	345	infovariable
[89]	346	resultat
	347	motcle</div>
	348
[163]	349	<h3>Statistics</h3>
	350	<table class="statistics">
	351	<tr><td>McCabe cyclic</td><td> 23</td></tr>
	352	<tr><td>McCabe essential</td><td> 1</td></tr>
	353	<tr><td>McCabe modular design</td><td> 1</td></tr>
	354	</table>
[89]	355
	356
	357	</div>
	358
	359
[151]	360	<div class="routine_details" id="_wid_var_event">
[89]	361
[151]	362	<h2><a class="top" href="#container">top</a>wid_var_event </h2>
[89]	363
	364	<p class="header">
[151]	365	wid_var_event<span class="result">, <a href="#_wid_var_event_param_event">event</a></span></p>
[89]	366
[234]	367	<div class="comments">
	368	</div>
[89]	369
	370
	371
	372
	373	<h3>Parameters</h3>
	374
	375
[151]	376	<h4 id="_wid_var_event_param_event">event
	377	<span class="attr">in</span>
[89]	378
	379
[151]	380	<span class="attr">required</span>
[89]	381
	382
	383
	384
	385	</h4>
	386
[151]	387	<div class="comments">
[321]	388	A structure characterizing the type of event which arrive to a widget number1 2
[151]	389	</div>
[89]	390
	391
	392
	393
	394
	395
	396
[151]	397	<h3>Version history</h3>
[89]	398
[151]	399	<h4>Version</h4><div class="preformat">
[338]	400	$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
	401	</div>
[89]	402
	403
	404
	405
	406
	407
	408
	409
	410
	411	<h3>Other attributes</h3>
	412
	413
[151]	414	<h4>Uses routines</h4><div class="preformat">
	415	wididbase,resultat,infovariable,indicewid,motcle
[234]	416	</div>
[89]	417
	418
[151]	419	<h4>Common blocks used</h4><div class="preformat">wididbase
	420	resultat
[89]	421	infovariable
	422	indicewid_var
	423	motcle</div>
	424
[163]	425	<h3>Statistics</h3>
	426	<table class="statistics">
	427	<tr><td>McCabe cyclic</td><td> 34</td></tr>
	428	<tr><td>McCabe essential</td><td> 1</td></tr>
	429	<tr><td>McCabe modular design</td><td> 1</td></tr>
	430	</table>
[89]	431
	432
	433	</div>
	434
	435
[151]	436	<div class="routine_details" id="_wid_var">
[89]	437
[151]	438	<h2><a class="top" href="#container">top</a>wid_var </h2>
[89]	439
	440	<p class="header">
[151]	441	wid_var<span class="result">, <a href="#_wid_var_param_widid_pere">widid_pere</a></span></p>
[89]	442
[234]	443	<div class="comments">
	444	</div>
[89]	445
	446
	447
	448
	449	<h3>Parameters</h3>
	450
	451
[151]	452	<h4 id="_wid_var_param_widid_pere">widid_pere
	453	<span class="attr">in</span>
[89]	454
	455
[151]	456	<span class="attr">required</span>
[89]	457
[163]	458	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	459
	460
	461	</h4>
	462
[151]	463	<div class="comments">
[234]	464	It contains the identity of the father widget which was
[151]	465	created by xncdf_lec and which has allowed to select the variable to be read.
	466	</div>
[89]	467
	468
	469
	470
	471
	472
	473
[151]	474	<h3>Version history</h3>
[89]	475
[151]	476	<h4>Version</h4><div class="preformat">
[338]	477	$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $</div>
[89]	478
	479
	480
	481
	482
	483
	484
	485
	486
	487	<h3>Other attributes</h3>
	488
	489
[234]	490	<h4>Uses routines</h4><div class="preformat">
[151]	491	resultat,infovariable,indicewid_var,motcle
	492	</div>
[89]	493
	494
[138]	495	<h4>Common blocks used</h4><div class="preformat">resultat
[89]	496	infovariable
[151]	497	indicewid_var
[89]	498	motcle</div>
	499
[163]	500	<h3>Statistics</h3>
	501	<table class="statistics">
	502	<tr><td>McCabe cyclic</td><td> 7</td></tr>
	503	<tr><td>McCabe essential</td><td> 1</td></tr>
	504	<tr><td>McCabe modular design</td><td> 1</td></tr>
	505	</table>
[89]	506
	507
	508	</div>
	509
	510
[151]	511	<div class="routine_details" id="_xncdf_lec_event">
[89]	512
[151]	513	<h2><a class="top" href="#container">top</a>xncdf_lec_event </h2>
[89]	514
	515	<p class="header">
[151]	516	xncdf_lec_event<span class="result">, <a href="#_xncdf_lec_event_param_event">event</a></span></p>
[89]	517
[234]	518	<div class="comments">
	519	</div>
[89]	520
	521
	522
	523
	524	<h3>Parameters</h3>
	525
	526
[151]	527	<h4 id="_xncdf_lec_event_param_event">event
[89]	528
	529
	530
	531
	532
	533
	534
	535
	536	</h4>
	537
[151]	538	<div class="comments">
[321]	539	A structure characterising the event type which arrive at the widget number 1.
[151]	540	</div>
[89]	541
	542
	543
	544
	545
	546
	547
[151]	548	<h3>Version history</h3>
[89]	549
[151]	550	<h4>Version</h4><div class="preformat">
[338]	551	$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
	552	</div>
[89]	553
	554
	555
	556
	557
	558
	559
	560
	561
	562	<h3>Other attributes</h3>
	563
	564
[151]	565	<h4>Uses routines</h4><div class="preformat">
	566	resultat, infovariable, motcle
	567	</div>
[89]	568
	569
[151]	570	<h4>Common blocks used</h4><div class="preformat">resultat
[89]	571	infovariable
	572	motcle</div>
	573
[163]	574	<h3>Statistics</h3>
	575	<table class="statistics">
	576	<tr><td>McCabe cyclic</td><td> 5</td></tr>
	577	<tr><td>McCabe essential</td><td> 1</td></tr>
	578	<tr><td>McCabe modular design</td><td> 1</td></tr>
	579	</table>
[89]	580
	581
	582	</div>
	583
	584	</div>
	585
	586
	587
	588	<div id="tagline">Produced by IDLdoc 2.0.</div>
	589
	590	</div>
	591
	592	</body>
[249]	593	</html>

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

Download in other formats: