Ignore:
Timestamp:
03/15/07 11:22:28 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Utilities/fitintobox.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
     6; @file_comments 
    77; Check that the input array has size and dimensions 
    88; compatible with the domain that was defined with the previous call 
    99; of domdef. 
    1010; 
    11 ; @categories  
     11; @categories 
    1212; Compatibility 
    13 ;  
    14 ; @param sz {in}{required}  
    15 ;  
     13; 
     14; @param sz {in}{required} 
     15; 
    1616; @param nx {in}{required} 
    1717; 
    … …  
    2525; 
    2626; @param jpk {in}{required} 
    27 ;  
     27; 
    2828; @param jpt {in}{required} 
    2929; 
    30 ; @returns -1 
    31 ; 
    32 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     30; @returns 
     31; -1 
     32; 
     33; @history 
     34; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3335;          10 juin 2000. 
    3436;          June 2005: S. Masson rewrite all. 
    3537; 
    36 ; @version $Id$ 
     38; @version 
     39; $Id$ 
    3740; 
    3841; @hidden 
    … …  
    5760  RETURN, report(['Error: ' $ 
    5861                  , 'the array dimensions ' + tostr(sz) + ' are incompatible' $ 
    59                   , 'with the the domain dimensions ' $                 
     62                  , 'with the the domain dimensions ' $ 
    6063                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $ 
    6164                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $ 
    … …  
    6770;+ 
    6871; 
    69 ; @categories  
     72; @categories 
    7073; Compatibility 
    7174; 
    7275; @param field {in}{required}{type=array or struct} 
    73 ; an array or a structure that can be read by the function                 
     76; an array or a structure that can be read by the function 
    7477; litchamp.pro 
    75 ;  
     78; 
    7679; @param nx {in}{optional}{default=define by grille.pro} 
    7780; 
    … …  
    9295; @param lastz {in}{optional}{default=define by grille.pro} 
    9396; 
    94 ; @keyword WDEPTH  
     97; @keyword WDEPTH 
    9598; To specify that we are at W level 
    9699; 
    97 ; @returns  
     100; @returns 
    98101; an array with dimensions matching the domain 
    99102; or -1 if there is an error... 
    … …  
    102105; @uses cm_4cal 
    103106; 
    104 ; @examples  
     107; @examples 
    105108; IDL> help, fitintobox(findgen(jpi,jpj)) 
    106109; <Expression>    FLOAT     = Array[41, 3] 
    107110; IDL> help, fitintobox(findgen(jpi,jpj,78)) 
    108 ; Error:  
     111; Error: 
    109112; the array dimensions [180,148,78] are incompatible 
    110 ; with the the domain dimensions  
     113; with the the domain dimensions 
    111114; [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] 
    112115; <Expression>    INT       =       -1 
    113116; 
    114 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     117; @history 
     118; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    115119;          10 juin 2000. 
    116120;          June 2005: S. Masson rewrite all. 
    117121; 
    118 ; @version $Id$ 
     122; @version 
     123; $Id$ 
    119124;- 
    120125;------------------------------------------------------------ 
    … …  
    152157      CASE 1 OF 
    153158; x arrays 
    154         sz[1] EQ jpi                                                   :arr = (temporary(arr))[firstx:lastx                               ]  
    155         sz[1] EQ  nx                                                   :                                                       
     159        sz[1] EQ jpi                                                   :arr = (temporary(arr))[firstx:lastx                               ] 
     160        sz[1] EQ  nx                                                   : 
    156161; y arrays 
    157         sz[1] EQ jpj                                                   :arr = (temporary(arr))[              firsty:lasty                 ]  
    158         sz[1] EQ  ny                                                   :                                                       
     162        sz[1] EQ jpj                                                   :arr = (temporary(arr))[              firsty:lasty                 ] 
     163        sz[1] EQ  ny                                                   : 
    159164; z arrays 
    160         sz[1] EQ jpk                                                   :arr = (temporary(arr))[                            firstz:lastz   ]  
    161         sz[1] EQ  nz                                                   :                                                       
     165        sz[1] EQ jpk                                                   :arr = (temporary(arr))[                            firstz:lastz   ] 
     166        sz[1] EQ  nz                                                   : 
    162167; t arrays 
    163168        sz[1] EQ jpt                                                   : 
    164         ELSE:return, err_mess(sz[1], jpi, nx, jpj, ny, jpk, nz, jpt)  
     169        ELSE:return, err_mess(sz[1], jpi, nx, jpj, ny, jpk, nz, jpt) 
    165170      ENDCASE 
    166171    END 
    … …  
    170175      CASE 1 OF 
    171176; xy arrays 
    172         sz[1] EQ jpi AND sz[2] EQ jpj                                  :arr = (temporary(arr))[firstx:lastx, firsty:lasty                 ]  
     177        sz[1] EQ jpi AND sz[2] EQ jpj                                  :arr = (temporary(arr))[firstx:lastx, firsty:lasty                 ] 
    173178        sz[1] EQ jpi AND sz[2] EQ  ny                                  :arr = (temporary(arr))[firstx:lastx,            *                 ] 
    174179        sz[1] EQ  nx AND sz[2] EQ jpj                                  :arr = (temporary(arr))[           *, firsty:lasty                 ] 
    175180        sz[1] EQ  nx AND sz[2] EQ  ny                                  :arr = (temporary(arr))[           *,            *                 ] 
    176181; x(y)z arrays 
    177         sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firstz:lastz   ]  
     182        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firstz:lastz   ] 
    178183        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ  nz                 :arr = (temporary(arr))[firstx:lastx,            *   ] 
    179184        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ jpk                 :arr = (temporary(arr))[           *, firstz:lastz   ] 
    180185        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ  nz                 : 
    181186; (x)yz arrays 
    182         nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk                 :arr = (temporary(arr))[              firsty:lasty, firstz:lastz   ]  
     187        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk                 :arr = (temporary(arr))[              firsty:lasty, firstz:lastz   ] 
    183188        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ  nz                 :arr = (temporary(arr))[              firsty:lasty,            *   ] 
    184189        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ jpk                 :arr = (temporary(arr))[                         *, firstz:lastz   ] 
    185190        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ  nz                 : 
    186191; xt arrays 
    187         sz[1] EQ jpi                                   AND sz[2] EQ jpt:arr = (temporary(arr))[firstx:lastx                            , *]  
     192        sz[1] EQ jpi                                   AND sz[2] EQ jpt:arr = (temporary(arr))[firstx:lastx                            , *] 
    188193        sz[1] EQ  nx                                   AND sz[2] EQ jpt: 
    189194; yt arrays 
    … …  
    191196                         sz[1] EQ  ny                  AND sz[2] EQ jpt: 
    192197; zt arrays 
    193                                           sz[1] EQ jpk AND sz[2] EQ jpt:arr = (temporary(arr))[                            firstz:lastz, *]  
     198                                          sz[1] EQ jpk AND sz[2] EQ jpt:arr = (temporary(arr))[                            firstz:lastz, *] 
    194199                                          sz[1] EQ  nz AND sz[2] EQ jpt: 
    195200        ELSE:return, err_mess(sz[1:2], jpi, nx, jpj, ny, jpk, nz, jpt) 
    … …  
    201206      CASE 1 OF 
    202207; xyz arrays 
    203         sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz   ]  
     208        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz   ] 
    204209        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ jpk                 :arr = (temporary(arr))[firstx:lastx,            *, firstz:lastz   ] 
    205210        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ jpk                 :arr = (temporary(arr))[           *, firsty:lasty, firstz:lastz   ] 
    206211        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ jpk                 :arr = (temporary(arr))[           *,            *, firstz:lastz   ] 
    207         sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *   ]  
     212        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *   ] 
    208213        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ  nz                 :arr = (temporary(arr))[firstx:lastx,            *,            *   ] 
    209214        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ  nz                 :arr = (temporary(arr))[           *, firsty:lasty,            *   ] 
    210215        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ  nz                 : 
    211216; xyt arrays 
    212         sz[1] EQ jpi AND sz[2] EQ jpj                  AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,               *]  
     217        sz[1] EQ jpi AND sz[2] EQ jpj                  AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,               *] 
    213218        sz[1] EQ jpi AND sz[2] EQ  ny                  AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *,               *] 
    214219        sz[1] EQ  nx AND sz[2] EQ jpj                  AND sz[3] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty,               *] 
    215220        sz[1] EQ  nx AND sz[2] EQ  ny                  AND sz[3] EQ jpt: 
    216221; (x)yzt arrays 
    217         nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[              firsty:lasty, firstz:lastz, *]  
     222        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[              firsty:lasty, firstz:lastz, *] 
    218223        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ  nz AND sz[3] EQ jpt:arr = (temporary(arr))[              firsty:lasty,            *, *] 
    219224        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[                         *, firstz:lastz, *] 
    220225        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ  nz AND sz[3] EQ jpt: 
    221226; x(y)zt arrays 
    222         sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,               firstz:lastz, *]  
     227        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,               firstz:lastz, *] 
    223228        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ  nz AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,                          *, *] 
    224229        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[           *,               firstz:lastz, *] 
    … …  
    232237      CASE 1 OF 
    233238; xyzt arrays 
    234         sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz, *]  
     239        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz, *] 
    235240        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *, firstz:lastz, *] 
    236241        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty, firstz:lastz, *] 
    237242        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[           *,            *, firstz:lastz, *] 
    238         sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *, *]  
     243        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *, *] 
    239244        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *,            *, *] 
    240245        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty,            *, *] 
Note: See TracChangeset for help on using the changeset viewer.