Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/get_gridparams.html @ 378

Last change on this file since 378 was 338, checked in by smasson, 16 years ago
update documentation
File size: 7.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>get_gridparams.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="get_gridparams.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="../../../Interpolation//get_gridparams.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="fromreg.html"><<prev file</a> \| <a href="imoms3.html">next file >></a>    <a href="get_gridparams.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">Interpolation/</a></h1>
[89]	82	<h2 class="pro_file">get_gridparams.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[118]	89	<div id="file_comments">
[290]	90	Case 1: extract from a NetCDF file longitude and latitude arrays, their dimensions
[138]	91	and make sure it is 1D or 2D arrays
[118]	92
[290]	93	Case 2: given longitude and latitude arrays, get their dimensions and make
[138]	94	sure they are 1D or 2D arrays
[101]	95	</div>
[89]	96
	97
	98
	99
	100
	101
	102
	103
	104
	105	<div id="routine_details">
	106
	107
	108	<div class="routine_details" id="_get_gridparams">
	109
[157]	110	<h2><a class="top" href="#container">top</a>get_gridparams <span class="categories">
	111	Interpolation
[101]	112	</span></h2>
[89]	113
	114	<p class="header">
[290]	115	get_gridparams<span class="result">, <a href="#_get_gridparams_param_in1">in1</a>, <a href="#_get_gridparams_param_in2">in2</a>, <a href="#_get_gridparams_param_in3">in3</a>, <a href="#_get_gridparams_param_in4">in4</a>, <a href="#_get_gridparams_param_in5">in5</a>, <a href="#_get_gridparams_param_in6">in6</a>, <a href="#_get_gridparams_param_in7">in7</a>, <a href="#_get_gridparams_param_in8">in8</a></span>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<span class="result">scalar: 0 or 1</span></p>
[89]	116
	117	<div class="comments">
[101]	118	</div>
[89]	119
	120
	121
	122
	123	<h3>Parameters</h3>
	124
	125
	126	<h4 id="_get_gridparams_param_in1">in1
[101]	127	<span class="attr">in</span>
[89]	128
[163]	129
[101]	130	<span class="attr">required</span>
[89]	131
	132
	133
	134
	135	</h4>
	136
[138]	137	<div class="comments">
[290]	138	Case 1: name or the id (returned by ncdf_open) of the netcdf file
	139	Case 2: 1D or 2D arrays defining longitudes, will be forced to have
	140	n_dimensions dimensions when returned
[138]	141	</div>
[89]	142
	143	<h4 id="_get_gridparams_param_in2">in2
[101]	144	<span class="attr">in</span>
[89]	145
[163]	146
[101]	147	<span class="attr">required</span>
[89]	148
	149
	150
	151
	152	</h4>
	153
[138]	154	<div class="comments">
[290]	155	Case 1: name of the variable containing the longitude in the NetCDF file
	156	Case 2: 1D or 2D arrays defining latitudes, will be forced to have
	157	n_dimensions dimensions when returned
[138]	158	</div>
[89]	159
	160	<h4 id="_get_gridparams_param_in3">in3
	161
[103]	162
[89]	163
	164
	165
	166
[290]	167
	168
[89]	169	</h4>
	170
[290]	171	<div class="comments">
	172	Case 1: name of the variable containing the latitude in the NetCDF file
	173	Case 2: returned number of points in longitudinal direction.
[138]	174	</div>
[89]	175
	176	<h4 id="_get_gridparams_param_in4">in4
[163]	177
[101]	178	<span class="attr">out</span>
[89]	179
	180
	181
	182
	183
	184
	185	</h4>
	186
[138]	187	<div class="comments">
[290]	188	Case 1: returned longitudes array, with n_dimensions dimensions
	189	Case 2: returned number of points in latitudinal direction
[138]	190	</div>
[89]	191
	192	<h4 id="_get_gridparams_param_in5">in5
[163]	193
[89]	194
	195
	196
	197
	198
	199
[290]	200
[89]	201	</h4>
	202
[138]	203	<div class="comments">
[290]	204	Case 1: returned latitudes array, with n_dimensions dimensions
	205	Case 2: input scalar (1 or 2) to specify if lon and lat should be returned
	206	as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
	207	regular (longitude and latitudes can be described as 1D arrays).
[101]	208	</div>
[89]	209
	210	<h4 id="_get_gridparams_param_in6">in6
	211
[101]	212	<span class="attr">out</span>
[89]	213
	214
	215
	216
	217
	218
	219	</h4>
	220
[138]	221	<div class="comments">
[290]	222	Case 1: returned number of points in longitudinal direction.
[138]	223	</div>
[89]	224
	225	<h4 id="_get_gridparams_param_in7">in7
	226
[101]	227	<span class="attr">out</span>
[89]	228
	229
	230
	231
	232
	233
	234	</h4>
	235
[138]	236	<div class="comments">
[290]	237	Case 1: returned number of points in latitudinal direction
[138]	238	</div>
[89]	239
	240	<h4 id="_get_gridparams_param_in8">in8
[290]	241	<span class="attr">in</span>
[89]	242
	243
	244
	245
	246
	247
	248
	249	</h4>
	250
[138]	251	<div class="comments">
[290]	252	Case 1: input scalar (1 or 2) to specify if lon and lat should be returned
	253	as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
	254	regular (longitude and latitudes can be described as 1D arrays).
[163]	255	</div>
[89]	256
	257
	258
	259
	260
	261
	262	<h3>Keywords</h3>
	263
	264	<h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE
	265
	266
	267
	268
	269
[290]	270	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	271	<span class="attr">default:</span> <span class="value">0</span>
[89]	272
	273	</h4>
	274
[138]	275	<div class="comments">
[290]	276	activate to force double precision for lon/lat arrays
[118]	277	</div>
[89]	278
	279
	280
[138]	281	<h3>Examples</h3><div class="preformat">
[118]	282
[290]	283	Case 1:
	284	IDL> get_gridparams, file name/id, lonname, latname, lon, lat, jpi, jpj, n_dimensions
[101]	285
[290]	286	Case 2:
[121]	287	IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions
[101]	288
[118]	289
	290
	291	1) IDL> ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $
[101]	292	, olon, olat, jpio, jpjo, 2
	293
[118]	294	2) IDL> ncdf_get_gridparams, olon, olat, jpio, jpjo, 2
[101]	295	</div>
	296	<h3>Version history</h3>
[89]	297
[234]	298	<h4>Version</h4><div class="preformat">
[338]	299	$Id: get_gridparams.pro 327 2007-12-13 16:22:35Z pinsard $
[118]	300	</div>
[138]	301	<h4>History</h4><div class="preformat">
[118]	302	November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
	303	</div>
[89]	304
	305
	306
	307
	308
	309
	310
	311
	312
	313
	314
	315
	316
	317
	318
	319
[163]	320	<h3>Statistics</h3>
	321	<table class="statistics">
[290]	322	<tr><td>McCabe cyclic</td><td> 34</td></tr>
[163]	323	<tr><td>McCabe essential</td><td> 1</td></tr>
	324	<tr><td>McCabe modular design</td><td> 1</td></tr>
	325	</table>
[89]	326
	327
	328	</div>
	329
	330	</div>
	331
	332
	333
	334	<div id="tagline">Produced by IDLdoc 2.0.</div>
	335
	336	</div>
	337
	338	</body>
[249]	339	</html>

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

Download in other formats: