Changeset 224 for trunk


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

improvements/corrections of some *.pro headers

Location:
trunk/SRC
Files:
23 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ReadWrite/ncdf_getaxis.pro

    r221 r224  
    2525; 
    2626; @keyword START1 {default=0}{type=scalar: 0 or 1} 
    27 ; Index the axis from 1 instead of 0 when using /xyindex  
    28 ; 
    29 ; @keyword XDIRNAME {default='longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'}{type=scalar string} 
     27; Index the axis from 1 instead of 0 when using /xyindex 
     28; 
     29; @keyword XDIMNAME {default='longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'}{type=scalar string} 
    3030; A string giving the name of the x dimension 
    31 ;       
    32 ; @keyword YDIRNAME {default='latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'}{type=scalar string} 
     31; 
     32; @keyword YDIMNAME {default='latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'}{type=scalar string} 
    3333; A string giving the name of the y dimension 
    34 ;       
     34; 
    3535; @keyword XAXISNAME {default='x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'}{type=scalar string} 
    36 ; A string giving the name of the variable in the file  
    37 ; that contains the [xyz]axis.  
    38 ;       
     36; A string giving the name of the variable in the file 
     37; that contains the [xyz]axis. 
     38; 
    3939; @keyword YAXISNAME {default='y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'}{type=scalar string} 
    40 ; A string giving the name of the variable in the file  
    41 ; that contains the [xyz]axis.  
     40; A string giving the name of the variable in the file 
     41; that contains the [xyz]axis. 
    4242; 
    4343; @keyword XYINDEX {default=0}{type=scalar: 0 or 1} 
    4444; To define the x/y axis with index instead of using 
    45 ; the values contained in X/YAXISNAME.  
    46 ; x/yaxis = keyword_set(start1) + findgen(jpi/jpj)  
     45; the values contained in X/YAXISNAME. 
     46; x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 
    4747; 
    4848; @keyword XYINDEX {default=0}{type=scalar: 0 or 1} 
    … …  
    7272  namedim = strarr(inside.ndims) 
    7373  for dimiq = 0, inside.ndims-1 do begin 
    74     ncdf_diminq, cdfid, dimiq, tmpname, value  
     74    ncdf_diminq, cdfid, dimiq, tmpname, value 
    7575    namedim[dimiq] = strlowcase(tmpname) 
    7676  ENDFOR 
    … …  
    8989                  OR namevar EQ 'nav_lon' OR namevar EQ 'lon' $ 
    9090                  OR namevar EQ 'lon_rho' OR namevar EQ 'nblongitudes'))[0] 
    91 ; no xaxis variable found, we will build a fake xaxis based on the size of the x dimension  
     91; no xaxis variable found, we will build a fake xaxis based on the size of the x dimension 
    9292; -> we must find the x dimension 
    9393  IF xvarid EQ -1 THEN BEGIN 
    … …  
    124124      ENDCASE 
    125125    ENDIF 
    126     romsgrid = 0b    
    127   ENDIF ELSE BEGIN  
     126    romsgrid = 0b 
     127  ENDIF ELSE BEGIN 
    128128    romsgrid = strmid(namevar[xvarid], 0, 4) EQ 'lon_' 
    129129    xinq = ncdf_varinq(cdfid, xvarid) 
    … …  
    135135    ncdf_diminq, cdfid, dimidx, blabla, jpifromx 
    136136; should we read or compute the xaxis? 
    137     IF keyword_set(xyindex) OR xvarid EQ -1 THEN BEGIN  
     137    IF keyword_set(xyindex) OR xvarid EQ -1 THEN BEGIN 
    138138      xaxis = keyword_set(start1) + findgen(jpifromx) 
    139139      xyindex = 1 
    … …  
    143143; make sure of the shape of xaxis 
    144144      IF n_elements(jpjfromx) NE 0 THEN xaxis = reform(xaxis, jpifromx, jpjfromx, /over) 
    145     ENDELSE  
     145    ENDELSE 
    146146  ENDIF 
    147147 
    … …  
    154154                  OR namevar EQ 'lat_rho' OR namevar EQ 'nblatitudes'))[0] 
    155155  yvarid = yvarid[0] 
    156 ; no yaxis variable found, we will build a fake yaxis based on the size of the y dimension  
     156; no yaxis variable found, we will build a fake yaxis based on the size of the y dimension 
    157157; -> we must find the y dimension 
    158158  if yvarid EQ -1 then begin 
    … …  
    189189      ENDCASE 
    190190    ENDIF 
    191   ENDIF ELSE BEGIN  
     191  ENDIF ELSE BEGIN 
    192192    yinq = ncdf_varinq(cdfid, yvarid) 
    193193    IF yinq.ndims GE 2 THEN BEGIN 
    194194      ncdf_diminq, cdfid, yinq.dim[0], blabla, jpifromy 
    195       IF jpifromy NE jpifromx THEN BEGIN  
     195      IF jpifromy NE jpifromx THEN BEGIN 
    196196        dummy = report('x/y axes do not have the same x dimension...') 
    197197        stop 
    … …  
    204204    ncdf_diminq, cdfid, dimidy, blabla, jpjfromy 
    205205    IF n_elements(jpjfromx) NE 0 THEN BEGIN 
    206       IF jpjfromy NE jpjfromx THEN BEGIN  
     206      IF jpjfromy NE jpjfromx THEN BEGIN 
    207207        dummy = report(' x/y axes do not have the same y dimension...') 
    208208        stop 
    209       ENDIF     
     209      ENDIF 
    210210    ENDIF 
    211211; should we read or compute the xaxis? 
    212     IF keyword_set(xyindex) OR yvarid EQ -1 THEN BEGIN  
     212    IF keyword_set(xyindex) OR yvarid EQ -1 THEN BEGIN 
    213213      yaxis = keyword_set(start1) + findgen(jpjfromy) 
    214214    ENDIF ELSE BEGIN 

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

    r163 r224  
    55; 
    66; @file_comments 
    7 ; Calculate the height by rapport to a reference state for a depth reference.  
    8 ; See keywords for different possibilities. By default, the state reference  
    9 ; is rho=1020 and the depth reference is gdepw[ka] with ka the first W level  
    10 ; directly above 1000 m.  
     7; Calculate the height by rapport to a reference state for a depth reference. 
     8; See keywords for different possibilities. By default, the state reference 
     9; is rho=1020 and the depth reference is gdepw[ka] with ka the first W level 
     10; directly above 1000 m. 
    1111; 
    1212; @categories 
    … …  
    1717; 
    1818; @param TABTN {in}{required} 
    19 ; array representing the temperature.Has the same size than SN 
     19; array representing the temperature. Has the same size than SN. 
    2020; 
    21 ; @keyword GILL We activate this key if we want to calculate the dynamic height  
    22 ; like in the GILL page 215, which means by rapport to a reference state which  
    23 ; vary in depth and which is determined by a reference temperature tref at 0°C  
    24 ; and a reference salinity sref at 35psu 
     21; @keyword GILL  
     22; We activate this key if we want to calculate the dynamic height 
     23; like in the GILL page 215, which means by rapport to a reference state which 
     24; vary in depth and which is determined by a reference temperature tref at 0°C 
     25; and a reference salinity sref at 35 psu. 
    2526; 
    2627; @keyword LEVEL 
    27 ; It is the same reference level to take. This level is defined like  
     28; It is the same reference level to take. This level is defined like 
    2829; that gdepw[level] is the reference depth 
     30; 
     31; @keyword SREF 
     32; Give a value to this keyword to change the reference salinity used in the 
     33; calculation when GILL is activated. 
    2934;  
    30 ; @keyword SREF  
    31 ; Give a value to this keyword to change the reference salinity used in the  
    32 ; calculation when GILL  is activated.  
    33 ;    
    3435; @keyword TREF 
    35 ; Give a value to this keyword to change the reference temperature used in the  
    36 ; calculation when GILL  is activated. 
    37 ;  
     36; Give a value to this keyword to change the reference temperature used in the 
     37; calculation when GILL is activated. 
     38; 
    3839; @keyword PROFREF 
    39 ; Give a depth to this keyword which will be considered as the reference depth  
    40 ; (in this case, LEVEL has not any effect). the calculation will be effectuated  
    41 ; until this depth effecting an interpolation between the the last W level above  
     40; Give a depth to this keyword which will be considered as the reference depth 
     41; (in this case, LEVEL has not any effect). the calculation will be effectuated 
     42; until this depth effecting an interpolation between the the last W level above 
    4243; PROFREF and PROFREF. 
    4344; 
    … …  
    4647; 
    4748; @returns 
    48 ; An array of the same size of sn and tn representing the dynamic height calculated  
     49; An array of the same size of sn and tn representing the dynamic height calculated 
    4950; from a reference depth nd by rapport to a reference state. 
    5051; 
    51 ; @uses  
     52; @uses 
    5253; common.pro 
    5354; 
    5455; @restrictions 
    55 ; Points for which we can not calculate the dynamic height (whose the batymetry  
     56; Points for which we can not calculate the dynamic height (whose the batymetry 
    5657; is less deep than the reference depth) are put at the value !values.f_nan 
    5758; 
    5859; @restrictions 
    59 ; approximation: The pressure in decibars is equal to the depth in meters (the pressure increase of 1bar all 10m) 
     60; approximation: The pressure in decibars is equal to the depth in meters  
     61; (the pressure increase of 1 bar every 10 m) 
    6062; 
    6163; @history 
    … …  
    6971;------------------------------------------------------------ 
    7072;------------------------------------------------------------ 
    71 FUNCTION hdyn,  tabsn, tabtn, TREF = tref, SREF = sref, PROFREF = profref, LEVEL = level, GILL = gill, SURFACE_LEVEL = surface_level 
     73FUNCTION hdyn, tabsn, tabtn, TREF = tref, SREF = sref, PROFREF = profref, LEVEL = level, GILL = gill, SURFACE_LEVEL = surface_level 
    7274; 
    7375  compile_opt idl2, strictarrsubs 
    … …  
    8587      level = level-1 
    8688      za = gdepw[level] 
    87    ENDIF ELSE BEGIN  
    88       if NOT keyword_set(level) then BEGIN  
     89   ENDIF ELSE BEGIN 
     90      if NOT keyword_set(level) then BEGIN 
    8991         rien = where(gdepw LE 1000., level) 
    9092         level = level-1 
    … …  
    9294      profref = gdepw[level] 
    9395      za = profref 
    94    ENDELSE  
     96   ENDELSE 
    9597   tailles = size(tabsn) 
    9698   taillet = size(tabtn) 
    9799   if total(tailles[0:tailles[0]] NE taillet[0:taillet[0]]) NE 0 then $ 
    98     return,  report('Les tableaux sn et tn doivent avoir la meme taille') 
    99    if tailles[3] NE jpk then return, report('La dim verticale des tableaux sn et tn doit etre egalre a jpk') 
     100    return,  report('arrays sn and tn must have the same size') 
     101   if tailles[3] NE jpk then return, report('vertical dimension of sn and tn arrarrays must be equal to jpk') 
    100102   nx = nxt 
    101103   ny = nyt 
    102104   case (size(tabsn))[0] OF 
    103       3:BEGIN  
     105      3:BEGIN 
    104106         case 1 of 
    105107            tailles[1] eq jpi and tailles[2] eq jpj: BEGIN 
    … …  
    107109               tn = tabtn[firstxt:lastxt, firstyt:lastyt, *] 
    108110            end 
    109             tailles[1] eq  nx and tailles[2] eq  ny:BEGIN  
     111            tailles[1] eq  nx and tailles[2] eq  ny:BEGIN 
    110112               sn = tabsn 
    111113               tn = tabtn 
    … …  
    128130         endcase 
    129131      END 
    130       4:BEGIN  
     132      4:BEGIN 
    131133         case 1 of 
    132134            tailles[1] eq jpi and tailles[2] eq jpj AND tailles[4] EQ jpt: BEGIN 
    … …  
    134136               tn = tabtn[firstxt:lastxt, firstyt:lastyt, *, *] 
    135137            end 
    136             tailles[1] eq  nx and tailles[2] eq  ny AND tailles[4] EQ jpt:BEGIN  
     138            tailles[1] eq  nx and tailles[2] eq  ny AND tailles[4] EQ jpt:BEGIN 
    137139               sn = tabsn 
    138140               tn = tabtn 
    … …  
    158160         endcase 
    159161      END 
    160       ELSE: return,  report('cas non code') 
     162      ELSE: return,  report('not implemented') 
    161163   ENDCASE 
    162164   varunit = 'cm' 
    163165   varname = 'Dynamic Height (href='+strtrim(round(profref), 1)+'m)' 
    164    IF keyword_set(key_performance) THEN print, 'temps hdyn', systime(1)-tempsun  
     166   IF keyword_set(key_performance) THEN print, 'temps hdyn', systime(1)-tempsun 
    165167 
    166168   return, hdyn 

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

    r163 r224  
    1717; To do not mask land points. 
    1818; 
    19 ; @returns  
     19; @returns 
    2020; 2d array containing depths 
    2121; 
    … …  
    5050;--------------------------------------------------------------- 
    5151   taille = size(niveaux) 
    52    if taille[0] NE 2 then return, report('le champ en entree doit contenir un tableau 2d') 
     52   if taille[0] NE 2 then return, report('input field must be a 2d array') 
    5353   case 1 of 
    5454      taille[1] eq jpi and taille[2] eq jpj:niveaux=niveaux[firstx:lastx, firsty:lasty] 
    … …  
    7373   endif 
    7474; 
    75    if keyword_set(key_performance) THEN print, 'temps level2depth', systime(1)-tempsun  
     75   if keyword_set(key_performance) THEN print, 'temps level2depth', systime(1)-tempsun 
    7676   return, gdep 
    7777end 

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

    r163 r224  
    7171   endcase 
    7272   case 1 OF 
    73       taillearray[3] NE jpk:return, report('Le tableau 3d doit avoir sa 3eme dimension egale a jpk') 
     73      taillearray[3] NE jpk:return, report('2d array must have its 3d dimension equal to jpk') 
    7474      taillearray[1] eq jpi and taillearray[2] eq jpj:array=array[firstx:lastx, firsty:lasty, *] 
    7575      taillearray[1] eq  nx and taillearray[2] eq  ny: 

  • trunk/SRC/Utilities/createfunc.pro

    r136 r224  
    3232; IDL>                          , kwdlist ='two = two', two = 2) 
    3333; 
    34 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     34; @history 
     35; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3536;                      May 2005 
    3637; 
    37 ; @version $Id$ 
     38; @version 
     39; $Id$ 
    3840; 
    3941;- 

  • trunk/SRC/Utilities/createpro.pro

    r163 r224  
    3838; IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok 
    3939; 
    40 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     40; @history 
     41; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4142; cleaning + new keywords: October 2005 
    4243; Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute 
    4344; 
    44 ; @version $Id$ 
     45; @version 
     46; $Id$ 
    4547;- 
    4648;------------------------------------------------------------ 

  • trunk/SRC/Utilities/def_myuniquetmpdir.pro

    r157 r224  
    1010; IDL> def_myuniquetmpdir 
    1111; 
    12 ; @uses cm_general 
     12; @uses 
     13; cm_general 
    1314; 
    14 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     15; @history 
     16; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1517;                      June 2005 
    1618; 
    17 ; @version $Id$ 
     19; @version 
     20; $Id$ 
    1821; 
    1922;- 

  • trunk/SRC/Utilities/demomode_compatibility.pro

    r157 r224  
    11;+ 
    2 ; @categories Utilities 
    3 ; @uses cm_general 
    4 ; @version $Id$ 
     2; @categories 
     3; Utilities 
     4; 
     5; @uses 
     6; cm_general 
     7; 
     8; @version 
     9; $Id$ 
    510;- 
    611PRO demomode_compatibility 

  • trunk/SRC/Utilities/find.pro

    r163 r224  
    1111; all file_search keywords can be used. 
    1212; 
    13 ; @categories find a file 
     13; @categories  
     14; find a file 
    1415; 
    1516; @param FILEIN {in}{required}  
    … …  
    99100;   /usr/local/rsi/idl_6.0/lib/mesh_obj.pro 
    100101; 
    101 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     102; @history 
     103; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    102104;                       28/4/1999 
    103105;                       6/7/1999: compatibility mac and windows 
    104106; June 2005: Sebastien Masson: cleaning, use for file_* functions 
    105107; 
    106 ; @version $Id$ 
     108; @version 
     109; $Id$ 
    107110;- 
    108111;------------------------------------------------------------ 

  • 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,            *, *] 

  • trunk/SRC/Utilities/isadirectory.pro

    r163 r224  
    77; with the directory separator mark. 
    88; 
    9 ; @categories io 
     9; @categories 
     10; io 
    1011; 
    11 ; @param DIRECTORYIN {in}{optional}  
     12; @param DIRECTORYIN {in}{optional} 
    1213; a proposed directory. If neither dirname 
    1314; input parameter of IODIRECTORY keyword are defined, 
    1415; the ask the user to choose a directory. 
    1516; 
    16 ; @keyword IODIRECTORY  
     17; @keyword IODIRECTORY 
    1718; a proposed directory 
    1819; 
    19 ; @keyword TITLE  
     20; @keyword TITLE 
    2021; the title of the window 
    2122; 
    22 ; @keyword _EXTRA  
     23; @keyword _EXTRA 
    2324; used to pass your keywords 
    2425; 
    25 ; @file_comments  
    2626; all dialog_pickfile keywords (like filter) can be used. 
    2727; 
    28 ; @returns  
     28; @returns 
    2929; the directory name 
    3030; 
    … …  
    3737; IDL> print, isadirectory(!dir+'notgood') 
    3838; 
    39 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     39; @history 
     40; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4041;                      June 28, 2000 
    4142; June 2005: Sebastien Masson: cleaning, use for file_* functions 
    4243; 
    43 ; @version $Id$ 
     44; @version 
     45; $Id$ 
    4446;- 
    4547;------------------------------------------------------------ 

  • trunk/SRC/Utilities/isafile.pro

    r163 r224  
    99; @categories io 
    1010; 
    11 ; @param FILEIN {in}{optional}  
    12 ; a proposed name. If neither filein input parameter of filename keyword are  
     11; @param FILEIN {in}{optional} 
     12; a proposed name. If neither filein input parameter of filename keyword are 
    1313; defined, the ask the user to choose a file. 
    1414; 
    15 ; @keyword FILENAME  
     15; @keyword FILENAME 
    1616; a proposed filename. 
    1717; 
    18 ; @keyword IODIRECTORY  
     18; @keyword IODIRECTORY 
    1919; a directory where we look for the file. this 
    2020; keyword is taken into account only if the dirname 
    2121; of filein or filename is '.' 
    2222; 
    23 ; @keyword NEW  
    24 ; to specify that filename is a new file and that we should check only its  
     23; @keyword NEW 
     24; to specify that filename is a new file and that we should check only its 
    2525; path 
    2626; 
    27 ; @keyword ONLYPRO  
     27; @keyword ONLYPRO 
    2828; force to look only at file ending with .pro 
    2929; 
    30 ; @keyword ONLYNC  
     30; @keyword ONLYNC 
    3131; force to look only at file ending with .nc 
    3232; 
    33 ; @keyword RECURSIVE  
     33; @keyword RECURSIVE 
    3434; performs recursive searching of directory hierarchies. 
    3535; In a recursive search, find looks recursively for any and all 
    3636; subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    3737; 
    38 ; @keyword _EXTRA  
     38; @keyword _EXTRA 
    3939; used to pass your keywords 
    4040; 
    41 ; @file_comments  
    4241; all find, file_search and dialog_pickfile keywords (like title) can be used 
    4342; 
    44 ; @returns  
     43; @returns 
    4544; the filename with its path 
    4645; 
    … …  
    5958; IDL> print, isafile('fake_file.pro') 
    6059; 
    61 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     60; @history 
     61; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    6262;                      11/2/2000 
    6363; June 2005: Sebastien Masson: cleaning, use for file_* functions 
    6464; 
    65 ; @version $Id$ 
     65; @version 
     66; $Id$ 
    6667;- 
    6768;------------------------------------------------------------ 

  • trunk/SRC/Utilities/linearequation.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
     6; @file_comments 
    77; Calculate a linear equation of the type ax+by+c=0 
    88; thanks to coordinates of 2 points. 
    99; comment: we can have a table with pairs of points. 
    1010; 
    11 ; @categories  
    12  ;Utilities 
    13 ;  
    14 ; @param POINT1 {in}{required}  
    15 ; This is the first point of(the) straight line(s) whose we want to calculate  
     11; @categories 
     12; Utilities 
     13; 
     14; @param POINT1 {in}{required} 
     15; This is the first point of(the) straight line(s) whose we want to calculate 
    1616; equation(s) 
    1717; 
    18 ; @param POINT2 {in}{required}  
     18; @param POINT2 {in}{required} 
    1919; This is the second point of(the) straight line(s) whose we want to calculate 
    2020; equation(s) 
    … …  
    2525;         For each row of the table, we have coordinates of the point. 
    2626; 
    27 ; @returns  
    28 ; abc is a table of dimension 3, number_of_straight_line,  
     27; @returns 
     28; abc is a table of dimension 3, number_of_straight_line, 
    2929; where for each line of the table we obtain the 3 parameters 
    3030; a, b and c of the linear equation ax+by+c=0 
    3131; 
    32 ; @examples  
     32; @examples 
    3333; IDL> abc=linearequation(complex(1,2),[3,4]) 
    3434; IDL> print, abc[0]*1+abc[1]*2+abc[2] 
    3535; 0.00000 
    3636; 
    37 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     37; @history 
     38; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3839;          10 juin 2000 
    3940; 
    40 ; @version $Id$ 
     41; @version 
     42; $Id$ 
    4143; 
    4244;- 
    … …  
    6769   vertical = where(x1 EQ x2) 
    6870   novertical = where(x1 NE x2) 
    69    abc = fltarr(3, n_elements(x1))  
     71   abc = fltarr(3, n_elements(x1)) 
    7072 
    7173   IF novertical[0] NE -1 then BEGIN 
    7274; y=mx+p 
    73       nele = n_elements(novertical)  
     75      nele = n_elements(novertical) 
    7476      m = (y2[novertical]-y1[novertical])/(x2[novertical]-x1[novertical]) 
    7577      p = (x2[novertical]*y1[novertical]-y2[novertical]*x1[novertical])/(x2[novertical]-x1[novertical]) 
    … …  
    7880   IF vertical[0] NE -1 then BEGIN 
    7981; x=ny+p 
    80       nele = n_elements(vertical)  
     82      nele = n_elements(vertical) 
    8183      n = (x2[vertical]-x1[vertical])/(y2[vertical]-y1[vertical]) 
    8284      p = (y2[vertical]*x1[vertical]-x2[vertical]*y1[vertical])/(y2[vertical]-y1[vertical]) 

  • trunk/SRC/Utilities/lineintersection.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
    7 ; Calculate coordinates of the intersection between 2 straight lines  
     6; @file_comments 
     7; Calculate coordinates of the intersection between 2 straight lines 
    88; or of a succession of 2 straight lines. 
    99; 
    10 ; @categories  
     10; @categories 
    1111; Utilities 
    12 ;  
     12; 
    1313; @param ABC1 {in}{required}{type=3d array} 
    14 ; is the first array of dimension 3, number_of_pairs_of_straight_lines,  
    15 ; whose each line contain the 3 parameters a,b and c of the first linear  
     14; is the first array of dimension 3, number_of_pairs_of_straight_lines, 
     15; whose each line contain the 3 parameters a,b and c of the first linear 
    1616; equation of the type ax+by+c=0 
    1717; 
    1818; @param ABC2 {in}{required}{type=3d array} 
    19 ; is second array of dimension 3, number_of_pairs_of_straight_lines,  
    20 ; whose each line contain the 3 parameters a,b and c of the second linear  
     19; is second array of dimension 3, number_of_pairs_of_straight_lines, 
     20; whose each line contain the 3 parameters a,b and c of the second linear 
    2121; equation of the type ax+by+c=0 
    2222; 
    23 ; @keyword FLOAT  
    24 ; To return the output as a array of real numbers instead of vectors of  
     23; @keyword FLOAT 
     24; To return the output as a array of real numbers instead of vectors of 
    2525; complex (by default) 
    2626; 
    27 ; @returns  
     27; @returns 
    2828; 2 possibilities: 
    29 ;      1) by default: it is a vector of complex whose each element is the coordinates  
     29;      1) by default: it is a vector of complex whose each element is the coordinates 
    3030;                     of the intersection point of a pair of straight lines. 
    31 ;      2) if FLOAT is activated, it is a array of reels of dimension 2,  
    32 ;         number_of_pairs_of_straight_lines whose each row is the coordinates  
     31;      2) if FLOAT is activated, it is a array of reels of dimension 2, 
     32;         number_of_pairs_of_straight_lines whose each row is the coordinates 
    3333;         of the intersection point of a pair of straight line. 
    3434; 
    35 ; @restrictions  
    36 ; If the 2 straight line are parallel, we return coordinates  
     35; @restrictions 
     36; If the 2 straight line are parallel, we return coordinates 
    3737; (!values.f_nan,!values.f_nan) 
    3838; 
    39 ; @restrictions  
    40 ; Beware of the precision of the machine which make  
    41 ; that calculated coordinates may not exactly verify  
     39; Beware of the precision of the machine which make 
     40; that calculated coordinates may not exactly verify 
    4241; equations of the pair of straight lines. 
    4342; 
    44 ; @examples  
     43; @examples 
    4544; IDL> abc1=linearequation(complex(1,2),[3,4]) 
    4645; IDL> abc2=linearequation(complex(1,2),[8,15]) 
    … …  
    5049; 1.00000      2.00000 
    5150; 
    52 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     51; @history 
     52; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    5353;          10 juin 2000 
    5454; 
    55 ; @version $Id$ 
     55; @version 
     56; $Id$ 
    5657; 
    5758;- 
    … …  
    7980; 
    8081   if keyword_set(float) then begin 
    81       npts = n_elements(x)  
     82      npts = n_elements(x) 
    8283      res = [reform(x, 1, npts, /over), reform(y, 1, npts, /over)] 
    8384   ENDIF ELSE res = complex(x, y) 

  • trunk/SRC/Utilities/mergeonline_help.pro

    r197 r224  
    77; 
    88; @restrictions 
    9 ; Needs at least version 6.2  
     9; Needs at least version 6.2 
    1010; 
    1111; @history 
    … …  
    2626  ENDIF 
    2727;--------------------------------------------------------------- 
    28 ; check directories  
     28; check directories 
    2929;--------------------------------------------------------------- 
    3030; get the environment variable $HOME 
    … …  
    6060  ENDIF 
    6161;--------------------------------------------------------------- 
    62 ; check existance and version of the file that need to be created 
     62; check existence and version of the file that need to be created 
    6363;--------------------------------------------------------------- 
    6464 
    … …  
    7979      IF line NE -1 THEN BEGIN 
    8080        old = saxoadp[line] 
    81 ; are the 2 revision tags the same?? 
     81; are the 2 revision tags the same ? 
    8282        IF array_equal(old, new) THEN BEGIN 
    8383; is IDL version the same of homesrc + 'home.html' ? 
    … …  
    164164; add some informattions: 
    165165  about = [about, '', 'More informations on', 'http://forge.ipsl.jussieu.fr/saxo', ''] 
    166 ;  
     166; 
    167167  putfile, homesrc + 'aboutsaxo.txt', temporary(about) 
    168168;--------------------------------------------------------------- 

  • trunk/SRC/Utilities/protype.pro

    r223 r224  
    2929;      proc 
    3030; 
    31 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     31; @history 
     32; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3233;                       Feb 2006 
    3334; 
    34 ; @version $Id$ 
     35; @version 
     36; $Id$ 
    3537;- 
    3638;------------------------------------------------------------ 

  • trunk/SRC/Utilities/pwd.pro

    r136 r224  
    44;+ 
    55; 
    6 ; @file_comments  
     6; @file_comments 
    77; print the current directory 
    88; 
    9 ; @categories like unix function 
    10 ;  
    11 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     9; @categories 
     10; like unix function 
    1211; 
    13 ; @version $Id$ 
     12; @history 
     13; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     14; 
     15; @version 
     16; $Id$ 
    1417; 
    1518;- 

  • trunk/SRC/Utilities/report.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
    7 ; Like dialog_message.pro if there is already some widget  
    8 ; active or like message.pro if there is not any widget active.  
     6; @file_comments 
     7; Like dialog_message.pro if there is already some widget 
     8; active or like message.pro if there is not any widget active. 
    99; To ask a question whose answer is not yes/no,use xquestion. 
    1010; 
    11 ; @param TEXT {in}{required}  
     11; @param TEXT {in}{required} 
    1212; one string or one vector of string. Si le string ne 
    1313; comporte qu''un element, on cherche les eventuels characteres de 
    … …  
    1515; array element is displayed as a separate line of text. 
    1616; 
    17 ; @keyword SIMPLE  
     17; @keyword SIMPLE 
    1818; activate to print only the message without the name 
    1919; and the line of the routine (defined by calling routine_name) 
    2020; 
    21 ; @keyword _EXTRA  
     21; @keyword _EXTRA 
    2222; used to pass keywords from dialog_message.pro and message.pro 
    2323; 
    24 ; @keyword PARENT  
     24; @keyword PARENT 
    2525; same as DIALOG_PARENT de dialog_message.pro 
    2626; 
    … …  
    2929; 
    3030; @keyword DEFAULT_NO {default="Yes"} 
    31 ; Set this keyword to make the "No" button the default selection for  
    32 ; "Question" dialog.  
     31; Set this keyword to make the "No" button the default selection for 
     32; "Question" dialog. 
    3333; 
    34 ; @keyword SIMPLE  
    35 ; Activate to print the error message without printing  the routine name with  
     34; @keyword SIMPLE 
     35; Activate to print the error message without printing the routine name with 
    3636; its full path. 
    3737; 
    38 ; @returns  
     38; @returns 
    3939; -1 if the keyword QUESTION is not activated 
    4040; If the keyword is activated, return 1 for yes and 0 for no. 
    41 ;  
    42 ; @examples  
     41; 
     42; @examples 
    4343; If there is not any widget activated: 
    4444; 
    … …  
    5656; If widgets are already activated, it is the same thing but with widgets! 
    5757; 
    58 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     58; @history 
     59; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    5960;                      21/10/1999 
    6061; 
    61 ; @version $Id$ 
     62; @version 
     63; $Id$ 
    6264; 
    6365;- 
    … …  
    8587         default_answer = answer 
    8688         if n_elements(text) GT 1 THEN $ 
    87           for i = 0, n_elements(text)-2 do print,text[i]  
     89          for i = 0, n_elements(text)-2 do print,text[i] 
    8890         read, text[n_elements(text)-1]+' y/n (default answer is '+default_answer+')' , answer 
    8991         answer = strlowcase(answer) ; 
    … …  
    103105        IF keyword_set(simple) THEN prefix = '' ELSE prefix = '% '+routine_name(1)+': ' 
    104106         if n_elements(text) GT 1 THEN $ 
    105           for i = 0, n_elements(text)-2 do print, prefix+text[i]  
     107          for i = 0, n_elements(text)-2 do print, prefix+text[i] 
    106108         print, prefix+text[n_elements(text)-1] 
    107109      ENDELSE 

  • trunk/SRC/Utilities/routine_name.pro

    r163 r224  
    77; Give us the name of the routine (procedure or function) where we are. 
    88; 
    9 ; @categories  
     9; @categories 
    1010; Utilities 
    1111; 
    … …  
    3535;  $MAIN$ 
    3636; 
    37 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     37; @history 
     38; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3839;                      21/10/1999 
    3940; 
    40 ; @version $Id$ 
     41; @version 
     42; $Id$ 
    4143; 
    4244;- 

  • trunk/SRC/Utilities/testvar.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
    7 ; A kind of keyword_set but when the value exist, it send it back 
     6; @file_comments 
     7; A kind of keyword_set but when the value exist, it send it back. 
    88; 
    9 ; @categories  
     9; @categories 
    1010; Utilities 
    1111; 
    12 ; @keyword VAR  
     12; @keyword VAR 
    1313; any kind of 
    1414; 
    15 ; @returns  
    16 ; 0 if the variable does not exist  
     15; @returns 
     16; 0 if the variable does not exist 
    1717; 
    18 ; @examples  
     18; @examples 
    1919; IDL> print, testvar(var=toto) 
    2020; 0 
    … …  
    2222; toto 
    2323; 
    24 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     24; @history 
     25; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2526;                      14/12/1999 
    2627; 
    27 ; @version $Id$ 
     28; @version 
     29; $Id$ 
    2830; 
    2931;- 

  • trunk/SRC/Utilities/text_box.pro

    r163 r224  
    11;+ 
    22; 
    3 ; @file_comments  
     3; @file_comments 
    44; This procedure writes a short text message within a box-shaped 
    55; area in a graphics window.  The message may be split at word 
    66; boundaries into several lines, and the character size and 
    77; orientation may be adjusted for the text to fit within the box. 
    8 ;    
    9 ; @param TEXT {in}{required}  
     8; 
     9; @param TEXT {in}{required} 
    1010; ASCII text string containing the message. 
    1111; 
    12 ; @keyword POS   
     12; @keyword POS 
    1313; 4 element vector specifying the box position and size 
    1414; pos[0],pos[1] specify the lower left corner coordinate 
    … …  
    1919; color of box and legend titles 
    2020; 
    21 ; @keyword BG_COLOR  
    22 ; background color. Setting BG_COLOR erases the area  
     21; @keyword BG_COLOR 
     22; background color. Setting BG_COLOR erases the area 
    2323;               covered by the text box (filling it with color BG_COLOR) 
    2424;               prior to writing the text.  If both BG_COLOR and !p.color 
    2525;               are zero then the background color is reset to 255 to 
    2626;               gaurantee a readability. 
    27 ;                
    28 ; @keyword RIGHT  
     27; 
     28; @keyword RIGHT 
    2929; if set, right justify text 
    3030; 
    31 ; @keyword CENTER  
     31; @keyword CENTER 
    3232; if set, center the text 
    3333; 
    … …  
    3535; vertical spacing of lines in units of character height 
    3636; 
    37 ; @keyword _EXTRA  
     37; @keyword _EXTRA 
    3838; used to pass your keyword 
    3939; 
    40 ; @keyword BOX  
     40; @keyword BOX 
    4141; activate to show the box on graphics window. 
    4242; 
    43 ; @history  Paul Ricchiazzi                            7Jul93 
     43; @history 
     44; Paul Ricchiazzi                            7Jul93 
    4445;           Institute for Computational Earth System Science 
    4546;           University of California, Santa Barbara 
    4647; 
    47 ; @version $Id$ 
     48; @version 
     49; $Id$ 
    4850; 
    4951;- 
    … …  
    8082  print,strcompress(posstring,/remove_all) 
    8183 
    82     
     84 
    8385endif else begin 
    84    
     86 
    8587  xx1 = nnx[0]+pos[0]*(nnx[1]-nnx[0]) 
    8688  xx2 = nnx[0]+pos[2]*(nnx[1]-nnx[0]) 
    … …  
    103105  blanklen=lenstr(' ')*!d.x_vsize 
    104106  maxcharsize=(xx2-xx1)/(4*blanklen+max(wordlen)) 
    105   charsize=1   
     107  charsize=1 
    106108  lpnt=intarr(nwords) 
    107109  nomore=0 
    … …  
    123125        sum=wlen[i]+blen 
    124126      endif 
    125       lpnt[i]=ilines         
    126        
     127      lpnt[i]=ilines 
     128 
    127129;      print,f='(f8.2,4i8,3f8.2)',charsize,i,ilines,n_lines,lpnt[i],$ 
    128130;                 wlen[i]+blen,sum+3*blen,xx2-xx1 
    129     endfor         
     131    endfor 
    130132    case 1 of 
    131133      ilines+1 lt n_lines: if charsize*1.1 gt maxcharsize then $ 
    … …  
    135137      ilines+1 gt n_lines: charsize=charsize*.9 
    136138    endcase 
    137 endrep until nomore  
     139endrep until nomore 
    138140 
    139141lines=strarr(n_lines) 
    … …  
    150152; 
    151153  align=.5*(1+justify) 
    152    
     154 
    153155  case justify of 
    154156    -1:xx = xx1+.5*((xx2-xx1)-maxlen) 

  • trunk/SRC/Utilities/undefine.pro

    r163 r224  
    44;+ 
    55; 
    6 ; @file_comments  
     6; @file_comments 
    77; erase a variable 
    8 ; same thing that delvar but usable in a program and usable  
     8; same thing that delvar but usable in a program and usable 
    99; for one variable simultaneously 
    1010; 
    11 ; @categories  
    12 ; Utilities   
    13 ;  
    14 ; @param VARNAME {in}{required}  
     11; @categories 
     12; Utilities 
     13; 
     14; @param VARNAME {in}{required} 
    1515; The name of the variable we want erase 
    1616; 
    … …  
    2222; A               UNDEFINED = <Undefined> 
    2323; 
    24 ; @history trouve sur la page web de D.Fanning  
     24; @history 
     25; trouve sur la page web de D.Fanning 
    2526; http://www.dfanning.com : 
    26 ;QUESTION: How do I make an IDL variable have a type "undefined"?  
     27;QUESTION: How do I make an IDL variable have a type "undefined"? 
    2728;ANSWER: At the main IDL level you can use the IDL procedure DELVAR to 
    2829;delete an IDL variable and make it undefined. Inside of procedures 
    … …  
    3132;Adelaide, Australia. 
    3233; 
    33 ; @version $Id$ 
     34; @version 
     35; $Id$ 
    3436; 
    3537;- 
    … …  
    3739;------------------------------------------------------------ 
    3840;------------------------------------------------------------ 
    39    PRO undefine, varname   
     41   PRO undefine, varname 
    4042; 
    4143  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Utilities/xhelp.pro

    r223 r224  
    9292      endwhile 
    9393      if i EQ 0 then $ 
    94          ras = report('le programme a etait mal ecrit, il n''y a pas d''en-tete... utiliser xfile.pro.') ELSE BEGIN 
     94         ras = report('file is badly written, no header ... Use xfile') ELSE BEGIN 
    9595         a = a[0:i-1] 
    9696; we wrote the a's content in a widget 
    … …  
    9898      ENDELSE 
    9999      FREE_LUN, unit         ;free the file unit. 
    100    ENDIF ELSE ras = report('le fichier demande n''existe pas...') 
     100   ENDIF ELSE ras = report('file does not exist ...') 
    101101 
    102102   return 
Note: See TracChangeset for help on using the changeset viewer.