Context Navigation

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

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

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

Download in other formats: