Context Navigation

read_ncdf.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago
update documentation
File size: 13.8 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>read_ncdf.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="read_ncdf.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//read_ncdf.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_ftp.html"><<prev file</a> \| <a href="read_ncdf_varget.html">next file >></a>    <a href="read_ncdf.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| routine    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">read_ncdf.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[151]	89	<div id="file_comments">
	90	Reading function for the file net_cdf.
[402]	91	This program is less universal than <a href="../..//ToBeReviewed/LECTURE/ncdf_lec.html">ncdf_lec</a> (it appeal to
	92	declared variables in <a href="../..//Obsolete/common.html">common</a>) but it is very easier to be used.
	93	It considerate
[151]	94	the declaration of the different zooms which have been defined
	95	(ixminmesh...premierx...), the declaration of the variable key_shift...
[402]	96	To put it in a nutshell, the result of read_ncdf can be directly used in
	97	<a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a> ...
	98
[234]	99	This is also this program which is used by default in our reading widgets.
[151]	100	</div>
[89]	101
	102
	103
	104
	105
	106
	107
	108
	109
	110	<div id="routine_details">
	111
	112
	113	<div class="routine_details" id="_read_ncdf">
	114
[151]	115	<h2><a class="top" href="#container">top</a>read_ncdf <span class="categories">
[157]	116	Reading
[234]	117	</span></h2>
[89]	118
	119	<p class="header">
[338]	120	<span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ZINVAR">ZINVAR</a>=<span class="result">named variable</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
[89]	121
[234]	122	<div class="comments">
	123	</div>
[89]	124
[151]	125	<h3>Return value</h3><div class="preformat">
[402]	126	Structure readable by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> or an array if NOSTRUCT is
	127	activated.
	128	</div>
[89]	129
	130
	131	<h3>Parameters</h3>
	132
	133
	134	<h4 id="_read_ncdf_param_name">name
[151]	135	<span class="attr">in</span>
[89]	136
	137
[151]	138	<span class="attr">required</span>
[89]	139
[163]	140	<span class="attr">type:</span> <span class="value">string</span>
[89]	141
	142
	143	</h4>
	144
[151]	145	<div class="comments">
[163]	146	It define the field to be read.
[151]	147	</div>
[89]	148
[151]	149	<h4 id="_read_ncdf_param_beginning">beginning
	150	<span class="attr">in</span>
[89]	151
	152
[151]	153	<span class="attr">required</span>
[89]	154
	155
	156
	157
	158	</h4>
	159
[151]	160	<div class="comments">
	161	Relative with the time axis.
	162	These can be
[402]	163	- 2 dates of the type yyyymmdd and in this case, we select data
[151]	164	which are included between these two dates.
[402]	165	- 2 indexes which define between which and which time steps we have
[163]	166	to extract the temporal dimension.
[151]	167	</div>
[89]	168
[151]	169	<h4 id="_read_ncdf_param_ending">ending
	170	<span class="attr">in</span>
[89]	171
	172
[151]	173	<span class="attr">required</span>
[89]	174
	175
	176
	177
	178	</h4>
	179
[151]	180	<div class="comments">
	181	Relative with the time axis.
	182	See BEGINNING.
[234]	183	</div>
[89]	184
[151]	185	<h4 id="_read_ncdf_param_compatibility">compatibility
	186	<span class="attr">in</span>
[89]	187
[177]	188	<span class="attr">optional</span>
[89]	189
	190
	191
	192
	193
	194	</h4>
	195
[151]	196	<div class="comments">
[177]	197	Useless, defined for compatibility
[234]	198	</div>
[89]	199
	200
	201
	202
	203
	204
	205	<h3>Keywords</h3>
	206
	207	<h4 id="_read_ncdf_keyword_BOXZOOM">BOXZOOM
	208
	209
	210
	211
	212
	213
	214
	215
	216	</h4>
	217
[234]	218	<div class="comments">
	219	Contain the boxzoom on which we have to do the reading
	220	</div>
[89]	221
	222	<h4 id="_read_ncdf_keyword_FILENAME">FILENAME
	223
	224
	225
[177]	226	<span class="attr">required</span>
[89]	227
[163]	228	<span class="attr">type:</span> <span class="value">string</span>
[89]	229
	230
	231	</h4>
	232
[151]	233	<div class="comments">
[321]	234	It contains the file's name.
[234]	235	</div>
[89]	236
	237	<h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN
	238
	239
	240
	241
	242
	243
	244
	245
	246	</h4>
	247
	248	<div class="comments"></div>
	249
	250	<h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP
	251
	252
	253
	254
	255
[177]	256	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	257	<span class="attr">default:</span> <span class="value">0</span>
[89]	258
	259	</h4>
	260
[151]	261	<div class="comments">
[402]	262	Specify that BEGINNING and ENDING refer to indexes of the time axis and not
	263	to dates
[151]	264	</div>
[89]	265
[290]	266	<h4 id="_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE
[89]	267
	268
	269
	270
	271
[290]	272	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	273	<span class="attr">default:</span> <span class="value">0</span>
[89]	274
	275	</h4>
	276
[151]	277	<div class="comments">
[402]	278	put 1 to apply add_offset and scale factor on data before looking for
[290]	279	missing values
[151]	280	</div>
[89]	281
	282	<h4 id="_read_ncdf_keyword_TOUT">TOUT
	283
	284
	285
	286
	287
[177]	288	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	289	<span class="attr">default:</span> <span class="value">0</span>
[89]	290
	291	</h4>
	292
[151]	293	<div class="comments">
[234]	294	We activate it if we want to read the file on the whole domain without
	295	considerate the sub-domain defined by the boxzoom or
[151]	296	lon1,lon2,lat1,lat2,vert1,vert2.
[234]	297	</div>
[89]	298
	299	<h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT
	300
	301
	302
	303
	304
[177]	305	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	306	<span class="attr">default:</span> <span class="value">0</span>
[89]	307
	308	</h4>
	309
[151]	310	<div class="comments">
[234]	311	We activate it if we do not want that read_ncdf send back a structure
[163]	312	but only the array referring to the field.
[234]	313	</div>
[89]	314
	315	<h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL
	316
	317
	318
	319
	320
	321
	322
	323
	324	</h4>
	325
	326	<div class="comments"></div>
	327
	328	<h4 id="_read_ncdf_keyword_INIT">INIT
	329
	330
	331
	332
	333
[177]	334	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	335	<span class="attr">default:</span> <span class="value">0</span>
[89]	336
	337	</h4>
	338
[151]	339	<div class="comments">
[402]	340	To call automatically <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a> with filename as input argument
	341	and thus redefine all the grid parameters
[234]	342	</div>
[89]	343
	344	<h4 id="_read_ncdf_keyword_GRID">GRID
	345
	346
	347
	348
	349
	350
	351
	352
	353	</h4>
	354
[151]	355	<div class="comments">
[163]	356	='[UTVWF]' to specify the type of grid. Default is (1)
[151]	357	based on the name of the file if the file ends by
	358	GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
	359	is not found.
[234]	360	</div>
[89]	361
[177]	362	<h4 id="_read_ncdf_keyword_CALLITSELF">CALLITSELF
	363
	364
	365
	366
	367
	368	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	369	<span class="attr">default:</span> <span class="value">0</span>
	370
	371	</h4>
	372
	373	<div class="comments">
[402]	374	For ROMS outputs. Use by read_ncdf itself to access auxilliary data
	375	(h and zeta).
[234]	376	</div>
[177]	377
[290]	378	<h4 id="_read_ncdf_keyword_DIREC">DIREC
	379
	380
	381
	382
	383
	384
	385
	386
	387	</h4>
	388
	389	<div class="comments">
	390	a string used to specify the direction along which we want to make
	391	spatial and/or temporal mean. It could be: 'x' 'y' 'z' 't' 'xy' 'xz'
[402]	392	'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt'
[290]	393	</div>
	394
[177]	395	<h4 id="_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME
	396
	397
	398
	399
	400
	401	<span class="attr">type:</span> <span class="value">string</span>
	402	<span class="attr">default:</span> <span class="value">FILENAME</span>
	403
	404	</h4>
	405
	406	<div class="comments">
[242]	407	For ROMS outputs. The filename of the file where zeta variable should be read
[177]	408	</div>
	409
	410	<h4 id="_read_ncdf_keyword_ZETAZERO">ZETAZERO
	411
	412
	413
	414
	415
	416	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	417	<span class="attr">default:</span> <span class="value">0</span>
	418
	419	</h4>
	420
	421	<div class="comments">
	422	For ROMS outputs. To define zeta to 0. instead of reading it
	423	</div>
	424
[338]	425	<h4 id="_read_ncdf_keyword_ZINVAR">ZINVAR
	426
	427
	428
	429
	430
	431	<span class="attr">type:</span> <span class="value">named variable</span>
	432
	433
	434	</h4>
	435
	436	<div class="comments">
	437	Set this keyword to a named variable in which 1 is returned if a
	438	vertical dimension is found in the variable. Returns 0 otherwise
	439	</div>
	440
[89]	441	<h4 id="_read_ncdf_keyword__EXTRA">_EXTRA
	442
	443
	444
	445
	446
	447
	448
	449
	450	</h4>
	451
[151]	452	<div class="comments">
[290]	453	Used to pass keywords to <a href="../..//Utilities/isafile.html">isafile</a>, <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a>,
[338]	454	<a href="../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a>, <a href="../..//ReadWrite/ncdf_getatt.html">ncdf_getatt</a> and <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
[151]	455	</div>
[89]	456
	457
	458
	459
[151]	460	<h3>Version history</h3>
[89]	461
[151]	462	<h4>Version</h4><div class="preformat">
[402]	463	$Id: read_ncdf.pro 399 2009-07-02 08:38:54Z smasson $
[338]	464	</div>
[157]	465	<h4>History</h4><div class="preformat">
	466	Sebastien Masson (smasson@lodyc.jussieu.fr)
[234]	467	15/10/1999
	468	</div>
[89]	469
	470
[151]	471	<h3>Known issues</h3>
[89]	472
	473
	474
[151]	475	<h4>Restrictions</h4><div class="preformat">
	476	The field must have a temporal dimension.
[234]	477	</div>
[89]	478
[151]	479	<h3>Other attributes</h3>
[89]	480
	481
[151]	482	<h4>Uses routines</h4><div class="preformat">
[402]	483	<a href="../..//Obsolete/common.html">common</a>
[234]	484	</div>
[89]	485
	486
	487
	488
[163]	489	<h3>Statistics</h3>
	490	<table class="statistics">
[290]	491	<tr><td>McCabe cyclic</td><td> 101</td></tr>
[163]	492	<tr><td>McCabe essential</td><td> 1</td></tr>
	493	<tr><td>McCabe modular design</td><td> 1</td></tr>
	494	</table>
[89]	495
	496
	497	</div>
	498
	499	</div>
	500
	501
	502
	503	<div id="tagline">Produced by IDLdoc 2.0.</div>
	504
	505	</div>
	506
	507	</body>
[249]	508	</html>

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

Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html @ 402

Download in other formats: