Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html @ 200

Last change on this file since 200 was 200, checked in by smasson, 18 years ago
update idldoc documentation
File size: 10.0 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>ncdf_meshread.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="ncdf_meshread.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="../../../Grid//ncdf_meshread.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="n80gaussian.html"><<prev file</a> \| <a href="ncdf_meshroms.html">next file >></a>    <a href="ncdf_meshread.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">Grid/</a></h1>
[89]	82	<h2 class="pro_file">ncdf_meshread.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[103]	89	<div id="file_comments"> read NetCDF meshmask file created by OPA
	90	</div>
[89]	91
	92
	93
	94
	95
	96
	97
	98
	99
	100	<div id="routine_details">
	101
	102
	103	<div class="routine_details" id="_ncdf_meshread">
	104
[157]	105	<h2><a class="top" href="#container">top</a>ncdf_meshread <span class="categories">
	106	Grid
[103]	107	</span></h2>
[89]	108
	109	<p class="header">
[177]	110	ncdf_meshread<span class="result">[, <a href="#_ncdf_meshread_param_filename">filename</a>]</span>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<span class="result">CHECKDAT</span>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
[89]	111
	112	<div class="comments">
	113	</div>
	114
	115
	116
	117
	118	<h3>Parameters</h3>
	119
	120
	121	<h4 id="_ncdf_meshread_param_filename">filename
[103]	122	<span class="attr">in</span>
[89]	123
[103]	124	<span class="attr">optional</span>
[89]	125
	126
[177]	127	<span class="attr">type:</span> <span class="value">scalar string</span>
	128	<span class="attr">default:</span> <span class="value">'meshmask.nc'</span>
[89]	129
	130	</h4>
	131
[177]	132	<div class="comments">
	133	Name of the meshmask file to read. If this name does not contain any "/"
	134	and if iodirectory keyword is not specify, then the common variable
[103]	135	iodir will be use to define the mesh file path.
	136	</div>
[89]	137
	138
	139
	140
	141
	142
	143	<h3>Keywords</h3>
	144
	145	<h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY
	146
	147
	148
	149
	150
[177]	151	<span class="attr">type:</span> <span class="value">2 elements vector</span>
	152	<span class="attr">default:</span> <span class="value">those defined in the file</span>
[89]	153
	154	</h4>
	155
[177]	156	<div class="comments">
	157	Longitude boundaries that should be used to visualize the data.
[103]	158	lon2 > lon1
	159	lon2 - lon1 le 360
[177]	160	By default, the common (cm_4mesh) variable key_shift will be automatically
	161	defined according to GLAMBOUNDARY.
[103]	162	</div>
[89]	163
	164	<h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT
	165
	166
	167
	168
	169
	170
	171
	172
	173	</h4>
	174
[103]	175	<div class="comments"> Suppressed. Use micromeshmask.pro to create an
	176	appropriate meshmask.
	177	</div>
[89]	178
	179	<h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH
	180
	181
	182
	183
	184
[177]	185	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	186	<span class="attr">default:</span> <span class="value">1</span>
[89]	187
	188	</h4>
	189
[163]	190	<div class="comments">
[177]	191	Force the manual definition of data localization on the earth or not
	192	0) if the data are not on the earth
	193	1) if the data are on earth (in that case we can for example use
	194	the labels 'longitude', 'latitude' in plots).
	195	The resulting value will be stored in the common (cm_4mesh) variable key_onearth
	196	ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY
[103]	197	</div>
[89]	198
	199	<h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS
	200
	201
	202
	203
	204
[177]	205	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	206	<span class="attr">default:</span> <span class="value">0</span>
[89]	207
	208	</h4>
	209
[118]	210	<div class="comments">
[157]	211	Activate this keywords if you only want to know the dimension
	212	of the domain stored in the mesh file. This dimensions will be
	213	defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
[118]	214	</div>
[89]	215
	216	<h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC
	217
	218
	219
	220
	221
