Previous SAXO Documentation Assistant: Overview Next

Utilities/

fitintobox.pro

Check that the input array has size and dimensions compatible with the domain that was defined with the previous call of domdef.

fitintobox Compatibility

result = fitintobox(field[, nx][, ny][, nz][, firstx][, firsty][, firstz][, lastx][, lasty][, lastz], WDEPTH=WDEPTH)

Return value

an array with dimensions matching the domain or -1 if there is an error...

Parameters

field        in required type: array or struct

an array or a structure that can be read by the function litchamp

nx        in optional default: define by grille

ny        in optional default: define by grille

nz        in optional default: define by grille

firstx        in optional default: define by grille

firsty        in optional default: define by grille

firstz        in optional default: define by grille

lastx        in optional default: define by grille

lasty        in optional default: define by grille

lastz        in optional default: define by grille

Keywords

WDEPTH       

To specify that we are at W level

Examples

 IDL> help, fitintobox(findgen(jpi,jpj))
     FLOAT     = Array[41, 3]
 IDL> help, fitintobox(findgen(jpi,jpj,78))
 Error:
 the array dimensions [180,148,78] are incompatible
 with the domain dimensions
 [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
     INT       =       -1

    

Version history

Version

$Id: fitintobox.pro 238 2007-03-27 13:43:18Z pinsard $

History

Sebastien Masson (smasson@lodyc.jussieu.fr) 10 juin 2000. June 2005: S. Masson rewrite all.

Other attributes

Uses routines

cm_4mesh cm_4cal

 


  Produced by IDLdoc 2.0.