Changeset 237 for trunk/SRC/ToBeReviewed


Ignore:
Timestamp:
03/26/07 17:37:03 (17 years ago)
Author:
pinsard
Message:

replace some print by some report in some .pro (continuation) + improvements/corrections of some *.pro headers

Location:
trunk/SRC/ToBeReviewed
Files:
17 edited

Legend:

Unmodified
Added
Removed

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

    r232 r237  
    3333; 
    3434; @keyword NODOMDEF 
    35 ; We activate it if we do not want to pass in domdef even if the keyword 
    36 ; boxzoom is present (like when grossemoyenne is called via checkfield) 
     35; We activate it if we do not want to pass in <pro>domdef</pro> even if the  
     36; keyword boxzoom is present (like when <pro>grossemoyenne</pro> is called via  
     37; <pro>checkfield</pro>) 
    3738; 
    3839; @keyword INTEGRATION 

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

    r232 r237  
    3131; 
    3232; @keyword NODOMDEF 
    33 ; We activate it if we do not want to pass in domdef even if the keyword boxzoom 
    34 ; is present (like when grossemoyenne is called via checkfield) 
     33; We activate it if we do not want to pass in <pro>domdef</pro> even if the  
     34; keyword boxzoom is present (like when <pro>grossemoyenne</pro> is called  
     35; via <pro>checkfield</pro>) 
    3536; 
    3637; @keyword INTEGRATION 

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

    r232 r237  
    3131; 
    3232; @examples 
    33 ;      IDL> sbar_plot, indgen(10),small = [2,2,2],/rempli 
    34 ;      IDL> sbar_plot, indgen(10),small = [2,2,3],/noerase 
    35 ;      IDL> \@ps 
     33; IDL> sbar_plot, indgen(10),small = [2,2,2],/rempli 
     34; IDL> sbar_plot, indgen(10),small = [2,2,3],/noerase 
     35; IDL> \@ps 
    3636; 
    3737; @history 

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

    r231 r237  
    1818; 
    1919; @examples 
    20 ;      IDL> z = dist(100) 
    21 ;      IDL> scontour, z, nlevels=10,small=[1,2,1],xstyle=1,ystyle=1 
    22 ;      IDL> \@ps 
     20; IDL> z = dist(100) 
     21; IDL> scontour, z, nlevels=10,small=[1,2,1],xstyle=1,ystyle=1 
     22; IDL> \@ps 
    2323; 
    2424; @history 

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

    r231 r237  
    2222; 
    2323; @examples 
    24 ;      IDL> splot, indgen(10),ystyle=1,small=[1,2,1],/portrait 
    25 ;      IDL> splot, -indgen(10),ystyle=1,small=[1,2,2],/noerase 
    26 ;      IDL> \@ps 
     24; IDL> splot, indgen(10),ystyle=1,small=[1,2,1],/portrait 
     25; IDL> splot, -indgen(10),ystyle=1,small=[1,2,2],/noerase 
     26; IDL> \@ps 
    2727; 
    2828; @history 

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

    r231 r237  
    22; 
    33; @file_comments 
    4 ; Add an axis when we do an oblique section in pltz, pltt 
    5 ; or plt1d 
     4; Add an axis when we do an oblique section in <pro>pltz</pro>,  
     5; <pro>pltt</pro> 
     6; or <pro>plt1d</pro> 
    67; 
    78; @categories 

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

    r231 r237  
    88; Graphics 
    99; 
    10 ; @param MIN {in}{required} 
    11 ; A reel number specifying above what value we want to trace a contour 
     10; @param MIN {in}{required} {type=float} 
     11; above what value we want to trace a contour 
    1212; 
    13 ; @param MAX {in}{required} 
    14 ; A reel number specifying below what value we want to trace a contour 
     13; @param MAX {in}{required} {type=float} 
     14; below what value we want to trace a contour 
    1515; 
    16 ; @param CI. {out}{type=real} 
    17 ; It is a reel number giving the contour interval. Use it in CONTOUR with the keyword LEVEL. 
     16; @param CI {out} {type=real} 
     17; the contour interval. Use it in <proidl>CONTOUR</proidl> with the  
     18; keyword LEVEL. 
    1819; 
    1920; @restrictions 
    2021; CI is a multiple of the unity in unity log of 10. 
    21 ; It force the number of contour to be even. 
     22; It force the number of contours to be even. 
    2223; 
    2324; @history 
    … …  
    3132PRO autoscale, min, max, ci 
    3233; 
    33 ;  Estimation of a first CI, notice the presence of the floor (Inferior round) 
    34 ; This CI is a multiple of the unity in unity log of 10. 
    35 ; 
    36 ; 
    3734  compile_opt idl2, strictarrsubs 
    3835; 
     36; Estimation of a first CI, notice the presence of the floor (Inferior round) 
     37; This CI is a multiple of the unity in unity log of 10. 
    3938    ci = (max-min)/20. 
    4039    ci = 10.^floor(alog10(ci)) 

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

    r232 r237  
    55; 
    66; @param MASK {in}{required} 
    7 ;  3d mask 
     7; 3d mask 
    88; 
    99; @param GLAM {in}{required} 
    … …  
    1717; 
    1818; @keyword XXAXIS 
    19 ; to get the xaxis we need to use in pltbase 
     19; to get the xaxis we need to use in <pro>pltbase</pro> 
    2020; 
    2121; @keyword ZZAXIS 
    22 ; to get the yaxis we need to use in pltbase 
     22; to get the yaxis we need to use in <pro>pltbase</pro> 
    2323; 
    2424; @keyword SIN 
    … …  
    3333; Used to pass keywords 
    3434; 
    35 ;  Others: see pltz 
    36 ; 
     35; Others: see pltz 
    3736; 
    3837; @history 

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

    r232 r237  
    99; @param COLNUMB 
    1010; 
    11 ; 
    1211; @param CLBINF 
    13 ; 
    1412; 
    1513; @param CLBSUP 
    1614; 
    17 ; 
    1815; @param CLBDIV 
    19 ; 
    2016; 
    2117; @keyword NOCOLORBAR 
    2218; 
    23 ; 
    2419; @keyword CB_TITLE 
    25 ; 
    2620; 
    2721; @keyword NOFILL 
    2822; 
    29 ; 
    30 ; @keyword COLOR_c 
    31 ; 
     23; @keyword COLOR_C 
    3224; 
    3325; @keyword MIN 
    … …  
    3931; @keyword DIVISIONS 
    4032; 
    41 ; 
    4233; @keyword CB_SUBTITLE 
    4334; 
    44 ; 
    4535; @keyword POST 
    46 ; 
    4736; 
    4837; @keyword _EXTRA 
    … …  
    6150; @todo 
    6251; seb: mettre les keyword et les param 
     52; 
    6353;- 
    6454; 

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

    r232 r237  
    2929; @version 
    3030; $Id$ 
     31; 
    3132;- 
    3233; 
    … …  
    6768; @version 
    6869; $Id$ 
     70; 
    6971;- 
    7072; 
    … …  
    160162; 6 elements: The extraction is made on Boxzoom 
    161163; 
    162 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     164; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     165; <pro>domdef</pro> ! 
    163166; 
    164167; @keyword WDEPTH 
    … …  
    166169; depth (automatically activated if vargrid eq 'W') 
    167170; 
    168 ; @keyword VECTEUR{type=vetcor} 
     171; @keyword VECTEUR{type=vector} 
    169172; It is a structure composed by 2 elements containing the 2 fields U 
    170173; and V of values of the zonal and meridian component of the vector of the fields 

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

    r232 r237  
    33; @file_comments 
    44; allows to trace the independently from a graph 
    5 ; By default, trace a color bar of the same type than the one present in plt 
    6 ; and pltz. If max, min and divisions are not stipulated, then max=sup,min=inf 
     5; By default, trace a color bar of the same type than the one present in  
     6; <pro>plt</pro> 
     7; and <pro>pltz</pro>. 
     8; If max, min and divisions are not stipulated, then max=sup,min=inf 
    79; and divisions=div. 
    810; 
    … …  
    2931; @version 
    3032; $Id$ 
     33; 
     34; @todo 
     35; reference to plein2dessin in restriction not understable : 
     36; plein2dessin does'nt exist. 
    3137; 
    3238;- 

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

    r232 r237  
    88; 
    99; @param TYPEDESSIN {type=string} 
    10 ; It specify what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
     10; It specify what procedure is called by <pro>PLACEDESSIN</pro> :  
     11; 'plt', 'pltz' or 'pltt' 
    1112; 
    1213; @keyword LANDSCAPE 
    … …  
    2223;     /MAP: In this case, map is automatically calculated have the value: 
    2324;          map = [0, (lon1+lon2)/2., 0] 
    24 ; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
     25; Comment 1: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    2526; IDL> demo 
    2627; Then choose earth sciences and  mapping. 
    27 ; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
     28; Comment 2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
    2829; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    2930; For example, for a polar projection centered on the south pole: 
    … …  
    3435; We active it if we do not want the colorbar. 
    3536 
    36 ;; @keyword NOFILL 
     37; @keyword NOFILL 
    3738; We active it if we only want contours in black and white with a white background. 
    3839; 
    … …  
    4546;     If there is 4 elements: 
    4647; then is constituted of coordinates (expressed in cm located from the up and 
    47 ; left corner of the page or the window (in portrait like in landscape)) of the bottom 
     48; left corner of the page or the window (in portrait like in landscape) of the bottom 
    4849; and left corner and of the up and right corner of the drawing zone. 
    4950;     If there is 3 elements: 
    … …  
    5960; @keyword POST 
    6061; Make a postscript. Only works if we made one drawing on the page. 
    61 ; If we make several drawing, use \@ps. 
     62; If we make several drawing, use \@<pro>ps</pro>. 
    6263; 
    6364; @keyword REMPLI 
    … …  
    7475; If we want to trace contours of a different field than the one 
    7576; whose we have the colored drawing (by example E-P in color and QSR in contours). 
    76 ; It must be a field respecting same characteristics than the argument number one of plt. 
     77; It must be a field respecting same characteristics than the argument number  
     78; one of <pro>plt</pro>. 
    7779; 
    7880; @keyword ENDPOINTS 
    … …  
    219221; For the using of \@ps,\@oups et de \@vzoom 
    220222      if lmgr(/demo) EQ 0 then BEGIN ; Are we in the demo mode?? 
    221         if !journal NE 0 then journal ; We close te journal if it is open 
     223        if !journal NE 0 then journal ; We close the journal if it is open 
    222224        homedir = isadirectory(io = homedir, title = 'Bad definition of homedir') 
    223225        def_myuniquetmpdir 

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

    r231 r237  
    99; 
    1010; @param STRUCT {in}{required} 
    11 ; a structure like the one who read litchamp. 
     11; a structure like the one who read <pro>litchamp</pro>. 
    1212;        See IDL> xhelp,'litchamp' 
    1313; 

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

    r232 r237  
    99; @keyword POST 
    1010; Make a postscript. Only works if we made one drawing on the page. 
    11 ; If we make several drawing, use \@ps. 
     11; If we make several drawing, use \@<pro>ps</pro>. 
    1212; 
    1313; @keyword SMALL {type=vector} 

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

    r232 r237  
    3737; 
    3838;       S. Masson (smasson\@lodyc.jussieu.fr) 4 Feb 2002 
    39 ;       search te file in the all !path directories (use find.pro) 
    40 ;       when using /find keyword. Use spawn, 'cat...' for unix os. 
     39;       search the file in the all !path directories (use <pro>find</pro>) 
     40;       when using /find keyword. Use <proidl>spawn</proidl>, 'cat...' for  
     41;       unix os. 
    4142; 
    4243; Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory 
    … …  
    5152;- 
    5253; 
    53         function getfile, filein, error=err, help=hlp, quiet=quiet, lines=lines, find = find 
     54FUNCTION getfile, filein, error=err, help=hlp, quiet=quiet, lines=lines, find = find 
    5455; 
    5556  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/TRIANGULATION/section.pro

    r232 r237  
    8080    6:localbox = [boxzoom2d, boxzoom[4:5]] 
    8181    Else:BEGIN 
    82       print, report('Bad definition of the box') 
     82      ras = report('Bad definition of the box') 
    8383      stop 
    8484    END 

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

    r229 r237  
    1111; 
    1212; @restrictions  
    13 ; compatible with \@ps \@vzoom text_box... 
     13; compatible with \@<pro>ps</pro>  
     14; \@<pro>vzoom</pro> text_box... 
    1415; 
    1516; @history  
    1617; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    17 ; 
    1818; 
    1919; @version  
    … …  
    2424; 
    2525;- 
     26; 
    2627;------------------------------------------------------------ 
    2728; Close the journal! 
Note: See TracChangeset for help on using the changeset viewer.