[177]	222	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	223	<span class="attr">default:</span> <span class="value">computed by using the first line of glamt</span>
[89]	224
	225	</h4>
	226
[163]	227	<div class="comments">
[177]	228	Force the manual definition of the grid zonal periodicity.
	229	The resulting value will be stored in the common (cm_4mesh) variable key_periodic
	230	PERIODIC = 0 forces SHIFT = 0
[103]	231	</div>
[89]	232
	233	<h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT
	234
	235
	236
	237
	238
[177]	239	<span class="attr">type:</span> <span class="value">scalar</span>
	240	<span class="attr">default:</span> <span class="value">computed according to glamboundary</span>
[89]	241
	242	</h4>
	243
[163]	244	<div class="comments">
[177]	245	Force the manual definition of the zonal shift that must be apply to the data.
	246	The resulting value will be stored in the common (cm_4mesh) variable key_shift
	247	Note that if key_periodic=0 then in any case key_shift = 0.
[103]	248	</div>
[89]	249
	250	<h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE
	251
	252
	253
	254
	255
[177]	256	<span class="attr">type:</span> <span class="value">3 elements vector</span>
	257	<span class="attr">default:</span> <span class="value">[1, 1, 1]</span>
[89]	258
	259	</h4>
	260
[177]	261	<div class="comments">
	262	Specify the stride in x, y and z direction. The resulting
	263	value will be stored in the common (cm_4mesh) variable key_stride
[103]	264	</div>
[89]	265
	266	<h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING
	267
	268
	269
	270
	271
[177]	272	<span class="attr">type:</span> <span class="value">scalar string</span>
[89]	273
	274
	275	</h4>
	276
[163]	277	<div class="comments">
[177]	278	the calling command used to call computegrid (this is used by xxx.pro)
[103]	279	</div>
[89]	280
	281	<h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA
	282
	283
	284
	285
	286
	287
	288
	289
	290	</h4>
	291
[177]	292	<div class="comments"> used to pass isafile keywords
[118]	293	</div>
[89]	294
	295
	296
[138]	297	<h3>Examples</h3><div class="preformat">
[103]	298	IDL> ncdf_meshread [,' filename']
[121]	299	</div>
[103]	300	<h3>Version history</h3>
[89]	301
[177]	302	<h4>Version</h4><div class="preformat"> $Id: ncdf_meshread.pro 172 2006-09-11 07:11:26Z smasson $
[118]	303	</div>
[138]	304	<h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
[103]	305	12/1999
	306	July 2004, Sebastien Masson: Several modifications (micromeshmask,
	307	clean partial steps, clean use of key_stride, automatic definition
	308	of key_shift, ...)
	309	Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
[121]	310	Aug. 2005, Sebastien Masson: some cleaning + english
[118]	311	</div>
[89]	312
	313
[103]	314	<h3>Known issues</h3>
[89]	315
	316
	317
[177]	318	<h4>Restrictions</h4><div class="preformat">
[103]	319
	320	ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
[163]	321	be defined before calling ncdf_meshread. if some of those value
[121]	322	are equal to -1 they will be automatically defined
[103]	323	</div>
[89]	324
[103]	325	<h3>Other attributes</h3>
[89]	326
	327
[138]	328	<h4>Uses routines</h4><div class="preformat"> cm_4mesh cm_4data cm_4cal
[103]	329	</div>
[89]	330
	331
	332
	333
[163]	334	<h3>Statistics</h3>
	335	<table class="statistics">
	336	<tr><td>McCabe cyclic</td><td> 94</td></tr>
	337	<tr><td>McCabe essential</td><td> 1</td></tr>
	338	<tr><td>McCabe modular design</td><td> 1</td></tr>
	339	</table>
[89]	340
	341
	342	</div>
	343
	344	</div>
	345
	346
	347
	348	<div id="tagline">Produced by IDLdoc 2.0.</div>
	349
	350	</div>
	351
	352	</body>
[200]	353	</html>

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

Download in other formats: