Changeset 378


Ignore:
Timestamp:
08/12/08 14:35:46 (16 years ago)
Author:
pinsard
Message:

improvements of headers (typo, links, paragraphes, etc)

Location:
trunk/SRC
Files:
33 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Calendar/date2string.pro

    r371 r378  
    1111; 
    1212; @keyword _EXTRA 
    13 ; Used to pass keywords to <proidl>string</proidl> function 
     13; Used to pass keywords to <proidl>STRING</proidl> function 
    1414; 
    1515; @returns 

  • trunk/SRC/Calendar/monthname.pro

    r327 r378  
    1111; 
    1212; @keyword _EXTRA 
    13 ; Used to pass keywords to <proidl>string</proidl> function 
     13; Used to pass keywords to <proidl>STRING</proidl> function 
    1414; 
    1515; @returns 

  • trunk/SRC/Computation/div.pro

    r371 r378  
    3737; <pro>cm_4cal</pro> 
    3838; <pro>cm_4data</pro> 
    39 ; <pro>cm_4mmesh</pro> 
     39; <pro>cm_4mesh</pro> 
    4040; 
    4141; @restrictions 

  • trunk/SRC/Matrix/inter.pro

    r373 r378  
    44; find the intersection between 2 matrices of whole numbers 
    55; 
    6 ; see also <pro>difference</pro> and <pro>union</pro> 
     6; see also <pro>different</pro> and <pro>union</pro> 
    77; 
    88; @categories 

  • trunk/SRC/Matrix/union.pro

    r373 r378  
    44; find the union between 2 matrices of whole numbers 
    55; 
    6 ; see also <pro>difference</pro> and <pro>inter</pro>. 
     6; see also <pro>different</pro> and <pro>inter</pro>. 
    77 
    88; @categories 

  • trunk/SRC/Obsolete/extrait.pro

    r371 r378  
    3838; 
    3939; @param tab {in}{required} 
    40 ; a 1,2,3 or 4 dim table 
     40; a 1d, 2d, 3d or 4d table 
    4141; 
    4242; @param indicex {in}{required} 
    … …  
    5555; 
    5656; @returns 
    57 ; a matrix 1,2,3 or 4d extract from tab 
     57; a matrix 1d, 2d, 3d or 4d extract from tab 
    5858; -1 in case of mistake 
    5959; 

  • trunk/SRC/Obsolete/lec.pro

    r371 r378  
    3535; trois lettres designant le nom de l'experience 
    3636; 
    37 ; 
    3837; @keyword ANOM {in} 
    3938; type du fichier vairmer par rapport auquel on doit calculer 
    … …  
    5251; @keyword FILENAME 
    5352; string pour passer directement le nom du champ sans 
    54 ;       utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si 
    55 ;       ces inputs sont qd meme donnes ils ne sont pas modifies par 
    56 ;       filename. 
     53; utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si 
     54; ces inputs sont qd meme donnes ils ne sont pas modifies par 
     55; filename. 
    5756; 
    5857; @keyword GRID 
    5958; lorsque ce mot clef est active, lec retourne la liste 
    60 ;       des types de grilles (T, U...) auxquelles se rapportent les 
    61 ;       variables. ds ce cas en input on met seulement 'vo' ou 'so'. 
     59; des types de grilles (T, U...) auxquelles se rapportent les 
     60; variables. ds ce cas en input on met seulement 'vo' ou 'so'. 
    6261; 
    6362; @keyword NAME 
    6463; lorsque ce mot clef est active, lec retourne la liste 
    65 ;       des noms des variables. ds ce cas en input on met seulement 
    66 ;       'vo' ou 'so'. 
     64; des noms des variables. ds ce cas en input on met seulement 
     65; 'vo' ou 'so'. 
    6766; 
    6867; @keyword TOUT 
    6968; oblige lec a lire le champ sur tout le domaine qui a 
    70 ;       etait selectionne pour la cession en cours (jpi,jpj,jpk) 
     69; etait selectionne pour la cession en cours (jpi,jpj,jpk) 
    7170; 
    7271; @returns 
    73 ; un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est 
     72; un tableau 2d ou 3d. sans le mot cle /TOUT, sa taille est 
    7473; celle du sous domaine definit par <pro>domdef</pro>(nx,ny,nz). avec /TOUT le 
    7574; champ a la taille du  domaine qui a etait selectionne pour la 
    … …  
    8281; <pro>common</pro> 
    8382; <pro>isnumber</pro> 
    84 ; <pro>fivardate</pro> 
     83; <pro>ficdate</pro> 
    8584; 
    8685; @history 

  • trunk/SRC/ReadWrite/write_ncdf.pro

    r371 r378  
    520520; global attr)   
    521521; 
    522 ; @return value 
     522; @returns 
    523523; a netcdf file containing the variable in the format specified 
    524524; through keywords and variables  
    … …  
    566566;    day' as a global attribute 
    567567; 
    568 ; @keyword namevquick {in}{optional}  
     568; @keyword VARNAME {in}{optional}  
    569569;  - an array of char, same number of elements as the number of given 
    570570;    var 
    … …  
    608608;        } 
    609609;   IDL> write_ncdf, vv1, vv2, vv3, vv4, filename=fileoutnc, globattr=glbatt  
    610 ; 
    611 ; @side effects 
    612610; 
    613611; @history  

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

    r370 r378  
    99; 
    1010; @param TAB {in}{required} 
    11 ; 3 or 4d field 
     11; 3d or 4d field 
    1212; 
    1313; @param DIREC {in}{required} 
    … …  
    5858; depth (automatically activated if vargrid eq 'W') 
    5959; 
    60 ; @results 
    61 ; un tableau 
     60; @returns 
     61; an array 
    6262; 
    6363; @uses 

  • trunk/SRC/ToBeReviewed/GRILLE/grille.pro

    r371 r378  
    77; <pro>domdef</pro> (contrarily to  
    88; <pro>grandegrille</pro>) 
     9; 
    910; BEWARE!! The choice of the grid is made from the value of the 
    1011; global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'. 

  • trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro

    r371 r378  
    1919; @keyword YSTRIDE {type=integer}{default=1} 
    2020; It specify that we want to trace only one line of 
    21 ; constant j every xstride points 
     21; constant j every ystride points 
    2222; 
    2323; @keyword OCEAN 

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

    r371 r378  
    88; 
    99; @param NAME {in}{optional}{type=string} 
    10 ; It give the name of the file to be opened. If NAME 
     10; It give the name of the file to be opened.  
     11; 
     12; If NAME 
    1113; does not contain the separating character of directories ('/' under 
    1214; unix for example), the file will be looked for in the current directory. 
    … …  
    1416; @keyword IODIR {type=string} 
    1517; It contains the directory where to go look for the file to be read. 
     18; 
    1619; If NAME does not contain the separating character of directories ('/' under 
    1720; unix for example), the file will be called iodir+nom_fichier. 
    1821; 
    1922; @keyword COUNT {type=vector} 
    20 ; An optional vector containing the counts to be used in 
    21 ; reading Value. COUNT is a 1-based vector with an element for 
    22 ; each dimension of the data to be written.The default matches 
     23; An optional vector containing the counts to be used in reading Value.  
     24; 
     25; COUNT is a 1-based vector with an element for 
     26; each dimension of the data to be written. 
     27; 
     28; The default matches 
    2329; the size of the variable so that all data is written out. 
    2430; 
    2531; @keyword GROUP 
    26 ; The widget ID of the widget that calls XNCDF_LEC. When 
    27 ; this ID is specified, a death of the caller results in a death 
     32; The widget ID of the widget that calls XNCDF_LEC.  
     33; 
     34; When this ID is specified, a death of the caller results in a death 
    2835; of XNCDF_LEC. 
    2936; 
    3037; @keyword OFFSET {type=vector}{default=[0, 0,...]} 
    3138; An optional vector containing the starting position 
    32 ; for the read. The default start position is [0, 0, ...]. 
     39; for the read. 
    3340; 
    3441; @keyword SHIFT {type=vector}{default=[0, 0,...]} 
    3542; A vector of integers, specifying for each dimension how much we have to shift it. 
    36 ; By default, it is [0,0,...]. See the function <proidl>shift</proidl> for more explanations. BEWARE, 
     43; 
     44; See the function <proidl>SHIFT</proidl> for more explanations.  
     45; 
     46; BEWARE, 
    3747; the shift is done on the biggest array before a possible reduction determined 
    38 ; by OFFSET and COUNT. On the other hand, it is done after the possible extraction 
     48; by OFFSET and COUNT.  
     49; 
     50; On the other hand, it is done after the possible extraction 
    3951; created by the STRIDE. 
    4052; 
    4153; @keyword STRIDE {type=vector}{default=[1, 1,...]} 
    4254; An optional vector containing the strides, or sampling 
    43 ; intervals, between accessed values of the netCDF variable. The 
    44 ; default stride vector is that for a contiguous read, [1, 1,...]. 
     55; intervals, between accessed values of the netCDF variable. 
    4556; 
    4657; @returns 
    4758;  2 different cases: 
    48 ;       1) None attribute has been selected. In this case, res is the array we 
    49 ;       wanted to read. 
    50 ;       2) Some attributes has been selected. In this case, res is a structure 
    51 ;       whose the first element having the name of the variable is the values 
    52 ;       array and the other arguments are the select arguments. 
     59;  1) None attribute has been selected. In this case, res is the array we 
     60;     wanted to read. 
     61;  2) Some attributes has been selected. In this case, res is a structure 
     62;     whose the first element having the name of the variable is the values 
     63;     array and the other arguments are the select arguments. 
    5364; 
    5465; @uses 
    … …  
    387398; created by xncdf_lec and which has allowed to select the variable to be read. 
    388399; 
    389 ; @results 
     400; @returns 
    390401; indirectement res (le tableau ou la structure resultat) 
    391402; 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro

    r371 r378  
    1212;         will be automatically performed. 
    1313;         2) a structure respecting all criterions specified by 
    14 ;         <pro>litchamp</pro> cf. IDL> xhelp,'litchamp' 
     14;         <pro>litchamp</pro> 
    1515; 
    1616; @param PARAM2 {in}{optional}{default=min of tab1 (on ocean points)} 
    … …  
    102102; We use it when we want to do a projection. 
    103103; This keyword can be of two types: 
    104 ;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>map_set</proidl>). 
     104;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>MAP_SET</proidl>). 
    105105;     /MAP: In this case, map is automatically calculated have the value: 
    106106;          map = [0, (lon1+lon2)/2., 0] 
    … …  
    115115; 
    116116; @keyword LABMAP {default=labmap=1} 
    117 ; Corresponds to LABEL keyword of <proidl>map_set</proidl>. 
     117; Corresponds to LABEL keyword of <proidl>MAP_SET</proidl>. 
    118118; 
    119119; @keyword MAXIN 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt1d.pro

    r367 r378  
    99; @param TAB {in}{required} 
    1010; The field whose we want to make the hovmoeller map can be 2 kind of thing: 
    11 ;       1) An array which can be: 
    12 ;          * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass 
    13 ;          in moyenne or grossemoyenne to be averaged and become  an array 1d. 
    14 ;          * 1d:Nevertheless, the type must be specified in order to we know which trace 
    15 ;          it is about. To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    16 ;       2) a structure respecting all criterions specified by <pro>litchamp</pro> 
    17 ;          See IDL> xhelp,'litchamp'. The array contained in the structure 
    18 ;          respecting criterions of case 1) 
     11; 1) An array which can be: 
     12; 
     13;   * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array  
     14;     will pass in <pro>moyenne</pro> or <pro>grossemoyenne</pro> to be  
     15;     averaged and become an array 1d. 
     16;   * 1d:Nevertheless, the type must be specified in order to we know which  
     17;     trace it is about. To have a correct caption, respecify the extraction  
     18;     zone via BOXZOOM. 
     19; 2) a structure respecting all criterions specified by <pro>litchamp</pro> 
     20;    The array contained in the structure respecting criterions of case 1) 
    1921; 
    2022; @param PARAM2 {in}{required} 
    … …  
    3133; 
    3234; @keyword BOXZOOM 
    33 ; Vector indicating the geographic zone (3d) on which the extraction of the field must 
    34 ; be done to do the hovmoeller. 
    35 ;  If BOXZOOM has : 
     35; Vector indicating the geographic zone (3d) on which the extraction of the  
     36; field must be done to do the hovmoeller. 
     37; 
     38; If BOXZOOM has : 
    3639; 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 
    3740; 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 
    … …  
    4043; 6 elements: The extraction is made on Boxzoom 
    4144; 
    42 ; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last  
    43 ; <pro>domdef</pro> ! 
     45; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at  
     46; the last <pro>domdef</pro> ! 
    4447; 
    4548; @keyword COL1D 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltt.pro

    r370 r378  
    99; @param TAB {in}{required} 
    1010; The field whose we want to make the hovmoeller map can be 2 kind of thing: 
    11 ;       1) An array which can be: 
    12 ;          * 3d or 4d: array  'xt','yt','zt','t'. The last component is the time. In this case, the array will 
    13 ;            pass in <pro>grossemoyenne</pro> to be averaged and become an 1d or 2d array. 
    14 ;          * 2d: If the array is already 2d, it is not modified (beware, lands must 
    15 ;            be masked at the value valmask) and nevertheless, type must be specified 
    16 ;            to we know of which trace it is about. 
    17 ;            To have a correct caption, respecify the extraction zone via BOXZOOM. 
    18 ;          * 1d: only for traces of the 't' type. Nevertheless, type must be specified 
    19 ;            to we know of which trace it is about. 
    20 ;            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    21 ;       2) a structure respecting all criterions specified by <pro>litchamp</pro> 
    22 ;          See IDL> xhelp,'litchamp'. The array contained in the structure 
    23 ;          respecting criterions of case 1) 
    24 ; 
     11; 
     12; 1) An array which can be: 
     13;    * 3d or 4d: array  'xt','yt','zt','t'. The last component is the time. In this case, the array will 
     14;    pass in <pro>grossemoyenne</pro> to be averaged and become an 1d or 2d array. 
     15;    * 2d: If the array is already 2d, it is not modified (beware, lands must 
     16;    be masked at the value valmask) and nevertheless, type must be specified 
     17;    to we know of which trace it is about. 
     18;    To have a correct caption, respecify the extraction zone via BOXZOOM. 
     19; 
     20;    * 1d: only for traces of the 't' type. Nevertheless, type must be specified 
     21;      to we know of which trace it is about. 
     22;      To have a correct caption, respecify the  extraction zone via BOXZOOM. 
     23; 2) a structure respecting all criterions specified by <pro>litchamp</pro> 
     24;    The array contained in the structure respecting criterions of case 1) 
    2525;  
    2626; @param GIVENTYPE 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltv.pro

    r371 r378  
    1414;       (as it is done in plt). 
    1515;    2) a structure respecting all criterions specified by 
    16 ;       <pro>litchamp</pro> cf. IDL> xhelp,'litchamp' 
     16;       <pro>litchamp</pro> 
    1717; 
    1818; @param MIN {in}{optional}{default=min of DATA (on non-masked points)} 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltz.pro

    r370 r378  
    99; @param TAB 
    1010; The field whose we want to make a vertical cut can be 2 kind of thing: 
    11 ;         1) An 2d or 3d array. 
    12 ;         If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
    13 ;         If the field is 3d, we extract the section on we average possibly before to do the plot. 
    14 ;         2)  a structure respecting all criterions specified by <pro>litchamp</pro>. 
    15 ;          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    16 ; 
     11; 1) An 2d or 3d array. 
     12;    If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
     13;    If the field is 3d, we extract the section on we average possibly before to do the plot. 
     14; 2) a structure respecting all criterions specified by <pro>litchamp</pro>. 
     15;    The array contained in the structure must be 2 or 3d (See case 1) 
    1716; 
    1817; @param GIVENTYPE 

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

    r370 r378  
    33; @file_comments 
    44; Add an axis when we do an oblique section in <pro>pltz</pro>,  
    5 ; <pro>pltt</pro> 
    6 ; or <pro>plt1d</pro> 
     5; <pro>pltt</pro> or <pro>plt1d</pro> 
    76; 
    87; @categories 

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

    r367 r378  
    3333; Used to pass keywords 
    3434; 
    35 ; Others: see pltz 
     35; Others: see <pro>pltz</pro> 
    3636; 
    3737; @history 

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

    r370 r378  
    1515; 
    1616; @param NAME {in}{optional}{type=string} 
    17 ; It gives the name of the file to be opened. If NAME 
     17; It gives the name of the file to be opened.  
     18; 
     19; If NAME 
    1820; does not contain the separating character of directories ('/' under 
    1921; unix for example), the file will be looked for in the current directory. 
    … …  
    142144; 
    143145; @param FIELD {in}{required}{type=field} 
    144 ; It respect <pro>litchamp</pro>'s criterions. See IDL>xhelp,'litchamp' 
     146; It respect <pro>litchamp</pro>'s criterions. 
    145147; 
    146148; @param PROCEDURE {in}{required} 
    … …  
    152154; @keyword BOXZOOM {type=vector} 
    153155; Vector indicating the geographic zone on which we want to cut the map. 
     156; 
    154157;  If BOXZOOM has : 
    155158; 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 
    … …  
    168171; @keyword VECTEUR{type=vector} 
    169172; It is a structure composed by 2 elements containing the 2 fields U 
    170 ; and V of values of the zonal and meridian component of the vector of the fields 
    171 ; to draw. These fields can be an array or a structure. 
    172 ;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    173 ;       Comment: name of elements of vectors are inconsequential. 
    174 ;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
     173; and V of values of the zonal and meridian component of the vector of  
     174; the fields to draw. 
     175; 
     176; These fields can be an array or a structure. 
     177; For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
     178; 
     179; Comment: name of elements of vectors are inconsequential. 
     180;  vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
    175181; 
    176182; @keyword _EXTRA 

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

    r370 r378  
    4848; $Id$ 
    4949; 
    50 ; @todo seb: manque les param glam et gphi 
     50; @todo 
     51; seb: manque les param glam et gphi 
    5152; 
    5253;- 

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

    r370 r378  
    33; @file_comments 
    44; allows to trace the independently from a graph 
     5; 
    56; By default, trace a color bar of the same type than the one present in  
    67; <pro>plt</pro> 
    78; and <pro>pltz</pro>. 
     9; 
    810; If max, min and divisions are not stipulated, then max=sup,min=inf 
    911; and divisions=div. 

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

    r371 r378  
    1313; @param POSFENETRE {out}{type=vector} 
    1414; containing captions and the graph in normalized coordinates. 
     15; 
    1516; Comment: To position the drawing, we have to do !p.position=posfenetre 
    1617; after the call of the caliber 
    … …  
    1819; @param POSBAR {out}{type=vector} 
    1920; Like POSFENETRE but for the color bar. 
     21; 
    2022; Same comment to position the color bar, !p.position=posbar 
    2123; 
    … …  
    3234; @keyword MAP 
    3335; We use it when we want to do a projection. 
     36; 
    3437; This keyword can be of two types: 
    35 ;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>map_set</proidl>). 
     38;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>MAP_SET</proidl>). 
    3639;     /MAP: In this case, map is automatically calculated have the value: 
    3740;          map = [0, (lon1+lon2)/2., 0] 
     41; 
    3842; Comment 1: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    3943;   IDL> demo 
    4044; Then choose "Mapping" and "Global Mapping Demo" 
     45; 
    4146; Comment 2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
    4247; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
     48; 
    4349; For example, for a polar projection centered on the south pole: 
    4450;   IDL> domdef,-180,180,-90,-45 
    … …  
    5763; Vector composed of 3 or 4 elements, applied to make a drawing on a 
    5864; small portion of a page or screen. It delimit the zone where the drawing will be done. 
    59 ;     If there is 4 elements: 
    60 ; then is constituted of coordinates (expressed in cm located from the up and 
    61 ; left corner of the page or the window (in portrait like in landscape) of the bottom 
    62 ; and left corner and of the up and right corner of the drawing zone. 
    63 ;     If there is 3 elements: 
    64 ; in this case, we divide the page or the screen in small[0] columns and in small[1] lines 
    65 ; the drawing made in the box numbered small[2]. The numerotation starting up and left by 
     65; 
     66; If there is 4 elements then is constituted of coordinates (expressed in cm  
     67; located from the up and left corner of the page or the window (in portrait  
     68; like in landscape) of the bottom and left corner and of the up and right  
     69; corner of the drawing zone. 
     70; 
     71; If there is 3 elements, we divide the page or the screen in small[0] columns  
     72; and in small[1] lines, the drawing is made in the box numbered small[2].  
     73; 
     74; The numerotation starting up and left by 
    6675; the number 1 and then, following the writing direction. 
    67 ; By default, we make the largest drawing we can do, conserving the aspect ratio  
    68 ; (except when REMPLI is activated). 
     76; 
     77; By default, we make the largest drawing we can do, conserving the aspect  
     78; ratio (except when REMPLI is activated). 
    6979; 
    7080; @keyword PORTRAIT 
    … …  
    7282; 
    7383; @keyword POST 
    74 ; Make a postscript. Only works if we made one drawing on the page. 
     84; Make a postscript.  
     85; 
     86; Only works if we made one drawing on the page. 
     87; 
    7588; If we make several drawing, use \@<pro>ps</pro>. 
    7689; 
    … …  
    8093; @keyword WINDOW 
    8194; Number of the window on which we want to do the graph (Allow to open several windows). 
     95; 
    8296; By default, we open 'IDL0' 
    8397; 
    … …  
    88102; If we want to trace contours of a different field than the one 
    89103; whose we have the colored drawing (by example E-P in color and QSR in contours). 
     104; 
    90105; It must be a field respecting same characteristics than the argument number  
    91106; one of <pro>plt</pro>. 
    92107; 
    93108; @keyword ENDPOINTS 
    94 ; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
    95 ; of these ones are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
    96 ; coordinates. 
     109; keyword specifying that we want to make a vertical cut in diagonal.  
     110; 
     111; Then coordinated of extremities of these ones are defined by the 4 elements  
     112; of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates. 
    97113; 
    98114; @keyword VECTEUR {type=vector} 
    99115; It is a structure composed by 2 elements containing the 2 fields U 
    100116; and V of values of the zonal and meridian component of the vector of the fields 
    101 ; to draw. These fields can be an array or a structure. 
    102 ;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    103 ;       Comment: name of elements of vectors are inconsequential. 
     117; to draw.  
     118; 
     119; These fields can be an array or a structure. 
     120; 
     121; For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
     122; 
     123; Comment: name of elements of vectors are inconsequential. 
    104124;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
    105125; 
    106126; @keyword DIREC 
    107127; 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 
    108 ;       'xzt' 'yzt' 'xyzt' Direction on which do averages 
     128; 'xzt' 'yzt' 'xyzt' Direction on which do averages 
    109129; 
    110130; @keyword _EXTRA 
    … …  
    112132; 
    113133; @keyword COLOR_C 
    114 ; To draw the contour in color instead of in black 
    115 ; with filling in color 
     134; To draw the contour in color instead of in black with filling in color 
    116135; 
    117136; @uses 

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

    r370 r378  
    1010; @param STRUCT {in}{required} 
    1111; a structure like the one who read <pro>litchamp</pro>. 
    12 ;        See IDL> xhelp,'litchamp' 
    1312; 
    1413; @uses 
    … …  
    1716; @restrictions 
    1817; Change the value if global variables attribute of a field: vargrid, 
    19 ; varname, varunit, vardate, varexp , valmask and time. 
     18; varname, varunit, vardate, varexp, valmask and time. 
    2019; 
    2120; @history 

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

    r370 r378  
    22; 
    33; @file_comments 
    4 ; Allows to put in a structure attributes which can be associated with a variable. 
     4; Allows to put in a structure attributes which can be associated with  
     5; a variable. 
    56; 
    67; @categories 

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

    r370 r378  
    88; 
    99; @keyword POST 
    10 ; Make a postscript. Only works if we made one drawing on the page. 
     10; Make a postscript.  
     11; 
     12; Only works if we made one drawing on the page. 
    1113; If we make several drawing, use \@<pro>ps</pro>. 
    1214; 
    1315; @keyword SMALL {type=vector} 
    1416; Vector composed of 3 or 4 elements, applied to make a drawing on a 
    15 ; small portion of a page or screen. It delimit the zone where the drawing will be done. 
    16 ;     If there is 4 elements: 
    17 ; then is constituted of coordinates (expressed in cm located from the up and 
    18 ; left corner of the page or the window (in portrait like in landscape)) of the bottom 
    19 ; and left corner and of the up and right corner of the drawing zone. 
    20 ;     If there is 3 elements: 
    21 ; in this case, we divide the page or the screen in small[0] columns and in small[1] lines 
    22 ; the drawing made in the box numbered small[2]. The numerotation starting up and left by 
    23 ; the number 1 and then, following the writing direction. 
    24 ; By default, we make the largest drawing we can do, conserving the aspect ration  
    25 ; (except when REMPLI is activated). 
     17; small portion of a page or screen.  
     18; 
     19; It delimit the zone where the drawing will be done. 
     20; 
     21; If there is 4 elements then is constituted of coordinates (expressed in cm  
     22; located from the up and left corner of the page or the window (in portrait  
     23; like in landscape)) of the bottom and left corner and of the up and right  
     24; corner of the drawing zone. 
     25; 
     26; If there is 3 elements we divide the page or the screen in small[0] columns  
     27; and in small[1] lines and the drawing is made in the box numbered small[2].  
     28; 
     29; The numerotation starting up and left by the number 1 and then, following  
     30; the writing direction. 
     31; 
     32; By default, we make the largest drawing we can do, conserving the aspect  
     33; ration (except when REMPLI is activated). 
    2634; 
    2735; @keyword _EXTRA 

  • trunk/SRC/ToBeReviewed/PLOTS/legende.pro

    r369 r378  
    1414; 
    1515; @param COUPE {type=string} 
    16 ; Character containing two letters giving the type of the cut  (for example: 'xz'). 
     16; Character containing two letters giving the type of the cut for example: 'xz' 
    1717; 
    1818; @keyword CONTOUR 
    1919; If we want to trace contours of a different field than the one 
    2020; whose we have the colored drawing (by example E-P in color and QSR in contours). 
    21 ; It must be a field respecting same characteristics than the argument number one of plt. 
     21; 
     22; It must be a field respecting same characteristics than the argument number  
     23; one of plt. 
    2224; 
    2325; @keyword ENDPOINTS 
    … …  
    3133; 
    3234; @restrictions 
    33 ; The use of the global variable language allows to change the language and the caption easily. 
     35; The use of the global variable language allows to change the language and  
     36; the caption easily. 
    3437; 
    3538; @history 

  • trunk/SRC/ToBeReviewed/PLOTS/style.pro

    r325 r378  
    4949;    3 : Solid-Bold, solid-thin, dash Dot-thin, solid-thin, Solid-Bold... 
    5050;    4 : Solid-very-thin, except for contour O, that is solid-bold 
     51; 
    5152; 2) for the labelstyle based on a threshold value (with a style 
    52 ;before and after the threshold value and a bold solid line for the 
    53 ;value itself, a more general definition can be given with a scalar 
    54 ;string with the following structure: 'xxNN...NNyy' with   
    55 ; xx and yy correspondind to one the following choices (with the corresponding meaning) 
     53;    before and after the threshold value and a bold solid line for the 
     54;    value itself, a more general definition can be given with a scalar 
     55;    string with the following structure: 'xxNN...NNyy' with   
     56;    xx and yy correspondind to one the following choices (with the  
     57;    corresponding meaning) 
    5658;               so -> Solid      
    5759;               do -> Dotted     

  • trunk/SRC/ToBeReviewed/PLOTS/symbols.pro

    r325 r378  
    44; Create custom plotting symbols 
    55; 
    6 ; @param NSYM {in}{required} 
    7 ;        
    8 ;                1 = open circle 
    9 ;                2 = filled circle 
    10 ;                3 = arrow pointing right 
    11 ;                4 = arrow pointing left 
    12 ;                5 = arrow pointing up 
    13 ;                6 = arrow pointing down 
    14 ;                7 = arrow pointing up and left (45 degrees) 
    15 ;                8 = arrow pointing down and left 
    16 ;                9 = arrow pointing down and right. 
    17 ;                10 = arrow pointing up and right. 
    18 ;                11 through 18 are bold versions of 3 through 10 
    19 ;                19 = horizontal line 
    20 ;                20 = box 
    21 ;                21 = diamond 
    22 ;                22 = triangle 
    23 ;                30 = filled box 
    24 ;                31 = filled diamond 
    25 ;                32 = filled triangle 
    26 ;                
     6; @param NSYM {in}{required} {type=integer} 
     7; Code of sympbols : 
     8; 1 = open circle 
     9; 2 = filled circle 
     10; 3 = arrow pointing right 
     11; 4 = arrow pointing left 
     12; 5 = arrow pointing up 
     13; 6 = arrow pointing down 
     14; 7 = arrow pointing up and left (45 degrees) 
     15; 8 = arrow pointing down and left 
     16; 9 = arrow pointing down and right. 
     17; 10 = arrow pointing up and right. 
     18; 
     19; 11 through 18 are bold versions of 3 through 10 
     20; 
     21; 19 = horizontal line 
     22; 20 = box 
     23; 21 = diamond 
     24; 22 = triangle 
     25; 30 = filled box 
     26; 31 = filled diamond 
     27; 32 = filled triangle 
     28; 
    2729; @param SCALE {in}{required} 
    2830; size of symbols. 
    … …  
    3032; @keyword COLOR 
    3133; color of symbols 
    32 ;                
     34; 
    3335; @restrictions 
    3436; The desired symbol is stored in the user buffer and 

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

    r370 r378  
    5656;   is too different of the one of SMALLDRAW. 
    5757;   2) YXASPECT=n : multiply by n the aspect ratio given by default. 
    58 ;   For example in <proidl>plt</proidl>, RAPPORTYX is calculated to the  
     58;   For example in <pro>plt</pro>, RAPPORTYX is calculated to the  
    5959;   reference be orthonormal, 
    6060;   to have a reference where the y axis is 2 time bigger than the x one, YXASPECT=2. 

  • trunk/SRC/ToBeReviewed/STATISTICS/skewness_4d.pro

    r335 r378  
    77; 
    88; @param X {in}{required}{type=array} 
    9 ; An Array which last dimension is the time dimension so 
    10 ; size n. 
     9; An array which last dimension is the time dimension so size n. 
    1110; 
    1211; @param NT 
    … …  
    1615; double precision arithmetic. 
    1716; 
     17; @keyword NAN 
     18; 
    1819; @hidden 
    1920; 
    … …  
    2223; 
    2324;- 
    24 FUNCTION Skewness_Num, X, nT, Double = Double,  NAN =  nan 
     25FUNCTION skewness_num, x, nt, DOUBLE = double,  NAN =  nan 
    2526; Compute the numerator of the skewness expression 
    2627; 
    … …  
    4950; 
    5051; @param X {in}{required}{type=array} 
    51 ; An Array which last dimension is the time dimension so 
    52 ; size n. 
     52; An array which last dimension is the time dimension so size n. 
    5353; 
    5454; @keyword DOUBLE 
    … …  
    7575;- 
    7676 
    77 FUNCTION skewness_4d, X, DOUBLE = Double,  NVAL =  nval 
     77FUNCTION skewness_4d, x, DOUBLE = double,  NVAL =  nval 
    7878; 
    7979   compile_opt idl2, strictarrsubs 

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

    r371 r378  
    1717; 
    1818; The function returns an index array similar to the 
    19 ; result of the where function 
     19; result of the <proidl>WHERE</proidl> function 
    2020; 
    2121; @examples 

  • trunk/SRC/Utilities/xhelp.pro

    r375 r378  
    3131;       University of California, Santa Barbara 
    3232;  - 7/1/99 : legeres modification par Sebastien Masson : utilisation de 
    33 ;    <proidl>xdisplayfile</proidl>, de <pro>findfile</pro> et de _extra. 
     33;    <proidl>XDISPLAYFILE</proidl>, de <proidl>FINDFILE</proidl> et de _extra. 
    3434;  - 6/7/1999: compatibility mac and windows 
    3535; 
Note: See TracChangeset for help on using the changeset viewer.