Changeset 238


Ignore:
Timestamp:
03/27/07 15:43:18 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC
Files:
92 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Calendar/caldat.pro

    r231 r238  
    3636; see also the use of key_caltype (variable of the common file cm_4cal) 
    3737; 
    38 ; @uses cm_4cal 
     38; @uses 
     39; cm_4cal 
    3940; 
    4041; @restrictions 
    … …  
    6162; @version 
    6263; $Id$ 
     64; 
    6365;- 
    6466; 
    65 pro caldat, julian, month, day, year, hour, minute, second, NDAYSPM = ndayspm 
     67PRO caldat, julian, month, day, year, hour, minute, second, NDAYSPM = ndayspm 
     68; 
     69  compile_opt idl2, strictarrsubs 
    6670; 
    6771@cm_4cal 
    6872; 
    69   compile_opt idl2, strictarrsubs 
    70  
    7173  ON_ERROR, 2                   ; Return to caller if errors 
    7274 

  • trunk/SRC/Calendar/date2jul.pro

    r231 r238  
    11;+ 
    22; 
    3 ; @file_comments  
     3; @file_comments 
    44; gives Julian day equivalent of a date in yyyymmdd format 
    55; 
    … …  
    1414; if 50 <= year <= 99 --> year = 1900 + year 
    1515; 
    16 ; @returns  
     16; @returns 
    1717; date in Julian day 
    1818; 
    … …  
    2525;       1 
    2626; 
    27 ; @history  
     27; @history 
    2828; Sebastien Masson (smasson\@lodyc.jussieu.fr) June 2005 
    2929; 
    … …  
    4646;------------------------------------------------------------ 
    4747  IF array_equal(date, long(date)) THEN return, julday(month, day, year) 
    48    
     48 
    4949  fraction = date - long(date) 
    5050  hour = floor(fraction * 24d) 
    … …  
    5252  minute = floor(fraction*1440d) 
    5353  second = (TEMPORARY(fraction) - minute/1440d) * 86400d 
    54    
     54 
    5555  return, julday(month, day, year, hour, minute, second) 
    5656 

  • trunk/SRC/Calendar/date2string.pro

    r231 r238  
    2424;    JAN 23, 1990 
    2525; 
    26 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     26; @history 
     27; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2728; Creation ??? 
    2829; update/review June 2005 Sebastien Masson. 

  • trunk/SRC/Calendar/daysinmonth.pro

    r231 r238  
    44; give the number of days in a specific month 
    55; 
    6 ; @categories  
     6; @categories 
    77; Calendar 
    88; 
    … …  
    1515; month number 
    1616; 
    17 ; @returns  
     17; @returns 
    1818; number of days in a month or -1 in case of error 
    1919; 
    20 ; @uses  
    21 ; cm_4cal, updatenew 
     20; @uses 
     21; cm_4cal 
     22; updatenew 
    2223; 
    2324; @examples 
    2425; IDL> ndays = daysinmonth(2, 2000) 
    2526; 
    26 ; @history  
     27; @history 
    2728; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2829; 2/7/98 
    2930; update/review/english/new commons: June 2005 Sebastien Masson. 
    3031; 
    31 ; @version  
     32; @version 
    3233; $Id$ 
    3334; 

  • trunk/SRC/Calendar/leapyr.pro

    r231 r238  
    66; eg. NUM_DAYS_IN_YR = 365 + leapyr(year) 
    77; 
    8 ; @categories  
     8; @categories 
    99; Calendar 
    1010; 
    … …  
    1212; year to be tested as a leap year. 
    1313; 
    14 ; @returns  
     14; @returns 
    1515; 0 then not a leap year, 1 then year is a leap year 
    1616; with the same number of elements than year. 

  • trunk/SRC/Colors/newpalette.pro

    r232 r238  
    2121; Used to pass keywords to <proidl>modifyct</proidl> 
    2222; 
    23 ; @history  
     23; @history 
    2424; Guillaume Roulet (gr\@lodyc.jussieu.fr) 
    2525; 30/3/1999 s.masson, add _extra, research of the full name, OVER 

  • trunk/SRC/Colors/xpal.pro

    r237 r238  
    1212;- 
    1313; 
    14 function xp_new_colors 
     14FUNCTION xp_new_colors 
    1515; 
    1616  compile_opt idl2, strictarrsubs 
    … …  
    3333  return, res 
    3434end 
    35  
    36 ;+ 
    37 ; @hidden 
    38 ;- 
    39 pro xp_alert_caller 
     35; 
     36;+ 
     37; 
     38; @hidden 
     39; 
     40;- 
     41; 
     42PRO xp_alert_caller 
    4043; 
    4144  compile_opt idl2, strictarrsubs 
    … …  
    6164  endif 
    6265end 
    63 ; XP_XLCTCALLBACK:  For visuals with static colormaps, update the graphics 
    64 ; after a change by XLOADCT. 
    65 ;+ 
    66 ; @hidden 
    67 ;- 
    68 pro xp_xlctcallback 
     66;+ 
     67; 
     68; For visuals with static colormaps, update the graphics 
     69; after a change by <proidl>XLOADCT</proidl>. 
     70; 
     71; @hidden 
     72; 
     73;- 
     74; 
     75PRO xp_xlctcallback 
    6976; 
    7077  compile_opt idl2, strictarrsubs 
    … …  
    7683 
    7784end 
    78  
    79 ;+ 
    80 ; @hidden 
    81 ;- 
    82 pro xp_redraw 
     85; 
     86;+ 
     87; 
     88; @hidden 
     89; 
     90;- 
     91; 
     92PRO xp_redraw 
    8393; 
    8494  compile_opt idl2, strictarrsubs 
    … …  
    94104end 
    95105 
    96 ; XP_REPLOT: Re-draw the RGB plots. Type has the following possible values. 
     106;+ 
     107; 
     108; @hidden 
     109; 
     110; @file_comments 
     111; Re-draw the RGB plots. 
     112; 
     113; @param color_index 
     114; 
     115; @param type 
     116; Type has the following possible values. 
    97117;       - 'D': Draw the data part of all three plots 
    98118;       - 'F': draw all three plots 
    99119;       - 'R': Draw the data part of the Red plot 
    100120;       - 'G': Draw the data part of the Green plot 
    101 ;       - 'B': Draw the data part of the Blue plot 
    102 ;+ 
    103 ; @param color_index 
    104 ; ??? 
    105 ; @param type 
    106 ; ??? 
    107 ; 
    108 ; @hidden 
    109 ;- 
    110 pro xp_replot, color_index, type 
     121; 
     122;- 
     123; 
     124PRO xp_replot, color_index, type 
    111125; 
    112126  compile_opt idl2, strictarrsubs 
    … …  
    179193 
    180194end 
    181  
    182  
    183  
    184 ; XP_CHANGE_COLOR:  Change current color. Type has the following possible values. 
     195; 
     196;+ 
     197; 
     198; @hidden 
     199; 
     200; @file_comments 
     201; Change current color. 
     202; 
     203; @param type 
     204; Type has the following possible values. 
    185205;       - 'R': Change the R part of the current color 
    186206;       - 'G': ... 
    187207;       - 'B': ... 
    188 ;+ 
    189 ; 
    190 ; @param type 
    191 ; ??? 
     208; 
    192209; @param value 
    193 ; ??? 
    194 ; 
    195 ; @hidden 
    196 ;- 
    197 pro xp_change_color, type, value 
     210; 
     211;- 
     212; 
     213PRO xp_change_color, type, value 
    198214; 
    199215  compile_opt idl2, strictarrsubs 
    … …  
    237253end 
    238254;+ 
     255; 
    239256; @param event 
    240 ; ??? 
    241 ; @hidden 
    242 ;- 
    243 pro xp_button_event, event 
     257; 
     258; @hidden 
     259; 
     260;- 
     261; 
     262PRO xp_button_event, event 
    244263; 
    245264  compile_opt idl2, strictarrsubs 
    … …  
    357376 
    358377;+ 
    359 ; @hidden 
     378; 
     379; @hidden 
     380; 
    360381; @param ev 
    361 ; ??? 
    362 ;- 
     382; 
     383;- 
     384; 
    363385PRO xp_button_event_event, ev 
    364386; 
    … …  
    383405 
    384406END 
    385  
    386  
    387  
    388  
    389 ;+ 
     407; 
     408;+ 
     409; 
    390410; @param event 
    391 ; ??? 
    392 ; @hidden 
    393 ;- 
    394  
    395 pro xp_event, event 
     411; 
     412; @hidden 
     413; 
     414;- 
     415; 
     416PRO xp_event, event 
    396417; 
    397418  compile_opt idl2, strictarrsubs 
    … …  
    435456 
    436457 END 
    437  
     458; 
    438459;+ 
    439460; 
    440461; @file_comments 
    441462; Like <proidl>xpalette</proidl> but shorter to write and, moreover, 
    442 ; possess a hotkey save which (thanks to the newpalette routine) 
     463; possess a hotkey save which (thanks to the <pro>newpalette</pro> routine) 
    443464; allows to save the routine that we have just done. Comment: when we 
    444 ; press the predefined hotkey, it calls <pro>xlct</pro> instead of  
     465; press the predefined hotkey, it calls <pro>xlct</pro> instead of 
    445466; <proidl>xloadct</proidl> 
    446467; No explicit inputs.  The current color table is used as a starting point. 
    … …  
    449470; Color, Widget 
    450471; 
    451 ; @uses XP_COM 
    452 ; Private to this module. 
     472; @uses 
     473; XP_COM Private to this module. 
    453474; 
    454475; @restrictions 

  • trunk/SRC/Commons/cm_4cal.pro

    r231 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    56;- 
    … …  
    1213;             = 'noleap' : no leap year calendar (always 365 days) 
    1314COMMON key_calendar, key_caltype 
    14 ; 
    15  
    16  

  • trunk/SRC/Commons/cm_4data.pro

    r231 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    56;- 
    … …  
    1112COMMON global_data_coord, jpidta, jpjdta, jpkdta 
    1213; 
    13 ; domains positions regarding to the original grid  
     14; domains positions regarding to the original grid 
    1415; 
    1516COMMON zoom_data, ixmindta, ixmaxdta, iymindta $ 
    … …  
    2223; 
    2324COMMON xxx_readparameters, ccreadparameters 
    24  
    25  
    26  
    27  

  • trunk/SRC/Commons/cm_4mesh.pro

    r231 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    56;- 
    … …  
    1213COMMON global_mesh_coord, jpiglo, jpjglo, jpkglo 
    1314; 
    14 ; domains positions regarding to the original grid  
     15; domains positions regarding to the original grid 
    1516; 
    1617COMMON zoom_mesh, ixminmesh, ixmaxmesh $ 
    … …  
    1819; 
    1920; mesh related coordinates 
    20 ; see OPA manual  
     21; see OPA manual 
    2122COMMON longitudes, glamf, glamt, glamu, glamv 
    2223COMMON latitudes, gphif, gphit, gphiu, gphiv 
    … …  
    5051COMMON liees_a_triangule, triangles_list, twin_corners_up, twin_corners_dn 
    5152; 
    52  
    53  
    54  
    55  

  • trunk/SRC/Commons/cm_4ps.pro

    r231 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    56;- 

  • trunk/SRC/Commons/cm_general.pro

    r157 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    56;- 

  • trunk/SRC/Computation/curl.pro

    r231 r238  
    2020; 
    2121; @keyword DIREC {type=scalar string} 
    22 ; Use if you want to call moyenne or grossemoyenne after the div computation 
     22; Use if you want to call <pro>moyenne</pro> or 
     23; <pro>grossemoyenne</pro> after the div computation 
    2324; with a mean done in the DIREC direction 
    2425; 
    25 ; @returns RES 
     26; @returns 
    2627; the vertical component of the curl of the input data (with the same size) 
    2728; 
    2829; @uses 
    29 ; cm_4cal, cm_4data, cm_4mmesh 
     30; cm_4cal 
     31; cm_4data 
     32; cm_4mmesh 
    3033; 
    3134; @restrictions 
    … …  
    5962; @todo 
    6063; code the 4d case 
     64; 
    6165;- 
    6266; 

  • trunk/SRC/Computation/div.pro

    r231 r238  
    2020; 
    2121; @keyword DIREC {type=scalar string} 
    22 ; Use if you want to call moyenne or grossemoyenne after the div computation 
     22; Use if you want to call <pro>moyenne</pro> or 
     23; <pro>grossemoyenne</pro> after the div computation 
    2324; (stupid ?) with a mean done in the DIREC direction 
    2425; 
    25 ; @returns RES 
     26; @returns 
    2627; the divergence of the input data (with the same size) 
    2728; 
    2829; @uses 
    29 ; cm_4cal, cm_4data, cm_4mmesh 
     30; cm_4cal 
     31; cm_4data 
     32; cm_4mmesh 
    3033; 
    3134; @restrictions 
    … …  
    3841;   T, U, V and F grids, it is possible that these two arrays do not have the same 
    3942;   size and refer to different indexes. In this case, arrays are re-cut on 
    40 ;   common indexes. To avoid these re-cuts, use the keyword /memeindice in  
     43;   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
    4144; <pro>domdef</pro> 
    4245; - When computing the divergence, we update, vargrid, varname, varunits and the 
    … …  
    5861; @todo 
    5962; code the 4d case 
     63; 
    6064;- 
    6165; 

  • trunk/SRC/Computation/grad.pro

    r232 r238  
    88; 
    99; @param FIELD 
    10 ; The field for which we want to compute the gradient.  A 2D (xy), 
     10; The field for which we want to compute the gradient. A 2D (xy), 
    1111; 3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp 
    1212; and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
    … …  
    1616; the gradient direction: 'x', 'y', 'z' 
    1717; 
    18 ; @returns RES {type=2D, 3D or 4D array} 
    19 ; the gradient of the input data (with the same size) 
     18; @returns 
     19; the gradient of the input data with the same size 2D, 3D or 4D array 
    2020; 
    2121; @uses 
    22 ; cm_4cal, cm_4data, cm_4mmesh 
     22; cm_4cal 
     23; cm_4data 
     24; cm_4mmesh 
    2325; 
    2426; @restrictions 

  • trunk/SRC/ForOldVersion/keep_compatibility.pro

    r232 r238  
    77;   4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro' 
    88; 
    9 ; @categories  
     9; @categories 
    1010; Compatibility 
    1111; 
    12 ; @param flag {in}{optional} 1 or 0 to keep or forget the compatibility 
     12; @param flag {in}{optional} 
     13; 1 or 0 to keep or forget the compatibility 
    1314; 
    14 ; @uses cm_general 
     15; @uses 
     16; cm_general 
    1517; 
    1618; @restrictions 
    … …  
    2123; IDL> keep_compatibility,0 
    2224; 
    23 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     25; @history 
     26; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2427;                      June 2005 
    2528; 
    26 ; @version $Id$ 
     29; @version 
     30; $Id$ 
    2731; 
    2832;- 
    2933; 
    3034PRO keep_compatibility, flag 
    31 ; 
    3235; 
    3336  compile_opt idl2, strictarrsubs 
    … …  
    105108  ENDIF 
    106109; 
    107 ; merge the online_help if possible..  
     110; merge the online_help if possible... 
    108111; 
    109112  mergeonline_help 

  • trunk/SRC/ForOldVersion/oldcm_empty.pro

    r122 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       June 2005 
    5 ; @version $Id$ 
     6; @version 
     7; $Id$ 
     8; 
    69;- 
    710; 

  • trunk/SRC/ForOldVersion/oldcm_full.pro

    r122 r238  
    11;+ 
    22; 
    3 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     3; @history 
     4; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       14/8/98 
    5 ; @version $Id$ 
     6; @version 
     7; $Id$ 
    68;- 
    79; 

  • trunk/SRC/ForOldVersion/updatekwd.pro

    r231 r238  
    77; @categories compatibility with previous version 
    88; 
    9 ; @examples  
     9; @examples 
    1010; IDL> \@updatekwd 
    11 ;   (must be insert as an include in a procedure or function)  
     11;   (must be insert as an include in a procedure or function) 
    1212; 
    1313; @restrictions the compatibility can be made only if the keyword 
    1414;               given through _extra are given with their complete name 
    1515; 
    16 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     16; @history 
     17; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1718;                      July 2005 
    18 ; @version $Id$ 
     19; @version 
     20; $Id$ 
    1921; 
    2022;- 
    … …  
    4143  old = strtrim(strlowcase(old[1:*]), 2) 
    4244  new = strtrim(strlowcase(new[1:*]), 2) 
    43 ;   
     45; 
    4446; what are the keywords of the present routine? 
    4547; 
    … …  
    6466    FOR i = 0, n_elements(alltags)-1 DO BEGIN 
    6567      isold = (where(old EQ alltags[i], count))[0] 
    66       IF count EQ 1 THEN BEGIN  
     68      IF count EQ 1 THEN BEGIN 
    6769        dummy = where(kwds EQ new[isold], count) 
    68         IF count EQ 1 THEN BEGIN  
     70        IF count EQ 1 THEN BEGIN 
    6971          dummy = execute(new[isold] + ' = ex.' + alltags[i]) 
    7072;           dummy = execute('ex = get_extra(' + new[isold] + ' = ex.' $ 

  • trunk/SRC/ForOldVersion/updatenew.pro

    r232 r238  
    66; check that key_forgetold and keep_compatibility are well defined... 
    77; 
    8 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     8; @history 
     9; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    910;                       June 2005 
    10 ; @version $Id$ 
     11; @version 
     12; $Id$ 
    1113;- 
    1214; 

  • trunk/SRC/ForOldVersion/updateold.pro

    r232 r238  
    44; check that key_forgetold and keep_compatibility are well defined... 
    55; 
    6 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     6; @history 
     7; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    78;                       14/8/98 
    8 ; @version $Id$ 
     9; @version 
     10; $Id$ 
    911; 
    1012;- 

  • trunk/SRC/Grid/changemsk.pro

    r232 r238  
    1515; 
    1616; @returns 
    17 ; newmsk the new 2D land-sea mask 
     17; the new 2D land-sea mask 
    1818; 
    1919; @examples 
    … …  
    3131;- 
    3232; 
    33 function changemsk,tab, CELLSIZE = cellsize 
     33FUNCTION changemsk,tab, CELLSIZE = cellsize 
    3434; 
    3535  compile_opt idl2, strictarrsubs 
    … …  
    8282   return, newmsk 
    8383end 
    84  

  • trunk/SRC/Grid/checkperio.pro

    r236 r238  
    4545; 
    4646PRO checkperio, file, WRITE = write 
    47  
     47; 
     48  compile_opt idl2, strictarrsubs 
     49; 
    4850  IF file_test(file) EQ 0 THEN BEGIN 
    4951    ras = report( 'file '+file+' not found') 

  • trunk/SRC/Grid/computegrid.pro

    r237 r238  
    128128;       Specify latitudes in this case starty, stepy and ny are not used but 
    129129;       starty and stepy could be necessary if the x axis is not defined with 
    130 ;       xaxis. It must be sorted in the increasing or deceasing order (along each column if 2d array). 
     130;       xaxis. It must be sorted in the increasing or decreasing order (along each column if 2d array). 
    131131; 
    132132; @keyword XYINDEX activate to specify that the horizontal grid should 
    … …  
    209209; 
    210210; @keyword ZAXIS {type=1D} 
    211 ;       Specify the vertical axis. Must be sorted in the increasing or deceasing order 
     211;       Specify the vertical axis. Must be sorted in the increasing or decreasing order 
    212212; 
    213213; @keyword _EXTRA 
    214214; not used in the present case ... 
    215215; 
    216 ; @uses  
    217 ; cm_4mesh cm_4data cm_4cal 
    218 ; 
    219 ; @restrictions  
     216; @uses 
     217; cm_4mesh 
     218; cm_4data 
     219; cm_4cal 
     220; 
     221; @restrictions 
    220222; if the grid has x/y periodicity overlap and/or if 
    221223;    the mask has 0 everywhere at the border (like a closed sea) and 
    … …  
    226228;    to use cell_fill = 1). 
    227229; 
    228 ; @restrictions  
    229230; FUV points definition is not exact if the grid is irregular 
    230231; 

  • trunk/SRC/Grid/micromeshmask.pro

    r237 r238  
    1010; 
    1111; @param inid {in}{required} 
     12; 
    1213; @param outid {in}{required} 
     14; 
    1315; @param inname {in}{required} 
     16; 
    1417; @param outname {in}{optional} 
    1518; 
    … …  
    4346; xxx.mask.nc. In that case, the meshmask is split into 3 files. 
    4447; 
    45 ; @param ncfileout {in}{optional} the name of the uniq reduced meshmask file. 
    46 ; default definition is micromeshmask.nc 
    47 ; 
    48 ; @keyword IODIR to define the files path. 
     48; @param ncfileout {in}{optional} {default='micromeshmask.nc'} 
     49; the name of the uniq reduced meshmask file. 
     50; 
     51; @keyword IODIR 
     52; to define the files path. 
    4953; 
    5054; @examples 

  • trunk/SRC/Grid/n128gaussian.pro

    r231 r238  
    1111; IDL> lat=n128gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n128gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n160gaussian.pro

    r231 r238  
    99; 
    1010; @examples 
    11 ; IDL>lat=n160gaussian() 
     11; IDL> lat=n160gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n160gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n256gaussian.pro

    r231 r238  
    1111; IDL> lat=n256gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n256gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n48gaussian.pro

    r231 r238  
    1111; IDL> lat=n48gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n48gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/n80gaussian.pro

    r232 r238  
    11;+ 
    22; 
    3 ; @file_comments  
     3; @file_comments 
    44; compute the latitudes of the n80 gaussian grid. See: 
    55; <a href="http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html">Gaussian 80</a> 
    … …  
    1111; IDL> lat=n80gaussian() 
    1212; 
    13 ; @returns a 1d array 
     13; @returns 
     14; a 1d array 
    1415; 
    1516; @history 
    … …  
    2324; 
    2425FUNCTION n80gaussian 
    25 ; 
    2626; 
    2727  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Grid/numbisland.pro

    r231 r238  
    11;+ 
     2; 
    23; @hidden 
    34; 
    … …  
    2425; 
    2526PRO mskneig, msk, nx, ny, indin, numb 
     27; 
     28  compile_opt idl2, strictarrsubs 
     29; 
    2630; flag the point 
    2731  msk[indin] = numb 
    … …  
    3337; build 1d index 
    3438  ind = temporary(indx)#replicate(1L, 3) + replicate(nx, 3)#temporary(indy) 
    35 ; for each neighbourgs on the same island, call again mskneig 
     39; for each neighbourg on the same island, call again mskneig 
    3640  FOR i = 0, n_elements(ind)-1 DO BEGIN 
    3741    IF msk[ind[i]] EQ 0 THEN mskneig, msk, nx, ny, ind[i], numb 
    … …  
    4044  return 
    4145END 
    42  
     46; 
    4347;+ 
     48; 
    4449; @file_comments 
    45 ; given a 2D land-se mask, give a number to each islands 
     50; given a 2D land-sea mask, give a number to each island 
    4651; 
    4752; @categories 
    … …  
    6772; @version 
    6873; $Id$ 
     74; 
    6975;- 
    7076; 
    7177FUNCTION numbisland, mskin 
    72   time1 = systime(1) ; performance measurment 
     78; 
     79  compile_opt idl2, strictarrsubs 
     80; 
     81  time1 = systime(1) ; performance measurement 
    7382  szmsk = size(reform(mskin)) 
    7483  IF szmsk[0] NE 2 THEN stop 

  • trunk/SRC/Grid/restoreboxparam.pro

    r231 r238  
    55; previously defined by <pro>saveboxparam</pro> 
    66; 
    7 ; @param filename {in}{required} 
    8 ; a scalar string defining the file name 
     7; @param filename {in}{required}{type= scalar string} 
     8; the file name 
    99; 
    1010; @uses 

  • trunk/SRC/Grid/romsdepth.pro

    r231 r238  
    1212; 
    1313; @uses 
    14 ; cm_4mesh cm_4data 
     14; cm_4mesh 
     15; cm_4data 
    1516; 
    1617; @restrictions 
    … …  
    2223; @version 
    2324; $Id$ 
     25; 
    2426;- 
    2527; 
    2628FUNCTION romsdepth 
     29; 
     30  compile_opt idl2, strictarrsubs 
    2731; 
    2832@cm_4mesh 

  • trunk/SRC/Grid/saveboxparam.pro

    r231 r238  
    66; (common variable defined by def_myuniquetmpdir) 
    77; 
    8 ; @param filename {in}{required} 
    9 ; a scalar string defining the file name 
     8; @param filename {in}{required} {type=scalar string} 
     9; the file name 
    1010; 
    1111; @uses 

  • trunk/SRC/Grid/smallmeshmask.pro

    r236 r238  
    55; 
    66; @param inid {in}{required} 
     7; 
    78; @param outid {in}{required} 
     9; 
    810; @param inname {in}{required} 
     11; 
    912; @param outname {in}{optional} 
    1013; 
    … …  
    2831; 
    2932;+ 
     33; 
    3034; @file_comments 
    3135; Reduce the size of the NetCDF meshmask created by OPA by 
    … …  
    3337; fields. 
    3438; 
    35 ; @keyword IODIR to define the files path. 
     39; @keyword IODIR 
     40; to define the files path. 
     41; 
    3642; @param ncfilein {in}{required} 
    3743; 1) the name of the meshmask file to be reduced. In that case, 
    … …  
    6066; 
    6167;- 
     68; 
    6269PRO smallmeshmask, ncfilein, ncfileout, IODIR = iodir 
    63 ; 
    6470; 
    6571  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Interpolation/angle.pro

    r236 r238  
    3939END 
    4040;+ 
    41 ; @file_comments Compute angles between grid lines and direction of the North pole 
     41; 
     42; @file_comments 
     43; Compute angles between grid lines and direction of the North pole 
    4244;(fom angle.F,v 2.2 in OPA8.2) 
    4345; 
    … …  
    9294; @version 
    9395; $Id$ 
     96; 
    9497;- 
    9598; 
    … …  
    97100           , IODIRECTORY = iodirectory, DOUBLE = double 
    98101; 
     102  compile_opt idl2, strictarrsubs 
     103; 
    99104; 0. read oceanic grid parameters 
    100105; ================================ 
    101 ; 
    102 ; 
    103   compile_opt idl2, strictarrsubs 
    104106; 
    105107  IF keyword_set(IODIRECTORY) THEN BEGIN 

  • trunk/SRC/Interpolation/clickincell.pro

    r232 r238  
    88; 
    99; @keyword CELLTYPE 
    10 ; = 'T', 'W', 'U', 'V' or 'F' This this the type of point 
     10; = 'T', 'W', 'U', 'V' or 'F' 
     11; the type of point 
    1112;     that is located in the center of the cell which the click is 
    1213;     located. default is T type of cell (with corner defined by F 
    … …  
    2829; 
    2930; @keyword _EXTRA 
    30 ; Used to pass extra keywords to <pro>inquad</pro> and  
     31; Used to pass extra keywords to <pro>inquad</pro> and 
    3132; <proidl>plot</proidl> 
    3233; (when /drawcell) 

  • trunk/SRC/Interpolation/compute_fromirr_bilinear_weigaddr.pro

    r236 r238  
    4949;  and the weight is redistributed on the remaining "water" corners 
    5050;  -  points located out of the southern and northern boundaries or in cells 
    51 ;  containing only land points are set the the same value as their closest neighbor 
     51;  containing only land points are set the same value as their closest neighbor 
    5252; 
    5353; @history 

  • trunk/SRC/Interpolation/compute_fromreg_bilinear_weigaddr.pro

    r232 r238  
    3939; @restrictions 
    4040;  - the input grid must be a "regular grid", defined as a grid for which each 
    41 ;  longitudes lines have the same latitude and each latitudes columns have the 
     41;  longitude lines have the same latitude and each latitude columns have the 
    4242;  same longitude. 
    4343;  - We supposed the data are located on a sphere, with a periodicity along 
    … …  
    123123                  , checkout = [alon[jpia-1L], alat[jpja-1L]], /output2d) 
    124124; checks... 
    125 ; for longitude, each ocean points must be located in atm cell. 
     125; for longitude, each ocean point must be located in atm cell. 
    126126  IF (where(pos[0, *] EQ -1))[0] NE -1 THEN stop 
    127127; no ocean point should be located westward of the left boundary of the 
    … …  
    134134; we use bilinear interpolation 
    135135; 
    136 ; we change the coordinates of each ocean points to fit into a 
     136; we change the coordinates of each ocean point to fit into a 
    137137; rectangle defined by: 
    138138; 
    … …  
    239239  return 
    240240end 
    241  

  • trunk/SRC/Interpolation/compute_fromreg_imoms3_weigaddr.pro

    r231 r238  
    3939; @restrictions 
    4040;  - the input grid must be a "regular/rectangular grid", defined as a grid for 
    41 ;  which each longitudes lines have the same latitude and each latitudes columns 
     41;  which each longitude lines have the same latitude and each latitude columns 
    4242;  have the same longitude. 
    4343;  -  We supposed the data are located on a sphere, with a periodicity along 

  • trunk/SRC/Interpolation/extrapolate.pro

    r236 r238  
    22; 
    33; @file_comments 
    4 ; extrapolate data (zinput) where maskinput eq 0 by filling step by 
     4; extrapolate data (zinput) where maskinput equal 0 by filling step by 
    55; step the coastline points with the mean value of the 8 neighbourgs 
    66; (weighted by their mask value). 
    … …  
    3333; put 1 to force the extrapolated values to be larger than 0, same as using minval=0. 
    3434; 
    35 ; @returns {type=2d array} 
    36 ; the extrapolated array 
     35; @returns 
     36; the extrapolated 2d array 
    3737; 
    3838; @examples 
    … …  
    114114; find the coastline points... 
    115115;--------------------------------------------------------------- 
    116 ; Once the land points list has been found, we change back the the 
     116; Once the land points list has been found, we change back the 
    117117; mask values for the boundary conditions. 
    118118    msk[0, *] = 0b 
    … …  
    163163    IF n_elements(maxval) NE 0 THEN zcoast = temporary(zcoast) < maxval 
    164164    z[coast] = temporary(zcoast)/temporary(weight) 
    165 ; we update the the boundary conditions of z 
     165; we update the boundary conditions of z 
    166166    if keyword_set(x_periodic) then begin 
    167167      z[0, *] = z[nx, *] 
    … …  
    191191  return, z[1:nx, 1:ny] 
    192192END 
    193  

  • trunk/SRC/Interpolation/extrapsmooth.pro

    r236 r238  
    22; 
    33; @file_comments 
    4 ; similar to extrapolate but could to the job in a better way because the 
    5 ; extrapolated values are smoothed... takes more time than extrapolate. 
    6 ; extrapolate data where mskin eq 0 by filling 
     4; similar to <pro>extrapolate</pro> but could to the job in a better way 
     5; because the ; extrapolated values are smoothed... 
     6; takes more time than <pro>extrapolate</pro>. 
     7; extrapolate data where mskin is equal 0 by filling 
    78; step by step the coastline points with the mean value of the 8 neighbourgs. 
    89; 

  • trunk/SRC/Interpolation/fromirr.pro

    r236 r238  
    99; 
    1010; @param method {in}{required}{type=string} 
    11 ; a string defining the interpolation method. must be 'bilinear' 
     11; the interpolation method. must be 'bilinear' 
    1212; 
    1313; @param datain {in}{required}{type=2d array} 
    14 ; a 2D array the input data to interpolate 
     14; the input data to interpolate 
    1515; 
    1616; @param lonin {in}{required}{type=2d array} 
    17 ; a 2D array defining the longitude of the input data 
     17; the longitude of the input data 
    1818; 
    1919; @param latin {in}{required}{type=2d array} 
    20 ; a 2D array defining the latitude of the input data. 
     20; the latitude of the input data. 
    2121; 
    2222; @param mskin {in}{required}{type=2d array or -1} 
    … …  
    2525; 
    2626; @param lonout {in}{required}{type=1d or 2d array} 
    27 ; 1D or 2D array defining the longitude of the output data. 
     27; the longitude of the output data. 
    2828; 
    2929; @param latout {in}{required}{type=1d or 2d array} 
    30 ; 1D or 2D array defining the latitude of the output data. 
     30; the latitude of the output data. 
    3131; 
    3232; @param mskout {in}{required}{type=2d array or -1} 
    … …  
    7373; IDL> help, a, b 
    7474; 
    75 ; 2) use a and b that are now defined to bypass the computation of the weights and addresses  
    76 ; and speed-up the computation! 
     75; 2) use a and b that are now defined to bypass the computation of the weights  
     76; and addresses and speed-up the computation! 
    7777; 
    7878; IDL> t2ncep = fromirr('bilinear', topa, WEIG = a, ADDR = b) 

  • trunk/SRC/Interpolation/fromreg.pro

    r236 r238  
    44; interpolate data from a "regular/rectangular grid" to any grid. 
    55;   2 methods available: bilinear and imoms3 
    6 ;   A "regular/rectangular grid" is defined as a grid for which each longitudes lines have 
    7 ;   the same latitude and each latitudes columns have the same longitude. 
     6;   A "regular/rectangular grid" is defined as a grid for which  
     7; each longitude lines have the same latitude and each latitude columns  
     8; have the same longitude. 
    89; 
    910; @categories  
    … …  
    1112; 
    1213; @param method {in}{required}{type=string} 
    13 ; a string defining the interpolation method. 
     14; the interpolation method. 
    1415; must be 'bilinear' or 'imoms3' 
    1516; 
    1617; @param datain {in}{required}{type=2d array} 
    17 ; a 2D array the input data to interpolate 
     18; the input data to interpolate 
    1819; 
    1920; @param lonin {in}{required}{type=1d or 2d array} 
    20 ; 1D or 2D array defining the longitude of the input data 
     21; the longitude of the input data 
    2122; 
    2223; @param latin {in}{required}{type=1d or 2d array} 
    23 ; 1D or 2D array defining the latitude of the input data 
     24; the latitude of the input data 
    2425; 
    2526; @param lonout {in}{required}{type=1d or 2d array} 
    26 ; 1D or 2D array defining the longitude of the output data 
     27; the longitude of the output data 
    2728; 
    2829; @param latout {in}{required}{type=1d or 2d array} 
    29 ; 1D or 2D array defining the latitude of the output data 
     30; the latitude of the output data 
    3031; 
    3132; @keyword WEIG {type=2d array or variable name} 
    … …  
    6869;  
    6970; 1) get back the weights and addresses in variables a and b 
    70 ;   (that must be undefined or equal to 0 before calling fromreg) 
     71;   (that must be undefined or equal to 0 before calling fromreg 
    7172; 
    7273; IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b) 

  • trunk/SRC/Interpolation/get_gridparams.pro

    r236 r238  
    2222; IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions 
    2323; 
    24 ; 1) 
    2524; @param in1 {in}{required} 
    2625; Case 1: the name of the netcdf file 
    … …  
    4645; Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    4746; arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    48 ; grid must be regular (each longitudes must be the same for all latitudes 
    49 ; and each latitudes should be the same for all longitudes). 
     47; grid must be regular (each longitude must be the same for all latitudes 
     48; and each latitude should be the same for all longitudes). 
    5049; 
    5150; @param in6 {out} 
    … …  
    7978;                  file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 
    8079;                   lon,   lat,   jpi,     jpj, n_dimensions 
    81 ; 
    8280; 
    8381  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Interpolation/inquad.pro

    r236 r238  
    3535; @keyword ZOOMRADIUS {default=4} 
    3636; the zoom (circle centered on the (x,y) with a radius of 
    37 ; zoomradius degree where we look for the the quadrilateral which 
     37; zoomradius degree where we look for the quadrilateral which 
    3838; contains the (x,y) point) used for the satellite projection 
    3939; when /ONSPHERE is activated. 

  • trunk/SRC/Interpolation/inrecgrid.pro

    r231 r238  
    66; find in which cell is located each given point. 
    77; 
    8 ; @categories  
     8; @categories 
    99; Without loop 
    1010; 

  • trunk/SRC/Interpolation/ll_narcs_distances.pro

    r231 r238  
    44; This function returns the longitude and latitude [lon, lat] of 
    55; a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), 
    6 ; from a specified location Lon0, lat0. 
    7 ; Same as LL_ARC_DISTANCE but for n points without do loop. 
     6; from a specified location Lon0, Lat0. 
     7; Same as <proidl>LL_ARC_DISTANCE</proidl> but for n points without do loop. 
    88; 
    99; Formula from Map Projections - a working manual.  USGS paper 
    1010; 1395. Equations (5-5) and (5-6). 
    1111; 
    12 ; @categories  
     12; @categories 
    1313; Mapping, geography 
    1414; 

  • trunk/SRC/Interpolation/map_npoints.pro

    r231 r238  
    66; returns the distances between number n of P0 points and number 
    77; n of P1 points (in that case, np0 and np1 must be equal). 
    8 ; Same as map_2points with the meter parameter but for n points 
    9 ; without do loop. 
     8; Same as <proidl>map_2points</proidl> with the meter parameter but for n 
     9; points without do loop. 
    1010; 
    1111; @categories 
    … …  
    3636; 
    3737; @keyword TWO_BY_TWO 
    38 ; If given,then Map_nPoints returns the distances between number n of 
     38; If given, then map_npoints returns the distances between number n of 
    3939; P0 points and number n of P1 points 
    4040; In that case, np0 and np1 must be equal. 
    … …  
    4444; points P0 and np1 points P1. Element (i,j) of the output is the 
    4545; distance between element P0[i] and P1[j]. 
    46 ; If keyword /TWO_BY_TWO is given then Map_nPoints returns 
     46; If keyword /TWO_BY_TWO is given then map_npoints returns 
    4747; an np-element vector giving the distance in meter between P0[i] 
    4848; and P1[i] (in that case, we have np0 = np1 = np) ; if /MIDDLE see this keyword. 
    … …  
    103103;- 
    104104; 
    105 Function map_npoints, lon0, lat0, lon1, lat1, AZIMUTH = azimuth $ 
     105FUNCTION map_npoints, lon0, lat0, lon1, lat1, AZIMUTH = azimuth $ 
    106106 , RADIANS = radians, RADIUS = radius, MIDDLE = middle, TWO_BY_TWO = two_by_two 
    107107 

  • trunk/SRC/Interpolation/neighbor.pro

    r231 r238  
    22; 
    33; @file_comments 
    4 ; find the closetest point of (P0) within a list of np1 points 
    5 ; P1 Which can be on a sphere 
     4; find the closest point of (P0) within a list of np1 points 
     5; P1 which can be on a sphere 
    66; 
    77; @categories 
    … …  
    2525; variable dis. 
    2626; 
    27 ; @keyword SPHERE to activate if points are located on a sphere. 
     27; @keyword SPHERE 
     28; to activate if points are located on a sphere. 
    2829; 
    2930; @returns 

  • trunk/SRC/Interpolation/quadrilateral2square.pro

    r231 r238  
    4141; 
    4242; @returns 
    43 ; 
    4443; (2,n) array: the new coordinates (xout, yout) of the (xin,yin) point(s) after 
    4544; mapping. 

  • trunk/SRC/Interpolation/spl_fstdrv.pro

    r231 r238  
    22; 
    33; @file_comments 
    4 ; SPL_FSTDRV returns the values of the first derivative of 
     4; returns the values of the first derivative of 
    55; the interpolating function at the points X2i. It is a double 
    66; precision array. 
    … …  
    88; Given the arrays X and Y, which tabulate a function (with the X[i] 
    99; AND Y[i] in ascending order), and given an input value X2, the 
    10 ; SPL_INCR function returns an interpolated value for the given values 
    11 ; of X2. The interpolation method is based on cubic spline, corrected 
    12 ; in a way that interpolated value are also in ascending order 
     10; <pro>spl_incr</pro> function returns an interpolated value for the given 
     11; values of X2. The interpolation method is based on cubic spline, corrected 
     12; in a way that interpolated value are also in ascending order. 
    1313; 
    1414; @examples 
    … …  
    2424; 
    2525; @param yscd {in}{required} 
    26 ; The output from SPL_INIT for the specified X and Y. 
     26; The output from <proidl>SPL_INIT</pro> for the specified X and Y. 
    2727; 
    2828; @param x2 {in}{required} 
    … …  
    4343FUNCTION spl_fstdrv, x, y, yscd, x2 
    4444; 
     45  compile_opt idl2, strictarrsubs 
     46; 
    4547; compute the first derivative of the spline function 
    46 ; 
    47   compile_opt idl2, strictarrsubs 
    4848; 
    4949  nx = n_elements(x) 
    … …  
    8181  RETURN, yfrst 
    8282END 
    83  

  • trunk/SRC/Interpolation/spl_incr.pro

    r231 r238  
    55; Given the arrays X and Y, which tabulate a function (with the X[i] 
    66; AND Y[i] in ascending order), and given an input value X2, the 
    7 ; SPL_INCR function returns an interpolated value for the given values 
     7; spl_incr function returns an interpolated value for the given values 
    88; of X2. The interpolation method is based on cubic spline, corrected 
    99; in a way that interpolated values are also monotonically increasing. 
    … …  
    6565; 
    6666FUNCTION pure_concave, x1, x2, y1, y2, der2, x 
     67; 
     68  compile_opt idl2, strictarrsubs 
     69; 
    6770; X^n type 
    68 ; 
    69   compile_opt idl2, strictarrsubs 
    7071; 
    7172  xx = (double(x)-double(x1))/(double(x2)-double(x1)) 
    … …  
    8283  RETURN, res 
    8384END 
    84  
     85; 
    8586;+ 
     87; 
    8688; @param x1 {in}{required} 
    8789; An n-element (at least 2) input vector that specifies the tabulate points in 
    … …  
    102104; 
    103105;- 
     106; 
    104107FUNCTION pure_convex, x1, x2, y1, y2, der2, x 
     108; 
     109  compile_opt idl2, strictarrsubs 
     110; 
    105111; 1-(1-X)^n type 
    106 ; 
    107   compile_opt idl2, strictarrsubs 
    108112; 
    109113  xx = 1.0d - (double(x)-double(x1))/(double(x2)-double(x1)) 
    … …  
    121125  RETURN, res 
    122126END 
    123  
     127; 
    124128;+ 
     129; 
    125130; @param x 
    126131; @param y 
    127132; @param x2 
    128 ; @keyword YP0 The first derivative of the interpolating function at the 
     133; @keyword YP0 
     134; The first derivative of the interpolating function at the 
    129135;    point X0. If YP0 is omitted, the second derivative at the 
    130136;    boundary is set to zero, resulting in a "natural spline." 
    131 ; @keyword YPN_1 The first derivative of the interpolating function at the 
     137; @keyword YPN_1 
     138; The first derivative of the interpolating function at the 
    132139;    point Xn-1. If YPN_1 is omitted, the second derivative at the 
    133140;    boundary is set to zero, resulting in a "natural spline." 
    134141;- 
     142; 
    135143FUNCTION spl_incr, x, y, x2, YP0 = yp0, YPN_1 = ypn_1 
    136144; 
    … …  
    515523  RETURN, y2 
    516524; 
    517 ;------------------------------------------------------------------ 
    518 ;------------------------------------------------------------------ 
    519 ; 
    520525END 

  • trunk/SRC/Interpolation/spl_keep_mean.pro

    r232 r238  
    55; Given the arrays X and Y, which tabulate a function (with the X[i] 
    66; AND Y[i] in ascending order), and given an input value X2, the 
    7 ; SPL_INCR function returns an interpolated value for the given values 
     7; spl_incr function returns an interpolated value for the given values 
    88; of X2. The interpolation method is based on cubic spline, corrected 
    99; in a way that integral of the interpolated values is the same as the 
    … …  
    129129;  yfrst = 0.0d > temporary(yfrst) 
    130130  RETURN, yfrst 
    131  
    132 ;------------------------------------------------------------------ 
    133 ;------------------------------------------------------------------ 
    134131; 
    135132 END 

  • trunk/SRC/Interpolation/square2quadrilateral.pro

    r231 r238  
    2727; Can be scalar or array. 
    2828; (x0,y0), (x1,y1), (x2,y2) and (x3,y3) are given in the anticlockwise order. 
    29 ; 
    3029; 
    3130; @param xxin {in}{optional} 
    … …  
    7372; page 54 of Wolberg's book, see figure 3.7 page 56 for the good 
    7473; definition. 
    75 ; 
    7674; 
    7775  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Matrix/cmapply.pro

    r237 r238  
    66; @param X 
    77; 
    8 ; @version  
     8; @version 
    99; $Id$ 
    1010; 
    … …  
    120120; 
    121121;   It's worth noting however, that the implementation of user-defined 
    122 ;   functions is not particularly optimized for speed.  Users are 
     122;   functions is not particularly optimized for speed. Users are 
    123123;   encouraged to implement their own array if the number of output 
    124124;   elements is large. 
    125125; 
    126 ; @categories  
     126; @categories 
    127127; Array 
    128128; 
    … …  
    134134; the user-defined function. 
    135135; 
    136 ; @param ARRAY {in}{required}{type=array}  
     136; @param ARRAY {in}{required}{type=array} 
    137137; An array of values to be operated on. 
    138138; Must not be of type STRING (7) or STRUCTURE (8). 
    … …  
    140140; @param dimapply {in}{optional}{default=1 (ie, first dimension)}{type=array} 
    141141; An array of dimensions that are to be "collapsed", where 
    142 ; the the first dimension starts with 1 (ie, same convention 
     142; the first dimension starts with 1 (ie, same convention 
    143143; as IDL function TOTAL).  Whereas TOTAL only allows one 
    144144; dimension to be added, you can specify multiple dimensions 
    … …  
    155155; @keyword TYPE {default=same as input type} 
    156156; Set this to the IDL code of the desired output type (refer 
    157 ; to documentation of SIZE()).  Internal results will be 
     157; to documentation of <proidl>SIZE</proidl>()).  Internal results will be 
    158158; rounded to the nearest integer if the output type is an 
    159159; integer type. 
    … …  
    214214;   (OUT[i,j] is the median value of IN[i,j,*]) 
    215215; 
    216 ; @history  
     216; @history 
    217217; Mar 1998, Written, CM 
    218218;   Changed usage message to not bomb, 24 Mar 2000, CM 
    … …  
    229229;  craigm\@lheamail.gsfc.nasa.gov 
    230230; 
    231 ; @version  
     231; @version 
    232232; $Id$ 
    233233; 

  • trunk/SRC/Matrix/cmset_op.pro

    r237 r238  
    6969;   benefit. 
    7070; 
    71 ; @categories  
     71; @categories 
    7272; Array 
    7373; 
    … …  
    131131;  SET_UTILS.PRO by RSI 
    132132; 
    133 ; @history  
     133; @history 
    134134; Written, CM, 23 Feb 2000 
    135135;   Added empty set capability, CM, 25 Feb 2000 
    … …  
    163163;   craigm\@lheamail.gsfc.nasa.gov 
    164164; 
    165 ; @version  
     165; @version 
    166166; $Id$ 
    167167; 

  • trunk/SRC/Matrix/extrac2.pro

    r231 r238  
    2929;            20      22 
    3030; 
    31 ; @categories  
     31; @categories 
    3232; Utilities 
    3333; 
    … …  
    5858; I have a dim 2 matrix named A. I want extract a small intersection 
    5959; matrix 2d of the line 2,3 and 7 and of the column 0 and 1: 
    60 ;  
     60; 
    6161; IDL> res=extrac2(A,[2,3,7],[0,1]) 
    6262; 
    … …  
    7070; g i 
    7171; 
    72 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     72; @history 
     73; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    7374;                       12/1/1999 
    7475;                       29/4/1999: correction of a bug and complement of the heading 
    7576; 
    76 ; @version $Id$ 
     77; @version 
     78; $Id$ 
    7779; 
    7880;- 

  • trunk/SRC/Obsolete/common.pro

    r232 r238  
    77; 
    88;- 
    9  
     9; 
    1010@all_cm 

  • trunk/SRC/Obsolete/congridseb.pro

    r232 r238  
    3939; an array which dimensions are x,y 
    4040; 
    41 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     41; @history 
     42; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4243;                      20/3/98 
    4344;                      18/6/1999 supression d''une horrible boucle 
    4445; 
    45 ; @version $Id$ 
     46; @version 
     47; $Id$ 
    4648; 
    4749;- 
    4850; 
    49 function congridseb, tableau, x, y 
     51FUNCTION congridseb, tableau, x, y 
    5052; 
    5153  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Obsolete/extrait.pro

    r231 r238  
    7373; g i 
    7474; 
    75 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     75; @history 
     76; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    7677; 12/1/1999 
    7778; 29/4/1999: correction of a bug and complement of the heading 
    7879; 
    79 ; @version $Id$ 
     80; @version 
     81; $Id$ 
    8082; 
    8183;- 

  • trunk/SRC/Obsolete/fictype.pro

    r232 r238  
    1616; IDL> fictype = fictype(930124) 
    1717; 
    18 ; @history  
     18; @history 
    1919; Jerome Vialard  (jv\@lodyc.jussieu.fr) 
    2020; 2/7/98 
    2121; 
    22 ; @version  
     22; @version 
    2323; $Id$ 
    2424; 

  • trunk/SRC/Obsolete/nlecan.pro

    r232 r238  
    66; 
    77; @obsolete 
    8 ; @categories  
     8; @categories 
    99; Reading 
    1010; 
    … …  
    1212; IDL> res=nlecan(nom, numsortie79, nbretps) 
    1313; 
    14 ; @param nom {in}{required}  
     14; @param nom {in}{required} 
    1515; nom du tableau contenant le champ que l'on veut (le 
    1616; trouver avec ncdflec,fichier,/var 
    1717; 
    18 ; @param numsortie79 {in}{required}  
     18; @param numsortie79 {in}{required} 
    1919; le numero du pas de temps que l'on veut sortir du 
    2020; fichier (compte a partir de 1) a partir de 79 
    2121; 
    22 ; @param nbretps {in}{required}  
     22; @param nbretps {in}{required} 
    2323; nombre de pas de temps a extraire 
    2424; 
    25 ; @keyword BOITE   
     25; @keyword BOITE 
    2626; boite sur laquelle integrer (par defaut tt le domaine) 
    2727; 
    28 ; @keyword GRILLE  
     28; @keyword GRILLE 
    2929; impose la grille a laquelle est rapporte le champ. rq permet 
    3030; d'aller plus vite ds la lecture 
    3131; 
    32 ; @keyword TOUT  
     32; @keyword TOUT 
    3333; oblige a lire le tableau entier en non pas celui reduit a domdef 
    3434; 
    35 ; @keyword _EXTRA  
     35; @keyword _EXTRA 
    3636; Used to pass keywords 
    3737; 
    38 ; @returns  
     38; @returns 
    3939; tableau 2d (qd la serie ne fait que 1 pas de temps) ou 
    4040; 3d (valable ds 1 premier tps que pour les tableaux 2d) 
    4141; 
    42 ; @uses  
     42; @uses 
    4343; common.pro 
    4444; 
    45 ; @restrictions  
     45; @restrictions 
    4646; appele par <pro>nlec</pro> 
    4747; 
    48 ; @history  
     48; @history 
    4949; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    5050; 
    51 ; @version  
     51; @version 
    5252; $Id$ 
    5353; 

  • trunk/SRC/Postscript/closeps.pro

    r232 r238  
    1313; that we have to destroy at the end of closeps (when the postscript is done). 
    1414; 
    15 ; @uses  
     15; @uses 
    1616; cm_4ps 
    1717; 

  • trunk/SRC/Postscript/openps.pro

    r232 r238  
    3838; Used to pass keywords to <proidl>device</proidl>. 
    3939; 
    40 ; @uses  
     40; @uses 
    4141; cm_4ps 
    4242; 
    43 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     43; @history 
     44; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4445; 21/12/98 
    4546; 1/2/98: ajout de nameps en input 
    … …  
    5253;- 
    5354; 
    54 pro openps, namepsin, FILENAME = filename, INFOWIDGET = infowidget $ 
     55PRO openps, namepsin, FILENAME = filename, INFOWIDGET = infowidget $ 
    5556            , KEEPPFONT = keeppfont, KEEP_PFONT = keep_pfont $ 
    5657            , PORTRAIT = portrait, LANDSCAPE = landscape $ 

  • trunk/SRC/ReadWrite/ncdf_timeget.pro

    r232 r238  
    55; Julian days of IDL. 
    66; 
    7 ; @categories  
     7; @categories 
    88; Reading 
    99; 
    … …  
    3434; time_counter:units = "years since 1979-01-01 00:00:00" ; 
    3535; 
    36 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     36; @history 
     37; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3738;                      June 2001 
    38 ; @version $Id$ 
     39; @version 
     40; $Id$ 
    3941;- 
    4042; 

  • trunk/SRC/ReadWrite/read_oasis.pro

    r236 r238  
    77; Reading 
    88; 
    9 ; @param FILENAME {in}{required}  
     9; @param FILENAME {in}{required} 
    1010; the filename 
    1111; 
    12 ; @param VARNAME {in}{required}  
     12; @param VARNAME {in}{required} 
    1313; the name of the variable to be read 
    1414; 
    … …  
    2424; to change the default format (R8) of the data to be read. 
    2525; 
    26 ; @returns a 2d array 
     26; @returns 
     27; a 2d array 
    2728; 
    2829; @examples 
    … …  
    3233; see also IDL> scanoasis,'grids_orca_t106' 
    3334; 
    34 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     35; @history 
     36; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3537;                      July 01, 2002 
    36 ; @version $Id$ 
     38; @version 
     39; $Id$ 
     40; 
    3741;- 
    3842; 

  • trunk/SRC/ReadWrite/readbat.pro

    r236 r238  
    1212; @keyword ZERO to put 0 on land instead of negatives values for the islands. 
    1313; 
    14 ; @returns a 2d array 
     14; @returns 
     15; a 2d array 
    1516; 
    16 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     17; @history 
     18; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1719;                      May 31, 2002 
    1820;    based on batlec2.pro, written by Maurice Imbard, March 17, 1998 
    1921; 
    20 ; @version $Id$ 
     22; @version 
     23;  $Id$ 
    2124; 
    2225;- 

  • trunk/SRC/ReadWrite/readoldopadistcoast.pro

    r236 r238  
    66; based on the OPA subroutines dtacof and parctl 
    77; 
    8 ; @categories  
     8; @categories 
    99; For OPA 
    1010; 
    1111; @param UNIT 
    1212; 
     13; @param PARAMS 
    1314; 
    14 ; @param PARAMS 
    15 ;  
    16 ;  
    1715; @param NUM 
    18 ;  
    1916; 
    20 ; @returns   
     17; @returns 
    2118; a structure that contains two elements: tdistcoast (the 
    2219; distance for the t-points) and fdiscoast (the distance for the 
    2320; f-points). 
    2421; 
    25 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     22; @history 
     23; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2624;                      June, 2002 
    27 ; @version $Id$ 
     25; @version 
     26; $Id$ 
     27; 
    2828;- 
    2929; 
    … …  
    3737   return, b 
    3838end 
    39  
     39; 
    4040;+ 
     41; 
    4142; @file_comments 
    42 ; 
    4343; 
    4444; @categories 
    … …  
    5050; @param JPIGLO {in}{required} 
    5151; 
    52 ; 
    5352; @param JPJGLO {in}{required} 
    54 ; 
    5553; 
    5654; @param JPK {in}{required} 
    … …  
    5957; @keyword IBLOC {default=4096L} 
    6058; Ibloc size 
    61 ;  
     59; 
    6260; @keyword JPBYT {default=8L} 
    6361; Jpbyt size 
    64 ;  
     62; 
    6563; @keyword NUMREC {default=19L*jpk} 
    6664; Number of records in the file. 
    … …  
    7270; @version 
    7371; $Id$ 
     72; 
    7473;- 
     74; 
    7575FUNCTION readoldopadistcoast, filename, jpiglo, jpjglo, jpk, IBLOC = ibloc, JPBYT = jpbyt, NUMREC = numrec 
    7676; 

  • trunk/SRC/ReadWrite/scanctl.pro

    r237 r238  
    3232; @param xyheader 
    3333; 
    34 ; @keyword VARFMT  
     34; @keyword VARFMT 
    3535; 
    3636; @keyword _EXTRA 
    3737; 
    38 ; @version  
     38; @version 
    3939; $Id$ 
    4040; 

  • trunk/SRC/ReadWrite/scanoasis.pro

    r236 r238  
    66; @categories know what is inside 
    77; 
    8 ; @param FILENAME {in}{required}  
     8; @param FILENAME {in}{required} 
    99; The file name 
    1010; 
    11 ; @restrictions  
     11; @restrictions 
    1212; List the variable names included in a Oasis file 
    1313; 
    … …  
    1515; IDL> scanoasis,'grids_orca_t106' 
    1616; 
    17 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     17; @history 
     18; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1819;                            July 01, 2002 
    19 ; @version $Id$ 
     20; @version 
     21; $Id$ 
     22; 
    2023;- 
    2124; 

  • trunk/SRC/ReadWrite/write_oasis.pro

    r236 r238  
    44; write an Oasis file (version < 2.5) 
    55; 
    6 ; @param FILENAME {in}{required}  
     6; @param FILENAME {in}{required} 
    77; the filename 
    88; 
    9 ; @param VARNAME {in}{required}  
     9; @param VARNAME {in}{required} 
    1010; the name of the variable to be written 
    1111; 
    12 ; @param Z2D {in}{required}  
     12; @param Z2D {in}{required} 
    1313; the variable (2D array) to be written 
    1414; 
    … …  
    1919; to change the default format (R8) of the data to be written. 
    2020; 
    21 ; @keyword APPEND  
    22 ; to open the file with the file pointer at the end of the file, ready for  
     21; @keyword APPEND 
     22; to open the file with the file pointer at the end of the file, ready for 
    2323; data to be appended. 
    2424; 
    25 ; @restrictions  
     25; @restrictions 
    2626; varname is automatically written as a "character*8" 
    2727; by default z2d is written as an R8 array 
    2828; 
    29 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     29; @history 
     30; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3031;                      July 01, 2002 
    31 ; @version $Id$ 
     32; @version 
     33; $Id$ 
     34; 
    3235;- 
    3336; 
    … …  
    4245      return 
    4346   endif 
    44     
     47 
    4548   writeu, unit, string(varname, format='(a8)') 
    4649   case 1 of 

  • trunk/SRC/ReadWrite/writebat.pro

    r236 r238  
    44; write the bathymetry ASCII file of OPA 
    55; 
    6 ; @categories  
     6; @categories 
    77; For OPA 
    88; 
    9 ; @param ZBAT {in}{required}  
     9; @param ZBAT {in}{required} 
    1010; the bathymetry, a 2d array 
    1111; 
    … …  
    1313; It contains the filename 
    1414; 
    15 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     15; @history 
     16;  Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1617;                      Sept 30, 2003 
    1718;    based on batsav2.pro, written by Maurice Imbard, March 17, 1998 
    1819; 
    19 ; @version $Id$ 
     20; @version 
     21; $Id$ 
     22; 
    2023;- 
    2124; 

  • trunk/SRC/Tests/TestsOld/tst_plt_old.pro

    r237 r238  
    44; 
    55; @categories 
    6 ;  
     6; 
    77; @keyword IMAGE 
    88; 
    … …  
    1010; Sebastien Masson 
    1111; 
    12 ; @version  
     12; @version 
    1313; $Id$ 
    1414; 

  • trunk/SRC/ToBeReviewed/CALCULS/hdyn.pro

    r231 r238  
    3737; Give a depth to this keyword which will be considered as the reference depth 
    3838; (in this case, LEVEL has not any effect). the calculation will be effectuated 
    39 ; until this depth effecting an interpolation between the the last W level above 
     39; until this depth effecting an interpolation between the last W level above 
    4040; PROFREF and PROFREF. 
    4141; 

  • trunk/SRC/ToBeReviewed/CALCULS/remplit.pro

    r232 r238  
    231231; 
    232232    z[coast] =  temporary(zcoast)/ temporary(weight) 
    233 ; we update the the boundary conditions of z 
     233; we update the boundary conditions of z 
    234234    if keyword_set(key_periodic) AND nx EQ jpi then begin 
    235235      z[0, *] = z[nx, *] 

  • trunk/SRC/ToBeReviewed/IMAGE/animgif.pro

    r157 r238  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    6 ; @file_comments  
     3; @file_comments 
    74; Build a gif animation 
    85; 
    9 ; @categories  
     6; @categories 
    107; Animated drawings. 
    118; 
    12 ; @param NOMFIC {in}{required}  
     9; @param NOMFIC {in}{required} 
    1310; It is the name of the gif file containing the animation. 
    1411;          Comment: this file is placed in the directory defined by iodir. 
    1512; 
    16 ; @uses  
     13; @uses 
    1714; common.pro 
    1815; 
    19 ; @restrictions  
     16; @restrictions 
    2017; We use the Z buffer to go faster!. 
    2118;              So, if it failed in animgif, you have to do: 
    … …  
    2421;              IDL> retall 
    2522; 
    26 ; @restrictions  
     23; @restrictions 
    2724; If we want to delete the \@common, 
    28 ;               we have to define manually the picture's size  
     25;               we have to define manually the picture's size 
    2926;               (variables xsize and ysize) just as iodir. 
    3027; 
    31 ; @history  
     28; @history 
    3229; Guillaume Roullet (grlod\@ipsl.jussieu.fr) 
    3330;          Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3431;          30/4/1999 
    3532; 
    36 ; @version  
     33; @version 
    3734; $Id$ 
    3835; 
    3936;- 
    40 ;------------------------------------------------------------ 
    41 ;------------------------------------------------------------ 
    42 ;------------------------------------------------------------ 
     37; 
    4338PRO animgif, nomfic 
    4439; 
    … …  
    5348;  It completes the current palette on 256 colors. 
    5449; 
    55    red = [rouge, replicate(255, 256-n_elements(rouge))]  
    56    green = [vert, replicate(255, 256-n_elements(rouge))]  
    57    blue = [bleu, replicate(255, 256-n_elements(rouge))]  
     50   red = [rouge, replicate(255, 256-n_elements(rouge))] 
     51   green = [vert, replicate(255, 256-n_elements(rouge))] 
     52   blue = [bleu, replicate(255, 256-n_elements(rouge))] 
    5853; 
    5954; It rocks on the z device, allowing to create the picture without display it. 
    … …  
    6762   device, set_resolution = [xsize, ysize] 
    6863; 
    69 ; Beginning of the gif file. Writing of an empty picture.  
     64; Beginning of the gif file. Writing of an empty picture. 
    7065; 
    7166   reinitplt 
    … …  
    8075; Loop of picture's creation. 
    8176; 
    82    calen = TIMEGEN(366, START=JULDAY(1,1,2000))  
     77   calen = TIMEGEN(366, START=JULDAY(1,1,2000)) 
    8378   debut = where(calen EQ 19810105) 
    8479   debut = where(calen EQ 19790105) 
    … …  
    10398;      plt, nlec('sss', date, 'ATF'), label = 2, /noerase 
    10499;      plt, nlec('htoth', date, 'RE3')-nlec('hpycn', date, 'RE3'), 10, 60, int = 5, /inv, /noerase 
    105 ;      domdef, 290,340,-5,15  
     100;      domdef, 290,340,-5,15 
    106101;      plt, norme(nlec('unsurf', date, 'RE3'), nlec('vnsurf', date, 'RE3')), 0, 1.2, int = .1, /noerase 
    107102; 
    … …  
    109104; 
    110105      write_gif,iodir+nomfic,tvrd(),red, green, blue, /multiple 
    111    ENDFOR  
     106   ENDFOR 
    112107;---------------------------------------------------------------- 
    113108; End of the part we want to change. 
    … …  
    115110; 
    116111; Closing of the file. 
    117    write_gif,iodir+nomfic,/close  
     112   write_gif,iodir+nomfic,/close 
    118113; Rerock on terminal X mode. 
    119114;   device, /close 

  • trunk/SRC/ToBeReviewed/INIT/initncdf.pro

    r236 r238  
    139139    zvarid = (where(namevar EQ 'nav_lev' or namevar EQ zaxisname OR namevar EQ 'level' OR namevar EQ 'lev' OR strmid(namevar, 0, 5) EQ 'depth'))[0] 
    140140    if zvarid EQ -1 AND inside.ndims GT 3 then begin 
    141       ras = report( 'initncdf: the zaxis was not found..., check the the use of ZAXISNAME keyword if you whant to find one...') 
     141      ras = report( 'initncdf: the zaxis was not found..., check the use of ZAXISNAME keyword if you whant to find one...') 
    142142;     stop 
    143143    endif 

  • trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro

    r231 r238  
    6969; 
    7070; @keyword ZETAFILENAME {default=FILENAME}{type=string} 
    71 ; For ROMS outputs. The filename of the file where zeta vriable should be read 
     71; For ROMS outputs. The filename of the file where zeta variable should be read 
    7272; 
    7373; @keyword ZETAZERO {default=0}{type=scalar: 0 or 1} 

  • trunk/SRC/ToBeReviewed/MATRICE/colle.pro

    r163 r238  
    11;+ 
    2 ; @file_comments  
    3 ; This concatenation function exist in IDL so long  
    4 ; as we do not try to stick with a dimension superior or equal at 4.   
     2; @file_comments 
     3; This concatenation function exist in IDL so long 
     4; as we do not try to stick with a dimension superior or equal at 4. 
    55; 
    6 ; @categories  
     6; @categories 
    77; Utilities 
    88; 
    … …  
    5252; force to save the pointer array and arrays to be stuck 
    5353; 
    54 ; @returns res=matrice resultat 
     54; @returns 
     55; matrice resultat 
    5556; 
    56 ; @examples IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)    
     57; @examples 
     58; IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2) 
    5759;                1       1 
    5860;                1       1 
    … …  
    6567;                6       7 
    6668; 
    67 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     69; @history 
     70; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    6871;                       13/1/98 
    6972; 
    70 ; @version $Id$ 
     73; @version 
     74; $Id$ 
    7175; 
    7276;- 
     77; 
    7378FUNCTION colle, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, SAUVE = sauve 
    7479; 
    … …  
    111116            res = [temporary(res), *ptrtab[n]] 
    112117            if NOT keyword_set(sauve) then ptr_free, ptrtab[n] 
    113          ENDFOR  
    114       END  
     118         ENDFOR 
     119      END 
    115120      2:BEGIN                   ; we paste following the dimension 2 
    116121         res = *ptrtab[0] 
    … …  
    119124            res = [[temporary(res)], [*ptrtab[n]]] 
    120125            if NOT keyword_set(sauve) then ptr_free, ptrtab[n] 
    121          ENDFOR  
    122       END  
     126         ENDFOR 
     127      END 
    123128      3:BEGIN                   ; we paste following the dimension 3 
    124129         res = *ptrtab[0] 
    … …  
    127132            res = [[[temporary(res)]], [[*ptrtab[n]]]] 
    128133            if NOT keyword_set(sauve) then ptr_free, ptrtab[n] 
    129          ENDFOR  
     134         ENDFOR 
    130135      END 
    131       ELSE:BEGIN  
     136      ELSE:BEGIN 
    132137; We transpose res in order to put the dimension to be pasted number 1 
    133 ; To this, we contain the permuter vector which give the place that dimension  
     138; To this, we contain the permuter vector which give the place that dimension 
    134139; in the transposed matrix must take. 
    135140        siz = (size(*ptrtab[0]))[0] 
    … …  
    143148         FOR n = 1,nbretab-1 DO BEGIN ; we paste following the dimension 1on colle suivant la dimension 1 
    144149            if (size(*ptrtab[n]))[0] LT direc then $ 
    145              *ptrtab[n] = reform(*ptrtab[n], [(size(*ptrtab[n]))[1:siz], replicate(1, direc-siz)])             
     150             *ptrtab[n] = reform(*ptrtab[n], [(size(*ptrtab[n]))[1:siz], replicate(1, direc-siz)]) 
    146151            res = [temporary(res), transpose(*ptrtab[n], permute)] 
    147152            if NOT keyword_set(sauve) then ptr_free, ptrtab[n] 
    … …  
    149154         res = transpose(temporary(res), permute) 
    150155      END 
    151    ENDCASE  
     156   ENDCASE 
    152157;------------------------------------------------------------ 
    153158   if NOT keyword_set(sauve) then undefine, ptrtab 
    154159sortie: 
    155160   return,  res 
    156  
    157     
    158 END  
    159   
    160 ;------------------------------------------------------------ 
     161END 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

    r237 r238  
    7979  return, report(['Error in "' + type + '" type plot with a 2D input array:' $ 
    8080                  , 'the array dimensions ' + tostr(sz[1:2]) + ' are incompatible' $ 
    81                   , 'with the the domain dimensions ' $ 
     81                  , 'with the domain dimensions ' $ 
    8282                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $ 
    8383                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $ 
    … …  
    125125  return, report(['Error in "' + type + '" type plot with a 3D input array:' $ 
    126126                  , 'the array dimensions ' + tostr(sz[1:3]) + ' are incompatible' $ 
    127                   , 'with the the domain dimensions ' $ 
     127                  , 'with the domain dimensions ' $ 
    128128                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $ 
    129129                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $ 

  • trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/velovect.pro

    r231 r238  
    1515; 
    1616; @param V {in}{required} 
    17 ; The Y component of the two dimensional field.  Y must have 
    18 ; the same dimensions as X.  The vector at point [i,j] has a 
     17; The Y component of the two dimensional field. Y must have 
     18; the same dimensions as X. The vector at point [i,j] has a 
    1919; magnitude of: 
    2020; 
    … …  
    2626; 
    2727; @param X {in}{optional}{type=vector} 
    28 ; Optional abscissa values.  X must be a vector with a length 
     28; Optional abscissa values. X must be a vector with a length 
    2929; equal to the first dimension of U and V. 
    3030; 
    3131; @param Y {in}{optional}{type=vector} 
    32 ; Optional ordinate values.  Y must be a vector with a length 
     32; Optional ordinate values. Y must be a vector with a length 
    3333; equal to the first dimension of U and V. 
    3434; 
    … …  
    3939; Set this keyword to 1 to place a dot at each missing point. 
    4040; Set this keyword to 0 or omit it to draw nothing for missing 
    41 ; points.  Has effect only if MISSING is specified. 
     41; points. Has effect only if MISSING is specified. 
    4242; 
    4343; @keyword LENGTH {default=1.0} 
    44 ; Length factor.  The default of 1.0 makes the longest (U,V) 
     44; Length factor. The default of 1.0 makes the longest (U,V) 
    4545; vector the length of a cell. 
    4646; 
    4747; @keyword MISSING 
    48 ;  Missing data value.  Vectors with a LENGTH greater 
     48;  Missing data value. Vectors with a LENGTH greater 
    4949; than MISSING are ignored. 
    5050; 
    5151; @keyword OVERPLOT 
    52 ; Set this keyword to make VELOVECT "overplot".  That is, the 
     52; Set this keyword to make VELOVECT "overplot". That is, the 
    5353; current graphics screen is not erased, no axes are drawn, and 
    5454; the previously established scaling remains in effect. 
    … …  
    6262; 
    6363; @restrictions 
    64 ; Plotting on the selected device is performed.  System 
     64; Plotting on the selected device is performed. System 
    6565; variables concerning plotting are changed. 
    6666; Note:   All other keywords are passed directly to the PLOT procedure 
    … …  
    7373;       Added TITLE, Oct, 1990. 
    7474;       Added POSITION, NOERASE, COLOR, Feb 91, RES. 
    75 ;       August, 1993.  Vince Patrick, Adv. Visualization Lab, U. of Maryland, 
     75;       August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland, 
    7676;               fixed errors in math. 
    7777;       August, 1993. DMS, Added _EXTRA keyword inheritance. 
    … …  
    8282;                        OPLOT to PLOTS. 
    8383;       September, 1996, GGS. Changed denominator of x_step and y_step vars. 
    84 ;       February, 1998, DLD.  Add support for CLIP and NO_CLIP keywords. 
    85 ;       June, 1998, DLD.  Add support for OVERPLOT keyword. 
     84;       February, 1998, DLD. Add support for CLIP and NO_CLIP keywords. 
     85;       June, 1998, DLD. Add support for OVERPLOT keyword. 
    8686; 
    87 ; Copyright (c) 1983-1998, Research Systems, Inc.  All rights reserved. 
     87; Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved. 
    8888;       Unauthorized reproduction prohibited. 
    8989; 

  • trunk/SRC/ToBeReviewed/POSTSCRIPT/ps.pro

    r232 r238  
    11;+ 
     2; 
    23; @file_comments 
    34; Redirect the content of the graphic window in a postscript,  
    … …  
    9091for i = 2, n_elements(vectjournal)-3 DO $ 
    9192printf,  !journal, vectjournal[i] 
    92  
    93 ;------------------------------------------------------------ 

  • trunk/SRC/ToBeReviewed/STRING/chkeywd.pro

    r232 r238  
    22; 
    33; @file_comments 
    4 ; In a string containing an order to execute with EXECUTE by example.  
     4; In a string containing an order to execute with EXECUTE by example. 
    55; We change the value of one of keywords. 
    66; More generally, in a string, we look for the character chain: ', keywdname= ..., 
    … …  
    1010; String, keywords 
    1111; 
    12 ;  
    1312; @param STRINGIN {in}{required}{type=string} 
    1413; it is a string 
    … …  
    1716; it is a string designating the name of keyword to look for. 
    1817; 
    19 ; @param KEYWDVALUE {in}{required}  
     18; @param KEYWDVALUE {in}{required} 
    2019; The new value of the keyword to considerate in STRINGIN 
    2120; 
    2221; @keyword SEPARATOR 
    23 ; To look for the keyword, we look for the first sign = which follow  
    24 ; the position of keywdname. By default, we substitute the string  
    25 ; before the comma. With the keyword SEPARATOR,we can modify the cut  
    26 ; of the string. SEPARATOR give a Character before the one we have to  
     22; To look for the keyword, we look for the first sign = which follow 
     23; the position of keywdname. By default, we substitute the string 
     24; before the comma. With the keyword SEPARATOR,we can modify the cut 
     25; of the string. SEPARATOR give a Character before the one we have to 
    2726; look for the comma which delimit the keyword in the string. 
    2827; (see examples) 
    2928; 
    3029; @keyword AFTER 
    31 ; To look for the keyword, we look for the first sign = which follow  
    32 ; the position of keywdname. By default, we substitute the string  
    33 ; before the comma. With the keyword AFTER,we can modify the cut  
    34 ; of the string. AFTER give a Character after the one we have to  
     30; To look for the keyword, we look for the first sign = which follow 
     31; the position of keywdname. By default, we substitute the string 
     32; before the comma. With the keyword AFTER,we can modify the cut 
     33; of the string. AFTER give a Character after the one we have to 
    3534; look for the comma which delimit the keyword in the string. 
    3635; (see examples) 
    3736; 
    38 ; @returns  
     37; @returns 
    3938; stringout=stringin modified if keywdname has been found in stringin 
    4039; 
    41 ; @uses  
     40; @uses 
    4241; common.pro 
    4342; 
    … …  
    4645; 
    4746; @restrictions 
    48 ; Beware, this function has loops, ifs ad cases everywhere. So it can  
    49 ; not be used by big keywords (with a lot of elements which are big  
    50 ; arrays). The input keyword must not contain Complex floatings, structure,  
    51 ; Double-precision complex, Pointer, Object reference, Unsigned Integer,  
     47; Beware, this function has loops, ifs ad cases everywhere. So it can 
     48; not be used by big keywords (with a lot of elements which are big 
     49; arrays). The input keyword must not contain Complex floatings, structure, 
     50; Double-precision complex, Pointer, Object reference, Unsigned Integer, 
    5251; Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer. 
    53 ;  
     52; 
    5453; 
    5554; @examples 
    … …  
    7271;                      18/10/1999 
    7372;                      24/11/1999: adaptation for keywords starting by / 
    74 ;  
     73; 
    7574; @version 
    7675; $Id$ 
    … …  
    9392         poskeywd = poskeywd+strlen(ajoute) 
    9493         poskeywd = strpos(stringout, keywdname, poskeywd) 
    95       ENDIF ELSE BEGIN  
     94      ENDIF ELSE BEGIN 
    9695; change a keyword sarting by toto= 
    9796         posegal = strpos(stringout, '=', poskeywd) 
    … …  
    107106; 
    108107         poskeywd = strpos(stringout, keywdname, posvirgule+1) 
    109       ENDELSE  
     108      ENDELSE 
    110109   endwhile 
    111110 

  • trunk/SRC/ToBeReviewed/STRING/strwhere.pro

    r232 r238  
    1313; the character to look for 
    1414; 
    15 ; @returns COUNT {out}{optional} 
    16 ; The number of matches that were found  
     15; @returns 
     16; The number of matches that were found 
    1717; 
    18 ;  The function returns an index array similar to the  
     18;  The function returns an index array similar to the 
    1919;  result of the where function 
    2020; 
    2121; @examples 
    22 ;       ind = strwhere('abcabcabc','a') 
    23 ; 
    24 ;        ; returns [ 0, 3, 6 ] 
     22; IDL> ind = strwhere('abcabcabc','a') 
     23; IDL> print, ind 
     24; [ 0, 3, 6 ] 
    2525; 
    2626; @history 
    2727;        mgs, 02 Jun 1998: VERSION 1.00 
    28 ;        bmy, 30 Jun 1998: - now returns COUNT, the number  
     28;        bmy, 30 Jun 1998: - now returns COUNT, the number 
    2929;                            of matches that are found (this is 
    3030;                            analogous to the WHERE command) 
    … …  
    4444; with subject "IDL routine strwhere" 
    4545; 
    46 function strwhere,str,schar,Count 
     46FUNCTION strwhere,str,schar,Count 
    4747; 
    4848  compile_opt idl2, strictarrsubs 
    4949; 
    50   
    51   
    5250   if (n_elements(str) eq 0) then return,-1 
    53   
     51 
    5452   ; convert to byte 
    5553   BStr = byte(Str) 
    5654   BSC  = (byte(schar))[0] 
    57   
     55 
    5856   ; Search for matches 
    5957   Ind = where( Bstr eq BSC, Count ) 
    … …  
    6361 
    6462end 
    65     

  • trunk/SRC/ToBeReviewed/UTILITAIRE/oups.pro

    r237 r238  
    11;+ 
    22; 
    3 ; @file_comments  
     3; @file_comments 
    44;       Kind of UNDO: 
    5 ;         Allows to redo all the chain of drawing since the opening of the last window without  
    6 ;         reexecute the last order Example: I do a drawing with 10 plot over it, if I make a  
     5;         Allows to redo all the chain of drawing since the opening of the last window without 
     6;         reexecute the last order Example: I do a drawing with 10 plot over it, if I make a 
    77;         mistake, I execute this program and i can redo the only plot missed. 
    88; 
    9 ; @categories  
     9; @categories 
    1010; utilities 
    1111; 
    12 ; @restrictions  
    13 ; compatible with \@<pro>ps</pro>  
     12; @restrictions 
     13; compatible with \@<pro>ps</pro> 
    1414; \@<pro>vzoom</pro> text_box... 
    1515; 
    16 ; @history  
     16; @history 
    1717; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1818; 
    19 ; @version  
     19; @version 
    2020; $Id$ 
    2121; 
    22 ; @todo  
     22; @todo 
    2323; seb 
    2424; 
    … …  
    6464 IF strpos(vectjournal[n_elements(vectjournal)-1],';,pos=[' ) NE -1 then $ 
    6565 vectjournal[n_elements(vectjournal)-2] = '' $ 
    66  ELSE vectjournal[n_elements(vectjournal)-1] = ''  
     66 ELSE vectjournal[n_elements(vectjournal)-1] = '' 
    6767; we rewrite idlsave.pro 
    6868 putfile, myuniquetmpdir+'idlsave.pro', vectjournal 
    … …  
    7070 path_cache, /rebuild 
    7171; apply idlsave 
    72 @idlsave    
    73 ; the journal has just been reopened, and we put elements of vectjournal in it.  
     72@idlsave 
     73; the journal has just been reopened, and we put elements of vectjournal in it. 
    7474for i = 0, n_elements(vectjournal)-1 DO $ 
    7575journal, vectjournal[i] 
    76        
    7776 
    7877 
     78 

  • trunk/SRC/ToBeReviewed/UTILITAIRE/vzoom.pro

    r232 r238  
    11;+ 
    22; 
    3 ; @file_comments  
    4 ; Make a real zoom in a plot, contrarly at the function  
     3; @file_comments 
     4; Make a real zoom in a plot, contrarly at the function 
    55; ZOOM prewritten by IDL which just get pixels bigger. 
    66; 
    7 ; @categories  
     7; @categories 
    88; utilities 
    99; 
    10 ; @restrictions  
     10; @restrictions 
    1111; use the journal. 
    12 ;  
     12; 
    1313; @history 
    1414; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1515;          29/4/1999 
    1616; 
    17 ; @version  
    18 ; $Id$  
     17; @version 
     18; $Id$ 
    1919; 
    2020; @todo 
    … …  
    6969   path_cache, /rebuild 
    7070; apply idlsave 
    71 @idlsave    
    72 ; the journal has just been reopened, and we put in elements of vectjournal.  
     71@idlsave 
     72; the journal has just been reopened, and we put in elements of vectjournal. 
    7373for i = 0, n_elements(vectjournal)-1 DO $ 
    7474journal, vectjournal[i] 
    75  
    76  
    77  

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.pro

    r232 r238  
    224224; 
    225225; now we try to find the attribut called calendar... 
    226 ; the the attribute "calendar" exists? 
     226; the attribute "calendar" exists? 
    227227; If no, we suppose that the calendar is gregorian calendar 
    228228; 

  • trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slide_slice.pro

    r232 r238  
    22; 
    33; @file_comments 
    4 ; 
    54; 
    65; @categories 

  • trunk/SRC/ToBeReviewed/WIDGET/slec.pro

    r231 r238  
    2424;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    2525;   6 elements: The extraction is made on Boxzoom 
    26 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     26; where lon1,lon2,lat1,lat2 are global variables defined at the last domdef! 
    2727; 
    2828; @keyword _EXTRA 
    … …  
    4848; 
    4949FUNCTION slec,name,debut,fin, nomexp, PARENT = parent, BOXZOOM=boxzoom, _EXTRA = ex 
    50 ;--------------------------------------------------------- 
    5150; 
    5251  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Utilities/find.pro

    r232 r238  
    99; all file_search keywords can be used. 
    1010; 
    11 ; @categories  
     11; @categories 
    1212; find a file 
    1313; 
    14 ; @param FILEIN {in}{required}  
     14; @param FILEIN {in}{required} 
    1515; A scalar or array variable of string type, containing 
    1616; file names to match. Input names specifications may contain 
    … …  
    2020; completed with '.pro' 
    2121; 
    22 ; @keyword FIRSTFOUND  
     22; @keyword FIRSTFOUND 
    2323; activate this keyword to stop looking for the file as soon as we found one. 
    2424; 
    25 ; @keyword IODIRECTORY {default=['.',!path]}  
     25; @keyword IODIRECTORY {default=['.',!path]} 
    2626; A scalar or array variable of string type, containing 
    2727; directories names where we are looking for the file. 
    … …  
    3232; keyword is not taken into account. 
    3333; 
    34 ; @keyword LOOKALLDIR  
     34; @keyword LOOKALLDIR 
    3535; activate to look for the file (with a recursive search if needed) 
    3636; in . iodir, homedir, !path + the DATA:TestsData directory if it exists. 
    3737; 
    38 ; @keyword NOPRO  
     38; @keyword NOPRO 
    3939; activate to avoid the automatic search of filename completed with '.pro' 
    4040; 
    41 ; @keyword ONLYPRO  
     41; @keyword ONLYPRO 
    4242; force to look only at file ending with .pro 
    4343; 
    44 ; @keyword ONLYNC  
     44; @keyword ONLYNC 
    4545; force to look only at file ending with .nc 
    4646; 
    47 ; @keyword RECURSIVE  
     47; @keyword RECURSIVE 
    4848; performs recursive searching of directory hierarchies. 
    4949; In a recursive search, find looks recursively for any and all 
    5050; subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    5151; 
    52 ; @keyword REPERTOIRE  
     52; @keyword REPERTOIRE 
    5353; obsolete. keep for compatibility, use directory keyword 
    5454; 
    55 ; @keyword UNIQUE  
     55; @keyword UNIQUE 
    5656; activate to make sure that each element of the output vector is unique. 
    5757; 
    58 ; @keyword TRYFIND  
     58; @keyword TRYFIND 
    5959; if the file was not found and this keyword is activated, find will call 
    6060; itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find 
    6161; the file we are looking for. Note that if the file was found at the 
    62 ; first try this keyword as no effect (which is not the case with LOOKALLDIR)  
     62; first try this keyword as no effect (which is not the case with LOOKALLDIR) 
    6363; 
    64 ; @keyword _EXTRA  
     64; @keyword _EXTRA 
    6565; Used to pass keywords 
    6666; 
    67 ; @returns  
     67; @returns 
    6868; A scalar or array variable of string type, containing the 
    6969; name (with the full path of the matching files. If no files 

  • trunk/SRC/Utilities/fitintobox.pro

    r231 r238  
    4747    RETURN, report(['Error: ' $ 
    4848                  , 'the vector size (' + tostr(sz) + ') is incompatible' $ 
    49                   , 'with the the domain dimensions ' $ 
     49                  , 'with the domain dimensions ' $ 
    5050                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $ 
    5151                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $ 
    … …  
    5555  RETURN, report(['Error: ' $ 
    5656                  , 'the array dimensions ' + tostr(sz) + ' are incompatible' $ 
    57                   , 'with the the domain dimensions ' $ 
     57                  , 'with the domain dimensions ' $ 
    5858                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $ 
    5959                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $ 
    … …  
    9797; or -1 if there is an error... 
    9898; 
    99 ; @uses  
     99; @uses 
    100100; cm_4mesh 
    101101; cm_4cal 
    … …  
    107107; Error: 
    108108; the array dimensions [180,148,78] are incompatible 
    109 ; with the the domain dimensions 
     109; with the domain dimensions 
    110110; [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] 
    111111; <Expression>    INT       =       -1 
    … …  
    118118; @version 
    119119; $Id$ 
     120; 
    120121;- 
    121122; 
Note: See TracChangeset for help on using the changeset viewer.