- Timestamp:
- 06/12/06 10:29:56 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_keep_mean.html
r89 r101 87 87 </div> 88 88 89 <div id="file_comments"></div> 90 91 92 93 94 95 96 97 98 99 <div id="routine_details"> 100 101 102 <div class="routine_details" id="_spl_keep_mean"> 103 104 <h2><a class="top" href="#container">top</a>spl_keep_mean </h2> 105 106 <p class="header"> 107 <span class="result">result = </span>spl_keep_mean(<span class="result"><a href="#_spl_keep_mean_param_x">x</a>, <a href="#_spl_keep_mean_param_yin">yin</a>, <a href="#_spl_keep_mean_param_x2">x2</a></span>, <a href="#_spl_keep_mean_keyword_YP0">YP0</a>=<span class="result">YP0</span>, <a href="#_spl_keep_mean_keyword_YPN_1">YPN_1</a>=<span class="result">YPN_1</span>, <a href="#_spl_keep_mean_keyword_GE0">GE0</a>=<span class="result">GE0</span>)</p> 108 109 <div class="comments"> 110 NAME:spl_keep_mean 111 112 PURPOSE: 89 <div id="file_comments"> 113 90 114 91 Given the arrays X and Y, which tabulate a function (with the X[i] … … 120 97 from monthly mean and keep the monthly mean of the computed daily 121 98 data equa to the original values) 122 123 CATEGORY: 124 125 CALLING SEQUENCE: y2 = spl_keep_mean(x, y, x2) 126 127 INPUTS: 128 129 x: An n-element (at least 2) input vector that specifies the 99 </div> 100 101 102 103 104 105 106 107 108 109 <div id="routine_details"> 110 111 112 <div class="routine_details" id="_spl_keep_mean"> 113 114 <h2><a class="top" href="#container">top</a>spl_keep_mean </h2> 115 116 <p class="header"> 117 <span class="result">result = </span>spl_keep_mean(<span class="result"><a href="#_spl_keep_mean_param_x">x</a>, <a href="#_spl_keep_mean_param_yin">yin</a>, <a href="#_spl_keep_mean_param_x2">x2</a></span>, <a href="#_spl_keep_mean_keyword_YP0">YP0</a>=<span class="result">YP0</span>, <a href="#_spl_keep_mean_keyword_YPN_1">YPN_1</a>=<span class="result">YPN_1</span>, <a href="#_spl_keep_mean_keyword_GE0">GE0</a>=<span class="result">GE0</span>)</p> 118 119 <div class="comments"></div> 120 121 <h3>Return value</h3><div class="value"> 122 123 y2: the meean value between two consecutive values of x2. This 124 array has one element less than y2. y2 has double precision. 125 </div> 126 127 128 <h3>Parameters</h3> 129 130 131 <h4 id="_spl_keep_mean_param_x">x 132 <span class="attr">in</span> 133 134 135 <span class="attr">required</span> 136 137 138 139 140 </h4> 141 142 <div class="comments"> An n-element (at least 2) input vector that specifies the 130 143 tabulate points in a strict ascending order. 131 132 y: an array with one element less than x. y[i] represents the 144 </div> 145 146 <h4 id="_spl_keep_mean_param_yin">yin 147 <span class="attr">in</span> 148 149 150 <span class="attr">required</span> 151 152 153 154 155 </h4> 156 157 <div class="comments"> an array with one element less than x. y[i] represents the 133 158 mean value between x[i] and x[i+1]. if /GE0 is activated, y must 134 159 have positive values. 135 136 x2: The input values for which the interpolated values are 160 </div> 161 162 <h4 id="_spl_keep_mean_param_x2">x2 163 <span class="attr">in</span> 164 165 166 <span class="attr">required</span> 167 168 169 170 171 </h4> 172 173 <div class="comments"> The input values for which the interpolated values are 137 174 desired. Its values must be strictly monotonically increasing. 138 175 139 KEYWORD PARAMETERS: 140 141 /GE0: to force that y2 is always GE than 0. In that case, y must 142 also be GE than 0. 143 144 YP0: The first derivative of the interpolating function at the 176 </div> 177 178 179 180 181 182 183 <h3>Keywords</h3> 184 185 <h4 id="_spl_keep_mean_keyword_YP0">YP0 186 187 188 189 190 191 192 193 194 </h4> 195 196 <div class="comments"> The first derivative of the interpolating function at the 145 197 point X0. If YP0 is omitted, the second derivative at the 146 198 boundary is set to zero, resulting in a "natural spline." 147 148 YPN_1: The first derivative of the interpolating function at the 199 </div> 200 201 <h4 id="_spl_keep_mean_keyword_YPN_1">YPN_1 202 203 204 205 206 207 208 209 210 </h4> 211 212 <div class="comments"> The first derivative of the interpolating function at the 149 213 point Xn-1. If YPN_1 is omitted, the second derivative at the 150 214 boundary is set to zero, resulting in a "natural spline." 151 152 OUTPUTS: 153 154 y2: the meean value between two consecutive values of x2. This 155 array has one element less than y2. y2 has double precision. 156 157 COMMON BLOCKS: none 158 159 SIDE EFFECTS: ? 160 161 RESTRICTIONS: 162 It might be possible that y2 has very small negative values 163 (amplitude smaller than 1.e-6)... 164 165 166 EXAMPLE: 215 </div> 216 217 <h4 id="_spl_keep_mean_keyword_GE0">GE0 218 219 220 221 222 223 224 225 226 </h4> 227 228 <div class="comments"> to force that y2 is always GE than 0. In that case, y must 229 also be GE than 0. 230 </div> 231 232 233 234 <h3>Examples</h3><div class="value"> y2 = spl_keep_mean(x, y, x2) 235 236 167 237 168 238 12 monthly values of precipitations into daily values: … … 185 255 print, total(y*(x[1:n1-1]-x[0:n1-2])) 186 256 print, total(y2*(x2[1:n2-1]-x2[0:n2-2])) 187 188 MODIFICATION HISTORY:</div> 189 190 191 192 193 <h3>Parameters</h3> 194 195 196 <h4 id="_spl_keep_mean_param_x">x 197 198 199 200 201 202 203 204 205 </h4> 206 207 <div class="comments"></div> 208 209 <h4 id="_spl_keep_mean_param_yin">yin 210 211 212 213 214 215 216 217 218 </h4> 219 220 <div class="comments"></div> 221 222 <h4 id="_spl_keep_mean_param_x2">x2 223 224 225 226 227 228 229 230 231 </h4> 232 233 <div class="comments"></div> 234 235 236 237 238 239 240 <h3>Keywords</h3> 241 242 <h4 id="_spl_keep_mean_keyword_YP0">YP0 243 244 245 246 247 248 249 250 251 </h4> 252 253 <div class="comments"></div> 254 255 <h4 id="_spl_keep_mean_keyword_YPN_1">YPN_1 256 257 258 259 260 261 262 263 264 </h4> 265 266 <div class="comments"></div> 267 268 <h4 id="_spl_keep_mean_keyword_GE0">GE0 269 270 271 272 273 274 275 276 277 </h4> 278 279 <div class="comments"></div> 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 257 </div> 258 <h3>Version history</h3> 259 260 261 <h4>History</h4><div class="value"> 262 Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005</div> 263 264 265 <h3>Known issues</h3> 266 267 268 269 <h4>Restrictions</h4><div class="value"> 270 It might be possible that y2 has very small negative values 271 (amplitude smaller than 1.e-6)... 272 273 </div> 295 274 296 275
Note: See TracChangeset
for help on using the changeset viewer.
