Changeset 264 for trunk


Ignore:
Timestamp:
08/22/07 16:30:29 (17 years ago)
Author:
pinsard
Message:

typo in some pro files

Location:
trunk/SRC
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Grid/ncdf_meshread.pro

    r240 r264  
    1313;    Name of the meshmask file to read. If this name does not contain any "/" 
    1414;    and if iodirectory keyword is not specify, then the common variable 
    15 ;    iodir will be use to define the mesh file path. 
     15;    iodir will be used to define the mesh file path. 
    1616; 
    1717; @keyword GLAMBOUNDARY {default=those defined in the file}{type=2 elements vector} 
    … …  
    2323; 
    2424; @keyword CHECKDAT 
    25 ; Suppressed. Use <pro>micromeshmask</pro> to create an 
    26 ;    appropriate meshmask. 
     25; Suppressed. Use <pro>micromeshmask</pro> to create an appropriate meshmask. 
    2726; 
    2827; @keyword ONEARTH {default=1}{type=scalar: 0 or 1} 
    … …  
    3635; @keyword GETDIMENSIONS {default=0}{type=scalar: 0 or 1} 
    3736;    Activate this keywords if you only want to know the dimension 
    38 ;    of the domain stored in the mesh file. This dimensions will be 
     37;    of the domain stored in the mesh file. This dimension will be 
    3938;    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables) 
    4039; 
    … …  
    5049; 
    5150; @keyword STRCALLING {type=scalar string} 
    52 ;    the calling command used to call computegrid (this is used by <pro>xxx</pro>) 
     51;    the calling command used to call <pro>computegrid</pro> (this is used by <pro>xxx</pro>) 
    5352; 
    5453; @keyword STRIDE {default=[1, 1, 1]}{type=3 elements vector} 
    … …  
    6564; 
    6665; @restrictions 
    67 ; ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 
    68 ; be defined before calling ncdf_meshread. if some of those value 
     66; ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh must 
     67; be defined before calling ncdf_meshread. If some of those values 
    6968; are equal to -1 they will be automatically defined 
    7069; 

  • trunk/SRC/Grid/ncdf_meshroms.pro

    r240 r264  
    1313;    Name of the meshmask file to read. If this name does not contain any "/" 
    1414;    and if iodirectory keyword is not specify, then the common variable 
    15 ;    iodir will be use to define the mesh file path. 
     15;    iodir will be used to define the mesh file path. 
    1616; 
    1717; @keyword GLAMBOUNDARY {default=those defined in the file}{type=2 elements vector} 
    … …  
    3232; @keyword GETDIMENSIONS {default=0}{type=scalar: 0 or 1} 
    3333;    Activate this keywords if you only want to know the dimension 
    34 ;    of the domain stored in the mesh file. This dimensions will be 
     34;    of the domain stored in the mesh file. This dimension will be 
    3535;    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables) 
    3636; 
    … …  
    4242; @keyword NRHO {default=1}{type=scalar} 
    4343;    Specify the number of rho level that contain the data we want to explore. 
    44 ;    This is mainly useful when using xxx to get access to the deeper levers and vertical sections. 
     44;    This is mainly useful when using <pro>xxx</pro> to get access to the deeper levers and vertical sections. 
    4545; 
    4646; @keyword SHIFT {default=computed according to glamboundary}{type=scalar} 
    … …  
    5050; 
    5151; @keyword STRCALLING {type=scalar string} 
    52 ;    the calling command used to call computegrid (this is used by xxx.pro) 
     52;    the calling command used to call <pro>computegrid</pro> (this is used by <pro>xxx</pro>) 
    5353; 
    5454; @keyword STRIDE {default=[1, 1, 1]}{type=3 elements vector} 
    … …  
    6565; 
    6666; @restrictions 
    67 ; ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 
    68 ; be defined before calling ncdf_meshread. if some of those value 
     67; ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh must 
     68; be defined before calling <pro>ncdf_meshread</pro>. If some of those values 
    6969; are equal to -1 they will be automatically defined 
    7070; 
    … …  
    7777; V points and the last line of T and U points. 
    7878; 
    79 ; Scale factors are compuited using the distance between the points 
     79; Scale factors are computed using the distance between the points 
    8080; (which is not the exact definition for irregular grid). 
    8181; 

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

    r254 r264  
    3434; 
    3535; @restrictions 
    36 ; The norm is calculated on points TTo do this calculation, we average 
    37 ; field U and Von points T before calculate the norme. At the edge of 
     36; The norm is calculated on points T. To do this calculation, we average 
     37; field U and V on points T before calculate the norme. At the edge of 
    3838; coast and of domain, we can not calculate fields U and V at points T, 
    3939; that is why these points are at value !values.f_nan. 
    … …  
    5151; @examples 
    5252; To calculate the average of the norme of streams on all the domain 
    53 ; between 0 et 50: 
     53; between 0 and 50: 
    5454;      IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz') 
    5555; 

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

    r254 r264  
    22; 
    33; @file_comments 
    4 ; Draw horizontal graph (map) with CONTOUR procedure 
     4; Draw horizontal graph (map) with <proidl>CONTOUR</proidl> procedure 
    55; 
    66; @categories 
    … …  
    3535; 6 elements: The extraction is made on Boxzoom 
    3636; 
    37 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     37; Where lon1, lon2, lat1, lat2 are global variables defined at the last 
    3838; <pro>domdef</pro> ! 
    3939; 
    4040; @keyword REALCONT 
    41 ; Allow to draw continents defined in IDL. REALCONT can have 2 form: 
     41; Allow to draw continents defined in IDL. REALCONT can have 2 forms: 
    4242;           /REALCONT: we draw continents in place of the mask 
    4343;           REALCONT=2 we draw continent's contour over the mask (this allows 
    … …  
    6666; 
    6767; @keyword CONTNLEVEL {default=20} 
    68 ; When  CONTOUR is activated, it is the number of contours 
     68; When CONTOUR is activated, it is the number of contours 
    6969; traced by a trait for drawing (active if 
    7070; CONTLABEL=0) 
    … …  
    7373; If we want to trace contours of a different field than the one 
    7474; whose we have the colored drawing (by example E-P in color and QSR in contours). 
    75 ; It must be a field respecting same characteristics than the argument number one of plt. 
    76 ; 
    77 ; @keyword GRIDTYPE 'U','T','V','W' or 'F' to specify possibly the grid on which the field is joined. 
     75; It must be a field respecting same characteristics than the argument number one of <pro>plt</pro>. 
     76; 
     77; @keyword GRIDTYPE 
     78; 'U','T','V','W' or 'F' 
     79; to specify possibly the grid on which the field is joined. 
    7880; Comment: In this case, we should use a structure like field. 
    7981; 
    8082; @keyword INTERVALLE 
    81 ; Value of an internal between to isoline. If there is none specified min, 
    82 ; we choose a min contour which goes well with the specified interval!. If this keyword is not 
    83 ; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated, 
    84 ; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval 
     83; Value of an interval between to isoline. If there is none specified min, 
     84; we choose a min contour which goes well with the specified interval! 
     85; If this keyword is not specified, we trace 20 isolines from the min 
     86; to the max. 
     87; Comment: When CONTOUR is activated, INTERVALLE only specify the interval 
     88; between 2 colored isolines. To specify the interval 
    8589; between 2 isolines traced by a trait, use CONTINTERVALLE. 
    8690; 
    … …  
    98102; We use it when we want to do a projection. 
    99103; This keyword can be of two types: 
    100 ;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET). 
     104;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>MAP_SET</proidl>). 
    101105;     /MAP: In this case, map is automatically calculated have the value: 
    102106;          map = [0, (lon1+lon2)/2., 0] 
    103107; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    104108; IDL> demo 
    105 ; Then choose earth sciences and  mapping. 
    106 ; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
     109; Then choose "earth sciences and mappinA"g 
     110; Comment2: By default it is a cylindrical projection which is done (with or without the keyword map). 
    107111; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    108112; For example, for a polar projection centered on the south pole: 
    … …  
    111115; 
    112116; @keyword LABMAP {default=labmap=1} 
    113 ; Corresponds to label keywords of map_set. 
     117; Corresponds to LABEL keyword of <proidl>MAP_SET</proidl>. 
    114118; 
    115119; @keyword MAXIN 
    … …  
    124128; 
    125129; @keyword NLEVEL {default=20} 
    126 ; Number of contour to draw by default =20. active if 
    127 ; LABEL=0 or is not specified. 
     130; Number of contour to draw. Active if LABEL=0 or is not specified. 
    128131; 
    129132; @keyword NOFILL 
    … …  
    152155; @keyword VECTEUR {type=struct} 
    153156; It is a structure composed by 2 elements containing the 2 fields U 
    154 ; and V of values of the zonal and meridian component of the vector of the fields 
     157; and V of values of the zonal and meridian components of the vector of the fields 
    155158; to draw. These fields can be an array or a structure. 
    156159;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    … …  
    271274  IF  strupcase(vargrid) EQ 'W' THEN profond = firstzw NE 0 $ 
    272275  ELSE profond = firstzt NE 0 
    273 ; do we need to extract now the triangulation that will be use for 
     276; do we need to extract now the triangulation that will be used for 
    274277; contouring the field? 
    275278  if keyword_set(profond) $ 

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

    r254 r264  
    1010;       1) An array which can be: 
    1111;          * 3d or 4d: array  'xt','yt','zt','t'. The last component is the time. In this case, the array will 
    12 ;            pass in grossemoyenne to be averaged and become an 1d or 2d array. 
     12;            pass in <pro>grossemoyenne</pro> to be averaged and become an 1d or 2d array. 
    1313;          * 2d: If the array is already 2d, it is not modified (beware, lands must 
    14 ;            be masked at the value valmask) and nevertheless,type must be specified 
     14;            be masked at the value valmask) and nevertheless, type must be specified 
    1515;            to we know of which trace it is about. 
    16 ;            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
     16;            To have a correct caption, respecify the extraction zone via BOXZOOM. 
    1717;          * 1d: only for traces of the 't' type. Nevertheless, type must be specified 
    1818;            to we know of which trace it is about. 
    … …  
    2222;          respecting criterions of case 1) 
    2323; 
    24 ; PARAM:         
    25 ;       MAX: valeur maximum que l''on veut prendre en compte dans le trace 
     24;  
     25; @param GIVENTYPE 
     26; 
     27; @param GIVENMIN 
     28; valeur minimum que l''on veut prendre en compte dans le trace 
     29; des contours. Par defaut on prend le min de tableau (sur les pts mer) 
     30; 
     31; @param GIVENMAX 
     32: valeur maximum que l''on veut prendre en compte dans le trace 
    2633; des contours. Par defaut on prend le max de tableau (sur les pts mer) 
    2734; 
    28 ;       MIN: valeur minimum que l''on veut prendre en compte dans le trace 
    29 ; des contours. Par defaut on prend le min de tableau (sur les pts 
    30 ; mer) 
    31 ; 
    32 ;       DATMIN: c''est la borne inf de l''axe temporel. c''est un 
     35; @param DATMIN 
     36: c''est la borne inf de l''axe temporel. c''est un 
    3337;       longinteger de la forme yyyymmdd (ou bien yymmdd). 
    3438; 
    35 ;       DATMAX: c''est la borne max de l''axe temporel. c''est un 
     39; @param DATMAX 
     40; c''est la borne max de l''axe temporel. c''est un 
    3641;       longinteger de la forme yyyymmdd (ou bien yymmdd) 
    3742; 
    … …  
    9297; 
    9398; @keyword INTERVALLE 
    94 ; Value of an internal between to isoline. If there is none specified min, 
     99; Value of an interval between two isolines. If there is none specified min, 
    95100; we choose a min contour which goes well with the specified interval!. If this keyword is not 
    96101; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated, 
    97 ; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval 
     102; INTERVALLE only specify the interval between 2 colored isolines. To specify the interval 
    98103; between 2 isolines traced by a trait, use CONTINTERVALLE. 
    99104; 
    … …  
    123128; 
    124129; @keyword NLEVEL {default=20} 
    125 ; Number of contour to draw by default =20. active if 
     130; Number of contours to draw. active if 
    126131; LABEL=0 or is not specified. 
    127132; 
    … …  
    130135; 
    131136; @keyword CONTNLEVEL {default=20} 
    132 ; When  CONTOUR is activated, it is the number of contours 
     137; When CONTOUR is activated, it is the number of contours 
    133138; traced by a trait for drawing (active if 
    134139; CONTLABEL=0). 
    … …  
    190195; $Id$ 
    191196; 
    192 ; @todo seb: L.24 à 36, L.426 à 427, L. 492 à 493 
     197; @todo  
     198; seb: definition of parameters, L.426 à 427, L. 492 à 493 
    193199;- 
    194200; 

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

    r254 r264  
    1515;          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    1616; 
    17 ; ces arguments ne sont pas obligatoires: 
    18 ; 
    19 ;       MAX: valeur maximum que l'on veut prendre en compte dans le trace 
     17; 
     18; @param GIVENTYPE 
     19; 
     20; @param GIVENMIN {required} 
     21; valeur minimum que l'on veut prendre en compte dans le trace 
     22; des contours. Par defaut on prend le min de tab1 (sur les pts mer) 
     23; 
     24; @param GIVENMAX {required} 
     25: valeur maximum que l'on veut prendre en compte dans le trace 
    2026; des contours. Par defaut on prend le max de tab1 (sur les pts mer) 
    21 ; 
    22 ;       MIN: valeur minimum que l'on veut prendre en compte dans le trace 
    23 ; des contours. Par defaut on prend le min de tab1 (sur les pts mer) 
    2427; 
    2528; @keyword BOXZOOM 
    … …  
    7275; 
    7376; @keyword INTERVALLE 
    74 ; Value of an internal between to isoline. If there is none specified min, 
     77; Value of an interval between two isolines. If there is none specified min, 
    7578; we choose a min contour which goes well with the specified interval!. If this keyword is not 
    7679; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated, 
    77 ; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval 
     80; INTERVALLE only specify the interval between 2 colored isolines. To specify the interval 
    7881; between 2 isolines traced by a trait, use CONTINTERVALLE. 
    7982; 
    … …  
    102105; 
    103106; @keyword NLEVEL {default=20} 
    104 ; Number of contour to draw by default =20. active if 
     107; Number of contours to draw. active if 
    105108; LABEL=0 or is not specified. 
    106109; 
    … …  
    157160; $Id$ 
    158161; 
    159 ; @todo seb L.20 à 26, L.215 à 221 
     162; @todo  
     163; seb definition of parmaters L.215 à 221 
    160164; 
    161165;- 
Note: See TracChangeset for help on using the changeset viewer.