Changeset 103 for trunk/SRC/Documentation/idldoc_html_output/Grid
- Timestamp:
- 06/12/06 14:12:53 (18 years ago)
- Location:
- trunk/SRC/Documentation/idldoc_html_output/Grid
- Files:
-
- 12 edited
-
computegrid.html (modified) (5 diffs)
-
directory-overview.html (modified) (1 diff)
-
micromeshmask.html (modified) (6 diffs)
-
n128gaussian.html (modified) (3 diffs)
-
n160gaussian.html (modified) (4 diffs)
-
n256gaussian.html (modified) (4 diffs)
-
n48gaussian.html (modified) (4 diffs)
-
n80gaussian.html (modified) (4 diffs)
-
ncdf_meshread.html (modified) (2 diffs)
-
restoreboxparam.html (modified) (5 diffs)
-
saveboxparam.html (modified) (5 diffs)
-
smallmeshmask.html (modified) (5 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html
r89 r103 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="_computegrid"> 103 104 <h2><a class="top" href="#container">top</a>computegrid </h2> 105 106 <p class="header"> 107 computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 108 109 <div class="comments"> 110 NAME:computegrid 111 112 PURPOSE:compute the grid parameters from cm_4mesh common: 89 <div id="file_comments"> compute the grid parameters from cm_4mesh common: 90 91 computegrid, startx, starty, stepx, stepy, nx, ny 92 computegrid, startx, starty, stepx, stepy 93 computegrid, xaxis = xaxis, yaxis = yaxis 94 or a suitable mix... 113 95 114 96 horizontal parameters: … … 128 110 key_shift, key_periodic, key_zreverse, key_yreverse, 129 111 key_stride, key_onearth, key_partialstep 130 131 CATEGORY:grid 132 133 CALLING SEQUENCE: 134 135 computegrid, startx, starty, stepx, stepy, nx, ny 136 computegrid, startx, starty, stepx, stepy 137 computegrid, xaxis = xaxis, yaxis = yaxis 138 or a suitable mix... 139 140 INPUTS: 141 startx:scalar, x starting point 142 starty:scalar, y starting point 143 stepx:scalar or vector: x direction step, must be > 0 144 if vector nx is not used 145 stepy:scalar or vector: y direction step, 112 </div> 113 114 115 116 117 118 119 120 121 122 <div id="routine_details"> 123 124 125 <div class="routine_details" id="_computegrid"> 126 127 <h2><a class="top" href="#container">top</a>computegrid <span class="categories"> grid 128 </span></h2> 129 130 <p class="header"> 131 computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 132 133 <div class="comments"> 134 </div> 135 136 137 138 139 <h3>Parameters</h3> 140 141 142 <h4 id="_computegrid_param_startx">startx 143 <span class="attr">in</span> 144 145 146 <span class="attr">required</span> 147 148 149 150 151 </h4> 152 153 <div class="comments"> scalar, x starting point</div> 154 155 <h4 id="_computegrid_param_starty">starty 156 <span class="attr">in</span> 157 158 159 <span class="attr">required</span> 160 161 162 163 164 </h4> 165 166 <div class="comments"> scalar, y starting point</div> 167 168 <h4 id="_computegrid_param_stepxin">stepxin 169 <span class="attr">in</span> 170 171 172 <span class="attr">required</span> 173 174 175 176 177 </h4> 178 179 <div class="comments"> scalar or vector: x direction step, must be > 0 180 if vector nx is not used</div> 181 182 <h4 id="_computegrid_param_stepyin">stepyin 183 <span class="attr">in</span> 184 185 186 <span class="attr">required</span> 187 188 189 190 191 </h4> 192 193 <div class="comments"> scalar or vector: y direction step, 146 194 could be > 0 (south to north) or < 0 (north to south) 147 if vector ny is not used 148 nx:scalar, number of points in x direction 149 ny:scalar, number of points in y direction 150 151 KEYWORD PARAMETERS: 152 153 /FULLCGRID: activate to specify that you want to compute 154 all the paremeters of a C grid. Computation of glam[uv], 155 gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 156 will be add to the default computations 157 158 GLAMBOUNDARY: a 2 elements vector, [lon1,lon2], the longitute 195 if vector ny is not used</div> 196 197 <h4 id="_computegrid_param_nxin">nxin 198 <span class="attr">in</span> 199 200 201 <span class="attr">required</span> 202 203 204 205 206 </h4> 207 208 <div class="comments"> scalar, number of points in x direction </div> 209 210 <h4 id="_computegrid_param_nyin">nyin 211 <span class="attr">in</span> 212 213 214 <span class="attr">required</span> 215 216 217 218 219 </h4> 220 221 <div class="comments"> scalar, number of points in y direction 222 </div> 223 224 225 226 227 228 229 <h3>Keywords</h3> 230 231 <h4 id="_computegrid_keyword_XAXIS">XAXIS 232 233 234 235 236 237 238 239 240 </h4> 241 242 <div class="comments"> to specify longitude1 with a 1 or 2 dimension array, in 243 this case startx, stepx and nx are not used but could be 244 necessary if the y axis is not defined with yaxis. It must be 245 possible to sort the first line of xaxis in the increasing 246 order by shifting its elements. 247 </div> 248 249 <h4 id="_computegrid_keyword_YAXIS">YAXIS 250 251 252 253 254 255 256 257 258 </h4> 259 260 <div class="comments"> to specify latitudes with a 1 or 2 dimension array, in 261 this case starty, stepy and ny are not used but starty and 262 stepy could be necessary if the x axis is not defined with xaxis. 263 It must be sorted in the increasing or deceasing order 264 (along each column if 2d array). 265 </div> 266 267 <h4 id="_computegrid_keyword_ZAXIS">ZAXIS 268 269 270 271 272 273 274 275 276 </h4> 277 278 <div class="comments"> to specify the vertical axis with a 1 dimension 279 array. Must be sorted in the increasing or deceasing order 280 </div> 281 282 <h4 id="_computegrid_keyword_MASK">MASK 283 284 285 286 287 288 289 290 291 </h4> 292 293 <div class="comments"> to specify the mask with a 2 or 3 dimension array 294 </div> 295 296 <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY 297 298 299 300 301 302 303 304 305 </h4> 306 307 <div class="comments"> a 2 elements vector, [lon1,lon2], the longitute 159 308 boundaries that should be used to visualize the data. 160 309 we must have lon2 > lon1 and lon2 - lon1 le 360 … … 162 311 glamboundary by using the FIRST LINE of glamt but 163 312 key_shift will /= 0 only if key_periodic = 1 164 165 MASK: to specify the mask with a 2 or 3 dimension array 166 167 ONEARTH = 0 or 1: to force the manual definition of 168 key_onearth (to specify if the data are on earth -> use longitude 169 /latitude etc...). By default, key_onearth = 1. 170 note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0, 171 and is cancelling GLAMBOUNDARY 172 173 PERIODIC = 0 or 1: to force the manual definition of 174 key_periodic. By default, key_periodic is automaticaly 175 computed by using the first line of glamt. 176 177 /PLAIN: force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 178 suppress the automatic redefinition of the domain in case of 179 x periodicity overlap, y periodicity overlap (ORCA type only) 180 and mask border to 0. 181 182 SHIFT = scalar to force the manual definition of key_shift. By 183 debault, key_shift is automaticaly computed according to 184 glamboundary (when defined) by using the FIRST LINE of glamt. if 185 key_periodic=0 then in any case key_shift = 0. 186 187 STRCALLING: a string containing the calling command used to 188 call computegrid (this is used by xxx.pro) 189 190 STRIDE = : a 3 elements vector to specify the stride in x, y, z 191 direction. Default definition is [1, 1, 1]. The resulting value 192 will be stored in the common (cm_4mesh) variable key_stride 193 194 XAXIS: to specify longitude1 with a 1 or 2 dimension array, in 195 this case startx, stepx and nx are not used but could be 196 necessary if the y axis is not defined with yaxis. It must be 197 possible to sort the first line of xaxis in the increasing 198 order by shifting its elements. 199 200 YAXIS: to specify latitudes with a 1 or 2 dimension array, in 201 this case starty, stepy and ny are not used but starty and 202 stepy could be necessary if the x axis is not defined with xaxis. 203 It must be sorted in the increasing or deceasing order 204 (along each column if 2d array). 205 206 /XYINDEX: activate to specify that the horizontal grid should 207 be simply defined by using the index of the points 208 (xaxis = findgen(nx) and yaxis = findgen(ny)) 209 using this keyword forces key_onearth=0 210 211 [XYZ]MINMESH: to define the common variables i[xyz]minmesh 313 </div> 314 315 <h4 id="_computegrid_keyword_XMINMESH">XMINMESH 316 317 318 319 320 321 322 323 324 </h4> 325 326 <div class="comments"> </div> 327 328 <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH 329 330 331 332 333 334 335 336 337 </h4> 338 339 <div class="comments"> </div> 340 341 <h4 id="_computegrid_keyword_YMINMESH">YMINMESH 342 343 344 345 346 347 348 349 350 </h4> 351 352 <div class="comments"> </div> 353 354 <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH 355 356 357 358 359 360 361 362 363 </h4> 364 365 <div class="comments"> </div> 366 367 <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH 368 369 370 371 372 373 374 375 376 </h4> 377 378 <div class="comments"> 379 to define the common variables i[xyz]minmesh 212 380 used to define the grid only in a zoomed part of the original 213 381 grid. Defaut values are 0L, max value is [XYZ]MAXMESH 214 215 [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh 382 </div> 383 384 <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH 385 386 387 388 389 390 391 392 393 </h4> 394 395 <div class="comments"> 396 to define the common variables i[xyz]maxmesh 216 397 used to define the grid only in a zoomed part of the original 217 398 grid. Defaut values are jp[ijk]glo-1, max value is … … 219 400 i[xyz]maxmesh as jp[ijk]glo - 1 + [XYZ]MAXMESH instead of 220 401 [XYZ]MAXMESH 221 222 ZAXIS: to specify the vertical axis with a 1 dimension 223 array. Must be sorted in the increasing or deceasing order 224 225 OUTPUTS: 226 227 COMMON BLOCKS: cm_4mesh cm_4data cm_4cal 228 229 SIDE EFFECTS: if the grid has x/y periodicity orverlap and/or if 402 </div> 403 404 <h4 id="_computegrid_keyword_ONEARTH">ONEARTH 405 406 407 408 409 410 411 412 413 </h4> 414 415 <div class="comments"> = 0 or 1 to force the manual definition of 416 key_onearth (to specify if the data are on earth -> use longitude 417 /latitude etc...). By default, key_onearth = 1. 418 note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0, 419 and is cancelling GLAMBOUNDARY 420 </div> 421 422 <h4 id="_computegrid_keyword_PERIODIC">PERIODIC 423 424 425 426 427 428 429 430 431 </h4> 432 433 <div class="comments"> = 0 or 1 to force the manual definition of 434 key_periodic. By default, key_periodic is automaticaly 435 computed by using the first line of glamt. 436 </div> 437 438 <h4 id="_computegrid_keyword_PLAIN">PLAIN 439 440 441 442 443 444 445 446 447 </h4> 448 449 <div class="comments"> force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 450 suppress the automatic redefinition of the domain in case of 451 x periodicity overlap, y periodicity overlap (ORCA type only) 452 and mask border to 0. 453 </div> 454 455 <h4 id="_computegrid_keyword_SHIFT">SHIFT 456 457 458 459 460 461 462 463 464 </h4> 465 466 <div class="comments"> = scalar to force the manual definition of key_shift. By 467 debault, key_shift is automaticaly computed according to 468 glamboundary (when defined) by using the FIRST LINE of glamt. if 469 key_periodic=0 then in any case key_shift = 0. 470 </div> 471 472 <h4 id="_computegrid_keyword_STRIDE">STRIDE 473 474 475 476 477 478 479 480 481 </h4> 482 483 <div class="comments"> a 3 elements vector to specify the stride in x, y, z 484 direction. Default definition is [1, 1, 1]. The resulting value 485 will be stored in the common (cm_4mesh) variable key_stride 486 </div> 487 488 <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID 489 490 491 492 493 494 495 496 497 </h4> 498 499 <div class="comments"> activate to specify that you want to compute 500 all the paremeters of a C grid. Computation of glam[uv], 501 gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 502 will be add to the default computations 503 </div> 504 505 <h4 id="_computegrid_keyword_XYINDEX">XYINDEX 506 507 508 509 510 511 512 513 514 </h4> 515 516 <div class="comments"> activate to specify that the horizontal grid should 517 be simply defined by using the index of the points 518 (xaxis = findgen(nx) and yaxis = findgen(ny)) 519 using this keyword forces key_onearth=0 520 </div> 521 522 <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE 523 524 525 526 527 528 529 530 531 </h4> 532 533 <div class="comments"></div> 534 535 <h4 id="_computegrid_keyword_STRCALLING">STRCALLING 536 537 538 539 540 541 542 543 544 </h4> 545 546 <div class="comments"> a string containing the calling command used to 547 call computegrid (this is used by xxx.pro) 548 </div> 549 550 <h4 id="_computegrid_keyword__extra">_extra 551 552 553 554 555 556 557 558 559 </h4> 560 561 <div class="comments"></div> 562 563 564 565 566 <h3>Version history</h3> 567 568 569 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 570 2000-04-20 571 Sept 2004, several bug fixs to suit C grid type... 572 Aug 2005, rewritte almost everything...</div> 573 574 575 <h3>Known issues</h3> 576 577 578 579 <h4>Restrictions</h4><div class="value"> if the grid has x/y periodicity orverlap and/or if 230 580 the mask has 0 everywhere at the border (like a close sea) and 231 581 if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, … … 235 585 to use cell_fill = 1). 236 586 237 RESTRICTIONS:FUV points definition... 238 239 EXAMPLE: 240 </div> 241 242 243 244 245 <h3>Parameters</h3> 246 247 248 <h4 id="_computegrid_param_startx">startx 249 250 251 252 253 254 255 256 257 </h4> 258 259 <div class="comments"></div> 260 261 <h4 id="_computegrid_param_starty">starty 262 263 264 265 266 267 268 269 270 </h4> 271 272 <div class="comments"></div> 273 274 <h4 id="_computegrid_param_stepxin">stepxin 275 276 277 278 279 280 281 282 283 </h4> 284 285 <div class="comments"></div> 286 287 <h4 id="_computegrid_param_stepyin">stepyin 288 289 290 291 292 293 294 295 296 </h4> 297 298 <div class="comments"></div> 299 300 <h4 id="_computegrid_param_nxin">nxin 301 302 303 304 305 306 307 308 309 </h4> 310 311 <div class="comments"></div> 312 313 <h4 id="_computegrid_param_nyin">nyin 314 315 316 317 318 319 320 321 322 </h4> 323 324 <div class="comments"></div> 325 326 327 328 329 330 331 <h3>Keywords</h3> 332 333 <h4 id="_computegrid_keyword_XAXIS">XAXIS 334 335 336 337 338 339 340 341 342 </h4> 343 344 <div class="comments"></div> 345 346 <h4 id="_computegrid_keyword_YAXIS">YAXIS 347 348 349 350 351 352 353 354 355 </h4> 356 357 <div class="comments"></div> 358 359 <h4 id="_computegrid_keyword_ZAXIS">ZAXIS 360 361 362 363 364 365 366 367 368 </h4> 369 370 <div class="comments"></div> 371 372 <h4 id="_computegrid_keyword_MASK">MASK 373 374 375 376 377 378 379 380 381 </h4> 382 383 <div class="comments"></div> 384 385 <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY 386 387 388 389 390 391 392 393 394 </h4> 395 396 <div class="comments"></div> 397 398 <h4 id="_computegrid_keyword_XMINMESH">XMINMESH 399 400 401 402 403 404 405 406 407 </h4> 408 409 <div class="comments"></div> 410 411 <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH 412 413 414 415 416 417 418 419 420 </h4> 421 422 <div class="comments"></div> 423 424 <h4 id="_computegrid_keyword_YMINMESH">YMINMESH 425 426 427 428 429 430 431 432 433 </h4> 434 435 <div class="comments"></div> 436 437 <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH 438 439 440 441 442 443 444 445 446 </h4> 447 448 <div class="comments"></div> 449 450 <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH 451 452 453 454 455 456 457 458 459 </h4> 460 461 <div class="comments"></div> 462 463 <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH 464 465 466 467 468 469 470 471 472 </h4> 473 474 <div class="comments"></div> 475 476 <h4 id="_computegrid_keyword_ONEARTH">ONEARTH 477 478 479 480 481 482 483 484 485 </h4> 486 487 <div class="comments"></div> 488 489 <h4 id="_computegrid_keyword_PERIODIC">PERIODIC 490 491 492 493 494 495 496 497 498 </h4> 499 500 <div class="comments"></div> 501 502 <h4 id="_computegrid_keyword_PLAIN">PLAIN 503 504 505 506 507 508 509 510 511 </h4> 512 513 <div class="comments"></div> 514 515 <h4 id="_computegrid_keyword_SHIFT">SHIFT 516 517 518 519 520 521 522 523 524 </h4> 525 526 <div class="comments"></div> 527 528 <h4 id="_computegrid_keyword_STRIDE">STRIDE 529 530 531 532 533 534 535 536 537 </h4> 538 539 <div class="comments"></div> 540 541 <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID 542 543 544 545 546 547 548 549 550 </h4> 551 552 <div class="comments"></div> 553 554 <h4 id="_computegrid_keyword_XYINDEX">XYINDEX 555 556 557 558 559 560 561 562 563 </h4> 564 565 <div class="comments"></div> 566 567 <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE 568 569 570 571 572 573 574 575 576 </h4> 577 578 <div class="comments"></div> 579 580 <h4 id="_computegrid_keyword_STRCALLING">STRCALLING 581 582 583 584 585 586 587 588 589 </h4> 590 591 <div class="comments"></div> 592 593 <h4 id="_computegrid_keyword__extra">_extra 594 595 596 597 598 599 600 601 602 </h4> 603 604 <div class="comments"></div> 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 587 FUV points definition... 588 </div> 589 590 <h3>Other attributes</h3> 591 592 593 <h4>Uses routines</h4><div class="value"> cm_4mesh cm_4data cm_4cal 594 </div> 625 595 626 596 -
trunk/SRC/Documentation/idldoc_html_output/Grid/directory-overview.html
r89 r103 90 90 91 91 <dt><a href="computegrid.html?format=raw">computegrid.pro</a></dt> 92 <dd> </dd>92 <dd> compute the grid parameters from cm_4mesh common: computegrid, startx, starty, stepx, stepy, nx, ny computegrid, startx, starty, stepx, stepy computegrid, xaxis = xaxis, yaxis = yaxis or a suitable mix.</dd> 93 93 94 94 <dt><a href="micromeshmask.html?format=raw">micromeshmask.pro</a></dt> 95 <dd> </dd>95 <dd> reduce the size of the NetCDF meshmask created by OPA by using bit (and not byte) format for the masks and the foat format for the other fields.</dd> 96 96 97 97 <dt><a href="n128gaussian.html?format=raw">n128gaussian.pro</a></dt> 98 <dd> </dd>98 <dd> compute the latitudes of the n128 gaussian grid.</dd> 99 99 100 100 <dt><a href="n160gaussian.html?format=raw">n160gaussian.pro</a></dt> 101 <dd> </dd>101 <dd> compute the latitudes of the n160 gaussian grid.</dd> 102 102 103 103 <dt><a href="n256gaussian.html?format=raw">n256gaussian.pro</a></dt> 104 <dd> </dd>104 <dd> compute the latitudes of the n256 gaussian grid.</dd> 105 105 106 106 <dt><a href="n48gaussian.html?format=raw">n48gaussian.pro</a></dt> 107 <dd> </dd>107 <dd> compute the latitudes of the n48 gaussian grid.</dd> 108 108 109 109 <dt><a href="n80gaussian.html?format=raw">n80gaussian.pro</a></dt> 110 <dd> </dd>110 <dd> compute the latitudes of the n80 gaussian grid.</dd> 111 111 112 112 <dt><a href="ncdf_meshread.html?format=raw">ncdf_meshread.pro</a></dt> 113 <dd> </dd>113 <dd> read NetCDF meshmask file created by OPA </dd> 114 114 115 115 <dt><a href="restoreboxparam.html?format=raw">restoreboxparam.pro</a></dt> 116 <dd> </dd>116 <dd> restore all the zoom parameters (defined by calling domdef) perviously defined by saveboxparam </dd> 117 117 118 118 <dt><a href="saveboxparam.html?format=raw">saveboxparam.pro</a></dt> 119 <dd> </dd>119 <dd> save all the zoom parameters (defined by calling domdef) in a file (using save command) located in myuniquetmpdir (common variable defined by def_myuniquetmpdir) </dd> 120 120 121 121 <dt><a href="smallmeshmask.html?format=raw">smallmeshmask.pro</a></dt> 122 <dd> </dd>122 <dd> reduce the size of the NetCDF meshmask created by OPA by using byte format for the masks and the foat format for the other fields.</dd> 123 123 124 124 </dl> -
trunk/SRC/Documentation/idldoc_html_output/Grid/micromeshmask.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> reduce the size of the NetCDF meshmask created by OPA by 90 using bit (and not byte) format for the masks and the foat format 91 for the other fields. 92 </div> 90 93 91 94 … … 102 105 103 106 <dt><p><a href="#_ncdf_transfer">ncdf_transfer<span class="result">, inid, outid, inname, outname</span></a></p><dt> 104 <dd> NAME: micromeshmask.</dd>107 <dd> </dd> 105 108 106 109 <dt><p><a href="#_micromeshmask">micromeshmask<span class="result">, ncfilein, ncfileout</span>, IODIR=<span class="result">IODIR</span></a></p><dt> … … 116 119 <div class="routine_details" id="_ncdf_transfer"> 117 120 118 <h2><a class="top" href="#container">top</a>ncdf_transfer </h2> 121 <h2><a class="top" href="#container">top</a>ncdf_transfer <span class="categories"> for OPA meshmask files 122 </span></h2> 119 123 120 124 <p class="header"> … … 122 126 123 127 <div class="comments"> 124 NAME: micromeshmask.pro 125 126 PURPOSE: reduce the size of the NetCDF meshmask created by OPA by 127 using bit (and not byte) format for the masks and the foat format 128 for the other fields. 129 130 CATEGORY:for OPA meshmask files 131 132 CALLING SEQUENCE: reducencmeshmask, ncfilein[, ncfileout] 133 134 INPUTS: 135 ncfilein: 128 </div> 129 130 131 132 133 <h3>Parameters</h3> 134 135 136 <h4 id="_ncdf_transfer_param_inid">inid 137 138 139 140 141 142 143 144 145 </h4> 146 147 <div class="comments"></div> 148 149 <h4 id="_ncdf_transfer_param_outid">outid 150 151 152 153 154 155 156 157 158 </h4> 159 160 <div class="comments"></div> 161 162 <h4 id="_ncdf_transfer_param_inname">inname 163 164 165 166 167 168 169 170 171 </h4> 172 173 <div class="comments"></div> 174 175 <h4 id="_ncdf_transfer_param_outname">outname 176 177 178 179 180 181 182 183 184 </h4> 185 186 <div class="comments"></div> 187 188 189 190 191 192 193 <h3>Examples</h3><div class="value"> 194 IDL> reducencmeshmask, ncfilein[, ncfileout] 195 196 197 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 198 IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 199 </div> 200 <h3>Version history</h3> 201 202 203 <h4>History</h4><div class="value"> 204 July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)</div> 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 </div> 224 225 226 <div class="routine_details" id="_micromeshmask"> 227 228 <h2><a class="top" href="#container">top</a>micromeshmask </h2> 229 230 <p class="header"> 231 micromeshmask<span class="result">, <a href="#_micromeshmask_param_ncfilein">ncfilein</a>, <a href="#_micromeshmask_param_ncfileout">ncfileout</a></span>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 232 233 <div class="comments"></div> 234 235 236 237 238 <h3>Parameters</h3> 239 240 241 <h4 id="_micromeshmask_param_ncfilein">ncfilein 242 <span class="attr">in</span> 243 244 245 <span class="attr">required</span> 246 247 248 249 250 </h4> 251 252 <div class="comments"> 136 253 1) the name of the meshmask file to be reduced. In that case, 137 254 there is only one meshmask file … … 141 258 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 142 259 xxx.mask.nc. In that case, the meshmask is split into 3 files. 143 144 ncfileout: the name of the uniq reduced meshmask file. default 260 </div> 261 262 <h4 id="_micromeshmask_param_ncfileout">ncfileout 263 <span class="attr">in</span> 264 265 266 <span class="attr">required</span> 267 268 269 270 271 </h4> 272 273 <div class="comments"> the name of the uniq reduced meshmask file. default 145 274 definition is micromeshmask.nc 146 147 KEYWORD PARAMETERSSAT: 148 149 IODIR:to define the files path. 150 151 OUTPUTS: no 152 153 COMMON BLOCKS: no 154 155 EXAMPLE: 156 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 157 IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 158 159 MODIFICATION HISTORY:</div> 160 161 162 163 164 <h3>Parameters</h3> 165 166 167 <h4 id="_ncdf_transfer_param_inid">inid 168 169 170 171 172 173 174 175 176 </h4> 177 178 <div class="comments"></div> 179 180 <h4 id="_ncdf_transfer_param_outid">outid 181 182 183 184 185 186 187 188 189 </h4> 190 191 <div class="comments"></div> 192 193 <h4 id="_ncdf_transfer_param_inname">inname 194 195 196 197 198 199 200 201 202 </h4> 203 204 <div class="comments"></div> 205 206 <h4 id="_ncdf_transfer_param_outname">outname 207 208 209 210 211 212 213 214 215 </h4> 216 217 <div class="comments"></div> 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 </div> 248 249 250 <div class="routine_details" id="_micromeshmask"> 251 252 <h2><a class="top" href="#container">top</a>micromeshmask </h2> 253 254 <p class="header"> 255 micromeshmask<span class="result">, <a href="#_micromeshmask_param_ncfilein">ncfilein</a>, <a href="#_micromeshmask_param_ncfileout">ncfileout</a></span>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 256 257 <div class="comments"></div> 258 259 260 261 262 <h3>Parameters</h3> 263 264 265 <h4 id="_micromeshmask_param_ncfilein">ncfilein 266 267 268 269 270 271 272 273 274 </h4> 275 276 <div class="comments"></div> 277 278 <h4 id="_micromeshmask_param_ncfileout">ncfileout 279 280 281 282 283 284 285 286 287 </h4> 288 289 <div class="comments"></div> 275 </div> 290 276 291 277 … … 307 293 </h4> 308 294 309 <div class="comments"> </div>295 <div class="comments"> to define the files path.</div> 310 296 311 297 -
trunk/SRC/Documentation/idldoc_html_output/Grid/n128gaussian.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> compute the latitudes of the n128 gaussian grid. See: 90 http://www.ecmwf.int/products/data/technical/gaussian/n128FIS.html 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_n128gaussian"> 103 105 104 <h2><a class="top" href="#container">top</a>n128gaussian </h2> 106 <h2><a class="top" href="#container">top</a>n128gaussian <span class="categories"> grid 107 </span></h2> 105 108 106 109 <p class="header"> 107 110 <span class="result">result = </span>n128gaussian()</p> 108 111 109 <div class="comments"> 110 NAME:n128gaussian 112 <div class="comments"></div> 111 113 112 PURPOSE:compute the latitudes of the n128 gaussian grid. See: 113 http://www.ecmwf.int/products/data/technical/gaussian/n128FIS.html 114 115 CATEGORY:grid 116 117 CALLING SEQUENCE:lat=n128gaussian() 118 119 INPUTS:None 120 121 KEYWORD PARAMETERS:None 122 123 OUTPUTS:a 1d array 124 125 COMMON BLOCKS:None 126 127 SIDE EFFECTS:None 128 129 RESTRICTIONS:None 130 131 EXAMPLE: 132 133 MODIFICATION HISTORY:</div> 114 <h3>Return value</h3><div class="value"> a 1d array 115 </div> 134 116 135 117 … … 137 119 138 120 139 140 121 <h3>Examples</h3><div class="value"> 122 IDL> lat=n128gaussian() 123 </div> 124 <h3>Version history</h3> 141 125 142 126 143 144 145 127 <h4>History</h4><div class="value"> 128 Sebastien Masson (smasson@lodyc.jussieu.fr) 129 June 2004</div> 146 130 147 131 -
trunk/SRC/Documentation/idldoc_html_output/Grid/n160gaussian.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> compute the latitudes of the n160 gaussian grid. See: 90 http://www.ecmwf.int/products/data/technical/gaussian/n160FIS.html 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_n160gaussian"> 103 105 104 <h2><a class="top" href="#container">top</a>n160gaussian </h2> 106 <h2><a class="top" href="#container">top</a>n160gaussian <span class="categories"> grid 107 </span></h2> 105 108 106 109 <p class="header"> … … 108 111 109 112 <div class="comments"> 110 NAME:n160gaussian 113 </div> 111 114 112 PURPOSE:compute the latitudes of the n160 gaussian grid. See: 113 http://www.ecmwf.int/products/data/technical/gaussian/n160FIS.html 114 115 CATEGORY:grid 116 117 CALLING SEQUENCE:lat=n160gaussian() 118 119 INPUTS:None 120 121 KEYWORD PARAMETERS:None 122 123 OUTPUTS:a 1d array 124 125 COMMON BLOCKS:None 126 127 SIDE EFFECTS:None 128 129 RESTRICTIONS:None 130 131 EXAMPLE: 132 133 MODIFICATION HISTORY:</div> 115 <h3>Return value</h3><div class="value"> a 1d array 116 </div> 134 117 135 118 … … 137 120 138 121 139 140 122 <h3>Examples</h3><div class="value"> 123 IDL>lat=n160gaussian() 124 </div> 125 <h3>Version history</h3> 141 126 142 127 143 144 145 128 <h4>History</h4><div class="value"> 129 Sebastien Masson (smasson@lodyc.jussieu.fr) 130 June 2004</div> 146 131 147 132 -
trunk/SRC/Documentation/idldoc_html_output/Grid/n256gaussian.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> compute the latitudes of the n256 gaussian grid. See: 90 http://www.ecmwf.int/products/data/technical/gaussian/n256FIS.html 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_n256gaussian"> 103 105 104 <h2><a class="top" href="#container">top</a>n256gaussian </h2> 106 <h2><a class="top" href="#container">top</a>n256gaussian <span class="categories"> grid 107 </span></h2> 105 108 106 109 <p class="header"> … … 108 111 109 112 <div class="comments"> 110 NAME:n256gaussian 113 </div> 111 114 112 PURPOSE:compute the latitudes of the n256 gaussian grid. See: 113 http://www.ecmwf.int/products/data/technical/gaussian/n256FIS.html 114 115 CATEGORY:grid 116 117 CALLING SEQUENCE:lat=n256gaussian() 118 119 INPUTS:None 120 121 KEYWORD PARAMETERS:None 122 123 OUTPUTS:a 1d array 124 125 COMMON BLOCKS:None 126 127 SIDE EFFECTS:None 128 129 RESTRICTIONS:None 130 131 EXAMPLE: 132 133 MODIFICATION HISTORY:</div> 115 <h3>Return value</h3><div class="value"> a 1d array 116 </div> 134 117 135 118 … … 137 120 138 121 139 140 122 <h3>Examples</h3><div class="value"> 123 IDL> lat=n256gaussian() 124 </div> 125 <h3>Version history</h3> 141 126 142 127 143 144 145 128 <h4>History</h4><div class="value"> 129 Sebastien Masson (smasson@lodyc.jussieu.fr) 130 June 2004</div> 146 131 147 132 -
trunk/SRC/Documentation/idldoc_html_output/Grid/n48gaussian.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> compute the latitudes of the n48 gaussian grid. See: 90 http://www.ecmwf.int/products/data/technical/gaussian/n48FIS.html 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_n48gaussian"> 103 105 104 <h2><a class="top" href="#container">top</a>n48gaussian </h2> 106 <h2><a class="top" href="#container">top</a>n48gaussian <span class="categories"> grid 107 </span></h2> 105 108 106 109 <p class="header"> … … 108 111 109 112 <div class="comments"> 110 NAME:n48gaussian 113 </div> 111 114 112 PURPOSE:compute the latitudes of the n48 gaussian grid. See: 113 http://www.ecmwf.int/products/data/technical/gaussian/n48FIS.html 114 115 CATEGORY:grid 116 117 CALLING SEQUENCE:lat=n48gaussian() 118 119 INPUTS:None 120 121 KEYWORD PARAMETERS:None 122 123 OUTPUTS:a 1d array 124 125 COMMON BLOCKS:None 126 127 SIDE EFFECTS:None 128 129 RESTRICTIONS:None 130 131 EXAMPLE: 132 133 MODIFICATION HISTORY:</div> 115 <h3>Return value</h3><div class="value"> a 1d array 116 </div> 134 117 135 118 … … 137 120 138 121 139 140 122 <h3>Examples</h3><div class="value"> 123 IDL> lat=n48gaussian() 124 </div> 125 <h3>Version history</h3> 141 126 142 127 143 144 145 128 <h4>History</h4><div class="value"> 129 Sebastien Masson (smasson@lodyc.jussieu.fr) 130 June 2004</div> 146 131 147 132 -
trunk/SRC/Documentation/idldoc_html_output/Grid/n80gaussian.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> compute the latitudes of the n80 gaussian grid. See: 90 http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_n80gaussian"> 103 105 104 <h2><a class="top" href="#container">top</a>n80gaussian </h2> 106 <h2><a class="top" href="#container">top</a>n80gaussian <span class="categories"> grid 107 </span></h2> 105 108 106 109 <p class="header"> … … 108 111 109 112 <div class="comments"> 110 NAME:n80gaussian 113 </div> 111 114 112 PURPOSE:compute the latitudes of the n80 gaussian grid. See: 113 http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html 114 115 CATEGORY:grid 116 117 CALLING SEQUENCE:lat=n80gaussian() 118 119 INPUTS:None 120 121 KEYWORD PARAMETERS:None 122 123 OUTPUTS:a 1d array 124 125 COMMON BLOCKS:None 126 127 SIDE EFFECTS:None 128 129 RESTRICTIONS:None 130 131 EXAMPLE: 132 133 MODIFICATION HISTORY:</div> 115 <h3>Return value</h3><div class="value"> a 1d array 116 </div> 134 117 135 118 … … 137 120 138 121 139 140 122 <h3>Examples</h3><div class="value"> 123 IDL> lat=n80gaussian() 124 </div> 125 <h3>Version history</h3> 141 126 142 127 143 144 145 128 <h4>History</h4><div class="value"> 129 Sebastien Masson (smasson@lodyc.jussieu.fr) 130 June 2004</div> 146 131 147 132 -
trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> read NetCDF meshmask file created by OPA 90 </div> 90 91 91 92 … … 102 103 <div class="routine_details" id="_ncdf_meshread"> 103 104 104 <h2><a class="top" href="#container">top</a>ncdf_meshread </h2> 105 <h2><a class="top" href="#container">top</a>ncdf_meshread <span class="categories"> grid reading 106 </span></h2> 105 107 106 108 <p class="header"> 107 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">GLAMBOUNDARY</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">ONEARTH</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">GETDIMENSIONS</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>109 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">GLAMBOUNDARY</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">ONEARTH</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">GETDIMENSIONS</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 108 110 109 111 <div class="comments"> 110 NAME:ncdf_meshread 111 112 PURPOSE:read NetCDF meshmask file created by OPA 113 114 CATEGORY:grid reading 115 116 CALLING SEQUENCE:ncdf_meshread [,' filename'] 117 118 INPUTS: 119 120 filename: the name of the meshmask file to read. Default is 112 </div> 113 114 115 116 117 <h3>Parameters</h3> 118 119 120 <h4 id="_ncdf_meshread_param_filename">filename 121 <span class="attr">in</span> 122 123 <span class="attr">optional</span> 124 125 126 127 128 129 </h4> 130 131 <div class="comments"> the name of the meshmask file to read. Default is 121 132 meshmask.nc. if this name does not contain any / and if 122 133 iodirectory keyword is not specify, then the common variable 123 134 iodir will be use to define the mesh file path. 124 125 KEYWORD PARAMETERS: 126 127 GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute 135 </div> 136 137 138 139 140 141 142 <h3>Keywords</h3> 143 144 <h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY 145 146 147 148 149 150 151 152 153 </h4> 154 155 <div class="comments"> a 2 elements vector, {lon1,lon2], the longitute 128 156 boundaries that should be used to visualize the data. 129 157 lon2 > lon1 130 158 lon2 - lon1 le 360 131 159 key_shift will be automaticaly defined according to GLAMBOUNDARY. 132 133 /CHECKDAT: Suppressed. Use micromeshmask.pro to create an 160 </div> 161 162 <h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT 163 164 165 166 167 168 169 170 171 </h4> 172 173 <div class="comments"> Suppressed. Use micromeshmask.pro to create an 134 174 appropriate meshmask. 135 136 ONEARTH = 0 or 1: to force the manual definition of 175 </div> 176 177 <h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH 178 179 180 181 182 183 184 185 186 </h4> 187 188 <div class="comments"> = 0 or 1 to force the manual definition of 137 189 key_onearth (to specify if the data are on earth -> use longitude 138 190 /latitude etc...). By default, key_onearth = 1. 139 191 note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is 140 192 cancelling GLAMBOUNDARY 141 142 PERIODIC = 0 or 1: to force the manual definition of 193 </div> 194 195 <h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS 196 197 198 199 200 201 202 203 204 </h4> 205 206 <div class="comments"></div> 207 208 <h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC 209 210 211 212 213 214 215 216 217 </h4> 218 219 <div class="comments"> = 0 or 1 to force the manual definition of 143 220 key_periodic. By default, key_periodic is automaticaly 144 221 computed by using the first line of glamt. 145 146 SHIFT = : to force the manual definition of key_shift. By 222 </div> 223 224 <h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT 225 226 227 228 229 230 231 232 233 </h4> 234 235 <div class="comments"> to force the manual definition of key_shift. By 147 236 debault, key_shift is automaticaly computed according to the 148 237 glamboundary (when defined) by using the first line of glamt. if 149 238 key_periodic=0 then in any case key_shift = 0. 150 151 STRCALLING: a string containing the calling command used to call 152 computegrid (this is used by xxx.pro) 153 154 STRIDE = : a 3 elements vector to specify the stride in x, y, z 239 </div> 240 241 <h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE 242 243 244 245 246 247 248 249 250 </h4> 251 252 <div class="comments"> a 3 elements vector to specify the stride in x, y, z 155 253 direction. Default definition is key_stride. The resulting value 156 254 will be stored in the common (cm_4mesh) variable key_stride 157 158 159 OUTPUTS:none 160 161 COMMON BLOCKS: cm_4mesh, cm_4data, cm_4cal 162 163 SIDE EFFECTS: define and/or use common variables from 255 </div> 256 257 <h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING 258 259 260 261 262 263 264 265 266 </h4> 267 268 <div class="comments"> a string containing the calling command used to call 269 computegrid (this is used by xxx.pro) 270 </div> 271 272 <h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA 273 274 275 276 277 278 279 280 281 </h4> 282 283 <div class="comments"></div> 284 285 286 287 <h3>Examples</h3><div class="value"> 288 IDL> ncdf_meshread [,' filename'] 289 </div> 290 <h3>Version history</h3> 291 292 293 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 294 12/1999 295 July 2004, Sebastien Masson: Several modifications (micromeshmask, 296 clean partial steps, clean use of key_stride, automatic definition 297 of key_shift, ...) 298 Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT 299 Aug. 2005, Sebastien Masson: some cleaning + english </div> 300 301 302 <h3>Known issues</h3> 303 304 305 306 <h4>Restrictions</h4><div class="value"> define and/or use common variables from 164 307 cm_4mesh, cm_4data, cm_4cal 165 308 166 RESTRICTIONS: 309 167 310 168 311 ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 169 312 be defined febore calling ncdf_meshread. if some of those value 170 313 are equal to -1 they will be automatically defined 171 172 EXAMPLE: 173 </div> 174 175 176 177 178 <h3>Parameters</h3> 179 180 181 <h4 id="_ncdf_meshread_param_filename">filename 182 183 184 185 186 187 188 189 190 </h4> 191 192 <div class="comments"></div> 193 194 195 196 197 198 199 <h3>Keywords</h3> 200 201 <h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY 202 203 204 205 206 207 208 209 210 </h4> 211 212 <div class="comments"></div> 213 214 <h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT 215 216 217 218 219 220 221 222 223 </h4> 224 225 <div class="comments"></div> 226 227 <h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH 228 229 230 231 232 233 234 235 236 </h4> 237 238 <div class="comments"></div> 239 240 <h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS 241 242 243 244 245 246 247 248 249 </h4> 250 251 <div class="comments"></div> 252 253 <h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC 254 255 256 257 258 259 260 261 262 </h4> 263 264 <div class="comments"></div> 265 266 <h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT 267 268 269 270 271 272 273 274 275 </h4> 276 277 <div class="comments"></div> 278 279 <h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE 280 281 282 283 284 285 286 287 288 </h4> 289 290 <div class="comments"></div> 291 292 <h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING 293 294 295 296 297 298 299 300 301 </h4> 302 303 <div class="comments"></div> 304 305 <h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA 306 307 308 309 310 311 312 313 314 </h4> 315 316 <div class="comments"></div> 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 314 </div> 315 316 <h3>Other attributes</h3> 317 318 319 <h4>Uses routines</h4><div class="value"> cm_4mesh cm_4data cm_4cal 320 </div> 337 321 338 322 -
trunk/SRC/Documentation/idldoc_html_output/Grid/restoreboxparam.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> restore all the zoom parameters (defined by calling domdef) 90 perviously defined by saveboxparam 91 </div> 90 92 91 93 … … 108 110 109 111 <div class="comments"> 110 NAME: restoreboxparam111 112 PURPOSE: restore all the zoom parameters (defined by calling domdef)113 perviously defined by saveboxparam114 115 CATEGORY:116 117 CALLING SEQUENCE: restoreboxparam, filename118 119 INPUTS: filename a scalar string defining the file name120 121 KEYWORD PARAMETERS: none122 123 OUTPUTS:none124 112 </div> 125 113 … … 131 119 132 120 <h4 id="_restoreboxparam_param_filename">filename 121 <span class="attr">in</span> 133 122 134 123 135 136 124 <span class="attr">required</span> 137 125 138 126 … … 141 129 </h4> 142 130 143 <div class="comments"></div> 131 <div class="comments"> a scalar string defining the file name 132 </div> 144 133 145 134 … … 148 137 149 138 139 <h3>Examples</h3><div class="value"> 140 IDL> restoreboxparam, filename 141 </div> 142 <h3>Version history</h3> 143 144 145 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 146 July 2005</div> 147 148 149 <h3>Known issues</h3> 150 150 151 151 152 152 153 <h4>Restrictions</h4><div class="value"> all def_myuniquetmpdir, if myuniquetmpdir is undefined: 154 => define, create and add it to !path 155 </div> 156 157 <h3>Other attributes</h3> 153 158 154 159 155 156 157 158 159 160 161 162 163 164 165 166 160 <h4>Uses routines</h4><div class="value"> cm_4mesh and cm_demomode_used if we are in demo mode 161 </div> 167 162 168 163 -
trunk/SRC/Documentation/idldoc_html_output/Grid/saveboxparam.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> save all the zoom parameters (defined by calling domdef) 90 in a file (using save command) located in myuniquetmpdir 91 (common variable defined by def_myuniquetmpdir) 92 </div> 90 93 91 94 … … 108 111 109 112 <div class="comments"> 110 NAME: saveboxparam111 112 PURPOSE: save all the zoom parameters (defined by calling domdef)113 in a file (using save command) located in myuniquetmpdir114 (common variable defined by def_myuniquetmpdir)115 116 CATEGORY:117 118 CALLING SEQUENCE: saveboxparam, filename119 120 INPUTS: filename a scalar string defining the file name121 122 KEYWORD PARAMETERS: none123 124 OUTPUTS:none125 113 </div> 126 114 … … 132 120 133 121 <h4 id="_saveboxparam_param_filename">filename 122 <span class="attr">in</span> 134 123 135 124 136 137 125 <span class="attr">required</span> 138 126 139 127 … … 142 130 </h4> 143 131 144 <div class="comments"></div> 132 <div class="comments"> a scalar string defining the file name 133 </div> 145 134 146 135 … … 149 138 150 139 140 <h3>Examples</h3><div class="value"> 141 IDL> saveboxparam, filename 142 </div> 143 <h3>Version history</h3> 144 145 146 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 147 June 2005</div> 148 149 150 <h3>Known issues</h3> 151 151 152 152 153 153 154 <h4>Restrictions</h4><div class="value"> call def_myuniquetmpdir, if myuniquetmpdir is undefined: 155 => define, create and add it to !path 156 </div> 157 158 <h3>Other attributes</h3> 154 159 155 160 156 157 158 159 160 161 162 163 164 165 166 167 161 <h4>Uses routines</h4><div class="value"> cm_4mesh and cm_demomode_used if we are in demo mode 162 </div> 168 163 169 164 -
trunk/SRC/Documentation/idldoc_html_output/Grid/smallmeshmask.html
r89 r103 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> reduce the size of the NetCDF meshmask created by OPA by 90 using byte format for the masks and the foat format for the other 91 fields. 92 </div> 90 93 91 94 … … 102 105 103 106 <dt><p><a href="#_ncdf_transfer">ncdf_transfer<span class="result">, inid, outid, inname, outname</span></a></p><dt> 104 <dd> NAME: smallmeshmask.</dd>105 106 <dt><p><a href="#_smallmeshmask">smallmeshmask<span class="result">, ncfilein , ncfileout</span>, IODIR=<span class="result">IODIR</span></a></p><dt>107 <dd> </dd> 108 109 <dt><p><a href="#_smallmeshmask">smallmeshmask<span class="result">, ncfilein[, ncfileout]</span>, IODIR=<span class="result">IODIR</span></a></p><dt> 107 110 <dd></dd> 108 111 … … 116 119 <div class="routine_details" id="_ncdf_transfer"> 117 120 118 <h2><a class="top" href="#container">top</a>ncdf_transfer </h2> 121 <h2><a class="top" href="#container">top</a>ncdf_transfer <span class="categories"> for OPA meshmask files 122 </span></h2> 119 123 120 124 <p class="header"> … … 122 126 123 127 <div class="comments"> 124 NAME: smallmeshmask.pro 125 126 PURPOSE: reduce the size of the NetCDF meshmask created by OPA by 127 using byte format for the masks and the foat format for the other 128 fields. 129 130 CATEGORY:for OPA meshmask files 131 132 CALLING SEQUENCE: smallmeshmask, ncfilein[, ncfileout] 133 134 INPUTS: 135 ncfilein: 128 129 </div> 130 131 132 133 134 <h3>Parameters</h3> 135 136 137 <h4 id="_ncdf_transfer_param_inid">inid 138 139 140 141 142 143 144 145 146 </h4> 147 148 <div class="comments"></div> 149 150 <h4 id="_ncdf_transfer_param_outid">outid 151 152 153 154 155 156 157 158 159 </h4> 160 161 <div class="comments"></div> 162 163 <h4 id="_ncdf_transfer_param_inname">inname 164 165 166 167 168 169 170 171 172 </h4> 173 174 <div class="comments"></div> 175 176 <h4 id="_ncdf_transfer_param_outname">outname 177 178 179 180 181 182 183 184 185 </h4> 186 187 <div class="comments"></div> 188 189 190 191 192 193 194 195 <h3>Version history</h3> 196 197 198 <h4>History</h4><div class="value"> 199 July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)</div> 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 </div> 219 220 221 <div class="routine_details" id="_smallmeshmask"> 222 223 <h2><a class="top" href="#container">top</a>smallmeshmask <span class="categories"> for OPA meshmask files 224 </span></h2> 225 226 <p class="header"> 227 smallmeshmask<span class="result">, <a href="#_smallmeshmask_param_ncfilein">ncfilein</a>[, <a href="#_smallmeshmask_param_ncfileout">ncfileout</a>]</span>, <a href="#_smallmeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 228 229 <div class="comments"></div> 230 231 232 233 234 <h3>Parameters</h3> 235 236 237 <h4 id="_smallmeshmask_param_ncfilein">ncfilein 238 <span class="attr">in</span> 239 240 241 <span class="attr">required</span> 242 243 244 245 246 </h4> 247 248 <div class="comments"> 136 249 1) the name of the meshmask file to be reduced. In that case, 137 250 there is only one meshmask file … … 141 254 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 142 255 xxx.mask.nc. In that case, the meshmask is split into 3 files. 143 144 ncfileout: the name of the reduced meshmask file. default 256 </div> 257 258 <h4 id="_smallmeshmask_param_ncfileout">ncfileout 259 <span class="attr">in</span> 260 261 <span class="attr">optional</span> 262 263 264 265 266 267 </h4> 268 269 <div class="comments"> the name of the reduced meshmask file. default 145 270 definition is smallmeshmask.nc 146 147 KEYWORD PARAMETERS: 148 149 IODIR:to define the files path. 150 151 OUTPUTS: no 152 153 COMMON BLOCKS: no 154 155 EXAMPLE: 271 </div> 272 273 274 275 276 277 278 <h3>Keywords</h3> 279 280 <h4 id="_smallmeshmask_keyword_IODIR">IODIR 281 282 283 284 285 286 287 288 289 </h4> 290 291 <div class="comments"> to define the files path.</div> 292 293 294 295 <h3>Examples</h3><div class="value"> 156 296 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 157 297 IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 158 159 MODIFICATION HISTORY:</div> 160 161 162 163 164 <h3>Parameters</h3> 165 166 167 <h4 id="_ncdf_transfer_param_inid">inid 168 169 170 171 172 173 174 175 176 </h4> 177 178 <div class="comments"></div> 179 180 <h4 id="_ncdf_transfer_param_outid">outid 181 182 183 184 185 186 187 188 189 </h4> 190 191 <div class="comments"></div> 192 193 <h4 id="_ncdf_transfer_param_inname">inname 194 195 196 197 198 199 200 201 202 </h4> 203 204 <div class="comments"></div> 205 206 <h4 id="_ncdf_transfer_param_outname">outname 207 208 209 210 211 212 213 214 215 </h4> 216 217 <div class="comments"></div> 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 </div> 248 249 250 <div class="routine_details" id="_smallmeshmask"> 251 252 <h2><a class="top" href="#container">top</a>smallmeshmask </h2> 253 254 <p class="header"> 255 smallmeshmask<span class="result">, <a href="#_smallmeshmask_param_ncfilein">ncfilein</a>, <a href="#_smallmeshmask_param_ncfileout">ncfileout</a></span>, <a href="#_smallmeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 256 257 <div class="comments"></div> 258 259 260 261 262 <h3>Parameters</h3> 263 264 265 <h4 id="_smallmeshmask_param_ncfilein">ncfilein 266 267 268 269 270 271 272 273 274 </h4> 275 276 <div class="comments"></div> 277 278 <h4 id="_smallmeshmask_param_ncfileout">ncfileout 279 280 281 282 283 284 285 286 287 </h4> 288 289 <div class="comments"></div> 290 291 292 293 294 295 296 <h3>Keywords</h3> 297 298 <h4 id="_smallmeshmask_keyword_IODIR">IODIR 299 300 301 302 303 304 305 306 307 </h4> 308 309 <div class="comments"></div> 310 311 312 313 314 315 316 317 298 </div> 299 <h3>Version history</h3> 300 301 302 <h4>History</h4><div class="value"> 303 July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)</div> 318 304 319 305
Note: See TracChangeset
for help on using the changeset viewer.
