Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/neighbor.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 6.2 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>neighbor.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="neighbor.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//neighbor.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="map_npoints.html"><<prev file</a> \| <a href="quadrilateral2square.html">next file >></a>    <a href="neighbor.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">neighbor.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[101]	89	<div id="file_comments">
[242]	90	find the closest point of (P0) within a list of np1 points
	91	P1 which can be on a sphere
[101]	92	</div>
[89]	93
	94
	95
	96
	97
	98
	99
	100
	101
	102	<div id="routine_details">
	103
	104
	105	<div class="routine_details" id="_neighbor">
	106
[234]	107	<h2><a class="top" href="#container">top</a>neighbor <span class="categories">
	108	Maps
[101]	109	</span></h2>
[89]	110
	111	<p class="header">
[242]	112	<span class="result">result = </span>neighbor(<span class="result"><a href="#_neighbor_param_p0lon">p0lon</a>, <a href="#_neighbor_param_p0lat">p0lat</a>[, <a href="#_neighbor_param_neighlon">neighlon</a>][, <a href="#_neighbor_param_neighlat">neighlat</a>]</span>, <a href="#_neighbor_keyword_SPHERE">SPHERE</a>=<span class="result">SPHERE</span>, <a href="#_neighbor_keyword_DISTANCE">DISTANCE</a>=<span class="result">DISTANCE</span>, <a href="#_neighbor_keyword_RADIANS">RADIANS</a>=<span class="result">RADIANS</span>)</p>
[89]	113
	114	<div class="comments">
[101]	115	</div>
[89]	116
[138]	117	<h3>Return value</h3><div class="preformat">
	118	index giving the P1[index] point that is the closest point of (P0)
[101]	119	</div>
[89]	120
	121
	122	<h3>Parameters</h3>
	123
	124
	125	<h4 id="_neighbor_param_p0lon">p0lon
[101]	126	<span class="attr">in</span>
[89]	127
	128
[101]	129	<span class="attr">required</span>
[89]	130
[242]	131	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	132
	133
	134	</h4>
	135
[138]	136	<div class="comments">
[242]	137	longitudes of point P0.
[138]	138	</div>
[89]	139
	140	<h4 id="_neighbor_param_p0lat">p0lat
[101]	141	<span class="attr">in</span>
[89]	142
	143
[101]	144	<span class="attr">required</span>
[89]	145
[242]	146	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	147
	148
	149	</h4>
	150
[138]	151	<div class="comments">
[242]	152	latitudes of point P0.
[138]	153	</div>
[89]	154
	155	<h4 id="_neighbor_param_neighlon">neighlon
[118]	156	<span class="attr">in</span>
[89]	157
[118]	158	<span class="attr">optional</span>
[89]	159
	160
	161
	162
	163
	164	</h4>
	165
[138]	166	<div class="comments">
	167	</div>
[89]	168
	169	<h4 id="_neighbor_param_neighlat">neighlat
[118]	170	<span class="attr">in</span>
[89]	171
[118]	172	<span class="attr">optional</span>
[89]	173
	174
	175
	176
	177
	178	</h4>
	179
[138]	180	<div class="comments">
[118]	181	</div>
[89]	182
	183
	184
	185
	186
	187
	188	<h3>Keywords</h3>
	189
[242]	190	<h4 id="_neighbor_keyword_SPHERE">SPHERE
[89]	191
	192
	193
	194
	195
	196
	197
	198
	199	</h4>
	200
[242]	201	<div class="comments">
	202	to activate if points are located on a sphere.
[101]	203	</div>
[89]	204
[242]	205	<h4 id="_neighbor_keyword_DISTANCE">DISTANCE
[89]	206
	207
	208
	209
	210
	211
	212
	213
	214	</h4>
	215
[138]	216	<div class="comments">
	217	dis, to get back the distances between P0 and the np1 points P1 in the
	218	variable dis.
	219	</div>
[89]	220
[242]	221	<h4 id="_neighbor_keyword_RADIANS">RADIANS
[89]	222
	223
	224
	225
	226
	227
	228
	229
	230	</h4>
	231
[138]	232	<div class="comments">
	233	if set, inputs and angular outputs are in radians, otherwise degrees.
	234	</div>
[89]	235
	236
	237
[138]	238	<h3>Examples</h3><div class="preformat">
	239	IDL> print, neighbor(-105.15,40.02,[-0.07,100,50],[51.30,20,0], $
	240	IDL> distance=dis)
[101]	241	0
[138]	242	IDL> print, dis
[101]	243	105.684 206.125 160.228
	244	</div>
	245	<h3>Version history</h3>
[89]	246
[234]	247	<h4>Version</h4><div class="preformat">
[338]	248	$Id: neighbor.pro 327 2007-12-13 16:22:35Z pinsard $
[118]	249	</div>
[138]	250	<h4>History</h4><div class="preformat">
[101]	251	Sebastien Masson (smasson@lodyc.jussieu.fr)
[118]	252	October 2003
	253	</div>
[89]	254
	255
	256
	257
	258
	259
	260
	261
	262
	263
	264
	265
	266
	267
	268
	269
[163]	270	<h3>Statistics</h3>
	271	<table class="statistics">
	272	<tr><td>McCabe cyclic</td><td> 7</td></tr>
	273	<tr><td>McCabe essential</td><td> 1</td></tr>
	274	<tr><td>McCabe modular design</td><td> 1</td></tr>
	275	</table>
[89]	276
	277
	278	</div>
	279
	280	</div>
	281
	282
	283
	284	<div id="tagline">Produced by IDLdoc 2.0.</div>
	285
	286	</div>
	287
	288	</body>
[249]	289	</html>

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

Download in other formats: