Changeset 133 for trunk/SRC/ToBeReviewed


Ignore:
Timestamp:
07/07/06 11:57:27 (18 years ago)
Author:
navarro
Message:

english and nicer header (1)

Location:
trunk/SRC/ToBeReviewed
Files:
2 deleted
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/CALENDRIER/def_month.pro

    r114 r133  
     1;+ 
     2; @todo seb 
     3;- 
    14FUNCTION def_month, timave, date 
    25; 

  • trunk/SRC/ToBeReviewed/COULEURS/palit.pro

    r114 r133  
    11;+ 
    2 ;  Eclaircit la palette courante en jouant sur la luminosite 
     2; @file_comments  
     3; Clarify the current palette playing with brightness 
    34; 
    4 ;          coef = regle l'attenuation des couleurs 
    5 ;          par defaut divise par 2 la luminosite 
     5; @param coef {in}{required} The rule of attenuation of colors divide by 2 the brightness by default 
    66; 
    7 ;  coef = 0.1 pour la QMS papier de l'IPSL convient tres bien 
     7; @param red  
     8; 
     9; @param green 
     10; 
     11; @param blue 
     12; 
     13; @todo Seb: compléter param red/green/blue 
    814;- 
    915PRO palit, coef, red, green, blue 
    … …  
    1622   l = 1.-coef*(1.-l) 
    1723; 
    18 ;  Le noir doit rester bien noir ! 
    19 ;  toutes mes palettes commencent par du noir et finissent par du blanc 
     24;  Black must stay really black! 
     25;  Each palette starts by Black and ends by white 
    2026; 
    2127   l[0] = 0. 

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

    r114 r133  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME:animgif 
    65; 
    7 ; PURPOSE:construire une animation gif 
     6; @file_comments  
     7; Build a gif animation 
    88; 
    9 ; CATEGORY:pour faire des dessins animes 
     9; @categories Animated drawings. 
    1010; 
    11 ; CALLING SEQUENCE:animgif, 'toto.gif' 
     11; @param toto.gif {in}{required} It is the name of the gif file containing the animation. 
     12;                         Comment: this file is placed in the directory defined by iodir. 
    1213; 
    13 ; INPUTS:toto.gif: c''est le nom du fichier gif contenant 
    14 ; l''animation. Rq ce fichier est place dans le repertoire definit par 
    15 ; iodir. 
     14; @uses common.pro 
    1615; 
    17 ; KEYWORD PARAMETERS: 
    18 ; 
    19 ; OUTPUTS: 
    20 ; 
    21 ; COMMON BLOCKS: 
    22 ;       common.pro 
    23 ; 
    24 ; SIDE EFFECTS:on utilise le Z buffer pour aller plus vite!. 
    25 ;              donc si on plante ds animgif il faut faire: 
     16; @restrictions We use the Z buffer to go faster!. 
     17;              So, if it failed in animgif, you have to do: 
    2618;              IDL> device, /close 
    2719;              IDL> set_plot, 'x' 
    2820;              IDL> retall 
    2921; 
    30 ; RESTRICTIONS: si on veut supprimer le @common, 
    31 ;               il faut definir a la main la taille de l''image (les 
    32 ;               variables xsize et ysize) ainsi que iodir. 
     22; @restrictions If we want to delete the @common, 
     23;               we have to define manually the picture's size  
     24;               (variables xsize and ysize) just as iodir. 
    3325; 
    34 ; EXAMPLE: 
     26; @history Guillaume Roullet (grlod@ipsl.jussieu.fr) 
     27;          Sebastien Masson (smasson@lodyc.jussieu.fr) 
     28;          30/4/1999 
    3529; 
    36 ; MODIFICATION HISTORY: Guillaume Roullet (grlod@ipsl.jussieu.fr) 
    37 ;                       Sebastien Masson (smasson@lodyc.jussieu.fr) 
    38 ;                       30/4/1999 
     30; @version $Id$ 
     31; 
    3932;- 
    4033;------------------------------------------------------------ 
    … …  
    4740@common 
    4841; 
    49 ;  recupere la palette de couleur et la place dans rouge, vert, bleu 
     42;  It recuperates the color palette and put it in red, green, blue. 
    5043; 
    5144   tvlct,  rouge,vert,bleu,/get 
    5245; 
    53 ;  complete la palette courante sur 256 couleurs 
     46;  It completes the current palette on 256 colors. 
    5447; 
    5548   red = [rouge, replicate(255, 256-n_elements(rouge))]  
    … …  
    5750   blue = [bleu, replicate(255, 256-n_elements(rouge))]  
    5851; 
    59 ; bascule sur le z device, permettant de creer l''image sans 
    60 ; l''afficher 
     52; It rocks on the z device, allowing to create the picture without display it. 
    6153   thisOS = !VERSION.OS_FAMILY 
    6254   thisOS = STRMID(thisOS, 0, 3) 
    6355   thisOS = STRUPCASE(thisOS) 
    6456   set_plot, 'z' 
    65 ; taille de l''image (en nombre de pixel: 
     57; size of the picture (in pixel): 
    6658   xsize = 30*(min(page_size, max = ma)*key_portrait + ma*(1-key_portrait)) 
    6759   ysize = 30*(min(page_size, max = ma)*(1-key_portrait) + ma*key_portrait) 
    6860   device, set_resolution = [xsize, ysize] 
    6961; 
    70 ; commencement du fichier gif. ecriture d''une image vide  
     62; Beginning of the gif file. Writing of an empty picture.  
    7163; 
    7264   reinitplt 
    … …  
    7668; 
    7769;---------------------------------------------------------------- 
    78 ; debut de la partie a changer 
     70; Beggining of the part we want to change. 
    7971;---------------------------------------------------------------- 
    8072; 
    81 ; boucle de creation de l''image 
     73; Loop of picture's creation. 
    8274; 
    8375   calen = TIMEGEN(366, START=JULDAY(1,1,2000))  
    … …  
    10799;      plt, norme(nlec('unsurf', date, 'RE3'), nlec('vnsurf', date, 'RE3')), 0, 1.2, int = .1, /noerase 
    108100; 
    109 ;     Ecriture de l''image dans le fichier .gif 
     101;     Writing of the picture in the file .gif. 
    110102; 
    111103      write_gif,iodir+nomfic,tvrd(),red, green, blue, /multiple 
    112104   ENDFOR  
    113105;---------------------------------------------------------------- 
    114 ; fin de la partie a changer 
     106; End of the part we want to change. 
    115107;---------------------------------------------------------------- 
    116108; 
    117 ; fermeture du fichier 
     109; Closing of the file. 
    118110   write_gif,iodir+nomfic,/close  
    119 ; rebascule en mode terminal X 
    120    device, /close 
     111; Rerock on terminal X mode. 
     112;   device, /close 
    121113   CASE thisOS of 
    122114      'MAC': SET_PLOT, thisOS 

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

    r114 r133  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    5 ; NAME:colle 
     2; @file_comments  
     3; This concatenation function exist in IDL so long  
     4;as we do not try to stick with a dimension superior or equal at 4.   
    65; 
    7 ; PURPOSE: Cette fonction de concatenation existe ds IDL (avec [] cf 
    8 ; ds le programme ds le case pour direc egale 1,2,3) tant que l''on ne 
    9 ; cherche pas a coller suivant une dimensionsuperieure ou egale a 4.   
     6; @categories utilities 
    107; 
    11 ; CATEGORY:bidouillage de matrice 
     8; @param a0 {in}{required} 
    129; 
    13 ; CALLING SEQUENCE:res=colle(bableau_de_pointeur,direc) ou bien 
    14 ;                  res=colle(tab1,tab2,tab3,tab4,.....,direc) 
     10; @param a1 {in}{required} 
    1511; 
    16 ; INPUTS: 
    17 ;          
    18 ;        CAS 1: 
    19 ;        tableau_de_pointeur:comme son nom l''indique c'est un tableau 
    20 ;        de pointeur, dont chaque elements pointe sur tableau a coller 
     12; @param a2 {in}{required} 
    2113; 
    22 ;        par ex ds un programme, on veut coller n tableaux entre eux 
     14; @param a3 {in}{required} 
     15; 
     16; @param a4 {in}{required} 
     17; 
     18; @param a5 {in}{required} 
     19; 
     20; @param a6 {in}{required} 
     21; 
     22; @param a7 {in}{required} 
     23; 
     24; @param a8 {in}{required} 
     25; 
     26; @param a9 {in}{required} 
     27; 
     28; @param a10 {in}{required} 
     29; 
     30; @param a11 {in}{required} 
     31; 
     32; @param a12 {in}{required} 
     33; 
     34; @param a13 {in}{required} 
     35; 
     36; @param a14 {in}{required} 
     37; 
     38; @param a15 {in}{required} 
     39; 
     40; @param a16 {in}{required} 
     41; 
     42; @param a17 {in}{required} 
     43; 
     44; @param a18 {in}{required} 
     45; 
     46; @param a19 {in}{required} 
     47; 
     48; @param a20 {in}{required} 
     49; 
     50; @param CAS 1 {in}{required} 
     51;        table_of_pointer: It is a table of pointers, where each  
     52;        element point on a table to stick 
     53;        
     54;        For exemple, in a program, we want to stick n table ones with others. 
    2355; 
    2456;          tab=ptrarr(n,/allocate_heap) 
    … …  
    2860;          res=colle(tab,1) 
    2961; 
    30 ;        CAS 2: 
    31 ;        on donne directement les tableaux a coller 
    32 ;        rq: ds ce cas on peut au plus donner 20 tableaux en entree. 
     62; @param CAS 2 {in}{required} 
     63;        we directly give tables to stick 
     64;        Comment: In this case, the plus we can give is 20 tables. 
    3365; 
    34 ;        ATTENTION : sans le mot cle /SAUVE les arguments en entree 
    35 ;        sont detruits lorsque l''on construit res. ds le cas 1 on 
    36 ;        detruit le tableau de pointeurs et les variables sur 
    37 ;        lesquelles on pointe. 
     66;        BEWARE: whitout the keyword /SAUVE entry arguments are  
     67;                delete when, we build res. In the first case,we  
     68;                delete the table of pointers and variables on which we point. 
    3869; 
    39 ;        direc: la direction suivant laquelle les coller, 1,2,3...  
     70; @param direc {in}{required} The direction on which stick them, 1,2,3...  
    4071; 
    41 ; KEYWORD PARAMETERS: 
    42 ; 
    43 ;         /SAUVE: mot cle qui force a sauvegarder le tableau de 
     72; @keyword SAUVE mot cle qui force a sauvegarder le tableau de 
    4473;         pointeur et les tableaux a coller. 
    4574; 
    46 ; OUTPUTS:res=matrice resultat 
     75; @returns res=matrice resultat 
    4776; 
    48 ; RESTRICTIONS: 
    49 ; 
    50 ; EXAMPLE: 
    51 ;  
    52 ;         IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)    
     77; @examples IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)    
    5378;                1       1 
    5479;                1       1 
    … …  
    6186;                6       7 
    6287; 
    63 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     88; @history Sebastien Masson (smasson@lodyc.jussieu.fr) 
    6489;                       13/1/98 
     90; 
     91; @version $Id$ 
     92; 
    6593;- 
    66 ;------------------------------------------------------------ 
    67 ;------------------------------------------------------------ 
    68 ;------------------------------------------------------------ 
    69 ; pour suprimer une variable. 
    70 ;------------------------------------------------------------ 
    71    PRO UNDEFINE, varname   
    72 ; 
    73   compile_opt idl2, strictarrsubs 
    74 ; 
    75       tempvar = SIZE(TEMPORARY(varname)) 
    76    END 
    77 ;------------------------------------------------------------ 
    78 ;------------------------------------------------------------ 
    7994FUNCTION colle, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, SAUVE = sauve 
    8095; 

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

    r114 r133  
     1;+ 
     2; @todo seb 
     3;- 
     4; 
    15; elle fait quoi ? 
    26 

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

    r11 r133  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    5 ; NAME:oups 
    62; 
    7 ; PURPOSE: Sorte de UNDO: 
    8 ; permet de refaire toute la serie de dessin depuis 
    9 ; l''ouverture de la derniere fenetre sans reexecuter la derniere 
    10 ; commande. cf. je fais un dessin avec 10 plt dessus au 10 eme je me 
    11 ; plante, un coup de @oups et je peux refaire mon plt rate! 
     3; @file_comments  
     4;       Kind of UNDO: 
     5;         Allows to redo all the chain of drawing since the opening of the last window without  
     6;         reexecute the last order Example: I do a drawing with 10 plot over it, if I make a  
     7;         mistake, I execute this program and i can redo the only plot missed. 
    128; 
    13 ; CATEGORY: pour faciliter les dessins 
     9; @categories utilities 
    1410; 
    15 ; CALLING SEQUENCE: @oups 
     11; @restrictions compatible with @ps @vzoom text_box... 
    1612; 
    17 ; SIDE EFFECTS: compatible avec @ps @vzoom text_box... 
     13; @history Sebastien Masson (smasson@lodyc.jussieu.fr) 
    1814; 
    19 ; RESTRICTIONS: 
    2015; 
    21 ; EXAMPLE: 
     16; @version $Id$ 
    2217; 
    23 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     18; @todo seb 
    2419; 
    2520;- 
    2621;------------------------------------------------------------ 
    27 ;------------------------------------------------------------ 
    28 ;------------------------------------------------------------ 
    29 ;------------------------------------------------------------ 
    30 ; il faut fermer le journal! 
     22; Close the journal! 
    3123;------------------------------------------------------------ 
    3224 journal 
    33 ; on recupere le journal sous la forme d''un vecteur de string: 
     25; we recuperate the journal as a vector of string: 
    3426   vectjournal = getfile(myuniquetmpdir+'idlsave.pro') 
    35 ; on coupe la derniere ligne qui est oups 
     27; we cut the last line which is oups 
    3628   vectjournal = vectjournal[0:n_elements(vectjournal)-2 ] 
    3729;------------------------------------------------------------ 
    38 ; on le corrige si besoin est... 
     30; we correct it if there is the need... 
    3931;------------------------------------------------------------ 
    4032for i = 0, n_elements(vectjournal)-1 do $ 
    4133 if strpos(vectjournal[i],'text_box' ) EQ -1 then $ 
    4234 vectjournal[i] = strtrim(strcompress(vectjournal[i]), 2) 
    43 ;2 lignes sont identiques ?? 
     35;2 line are identical ?? 
    4436for i = 0, n_elements(vectjournal)-2 do $ 
    4537 if vectjournal[i] EQ vectjournal[i+1] then vectjournal[i] = ' ' 
    … …  
    6254 
    6355; 
    64 ; on vire la derniere ligne pour tout reexecuter sauf la derniere commande 
     56; we erase the last line to reexecute all the programm but the last order. 
    6557; 
    6658 IF strpos(vectjournal[n_elements(vectjournal)-1],';,pos=[' ) NE -1 then $ 
    6759 vectjournal[n_elements(vectjournal)-2] = '' $ 
    6860 ELSE vectjournal[n_elements(vectjournal)-1] = ''  
    69 ; on reecrit idlsave.pro 
     61; we rewrite idlsave.pro 
    7062putfile, myuniquetmpdir+'idlsave.pro', vectjournal 
    71 ; on compile puis applique idlsave 
     63; we compile, then we apply idlsave 
    7264cd,  current = curdir 
    7365cd, myuniquetmpdir 
    7466@idlsave    
    7567cd, curdir 
    76 ; le journal vient d'etre reouvert, et on y met les elements de 
    77 ; vectjournal  
     68; the journal has just been reopened, and we put elements of vectjournal in it.  
    7869for i = 0, n_elements(vectjournal)-1 DO $ 
    7970journal, vectjournal[i] 

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

    r11 r133  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME:vraizoom 
    65; 
    7 ; PURPOSE:fait un vari zoom dans un plot, contrairement a la fonction 
    8 ; ZOOM  preecrite par IDL qui ne fait que grossir les pixels 
     6; @file_comments  
     7; Make a real zoom in a plot, contrarly at the function  
     8; ZOOM prewritten by IDL which just get pixels bigger. 
    99; 
    10 ; CATEGORY:petit outil 
     10; @categories utilities 
    1111; 
    12 ; CALLING SEQUENCE:@vzoom 
     12; @restrictions use the journal. 
     13; @history Sebastien Masson (smasson@lodyc.jussieu.fr) 
     14;          29/4/1999 
    1315; 
    14 ; SIDE EFFECTS:utilise le journal.  
     16; @version $Id$  
    1517; 
    16 ; RESTRICTIONS: 
     18; @todo seb 
    1719; 
    18 ; EXAMPLE: 
    19 ; 
    20 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    21 ;                       29/4/1999 
    2220;- 
    2321;------------------------------------------------------------ 
    … …  
    3129   y = y[sort(y)] 
    3230   domdef, [x, y, vert1, vert2] 
    33 ; il faut fermer le journal! 
     31; we must close the journal! 
    3432   journal 
    35 ; on recupere le journal sous la forme d''un vecteur de string: 
     33; we recuperate the journal as a vector of string: 
    3634   vectjournal = getfile(myuniquetmpdir+'idlsave.pro') 
    37 ; on coupe la derniere ligne qui est vraizoom 
     35; we cut the last line which is vraizoom 
    3836   vectjournal = vectjournal[0:n_elements(vectjournal)-2 ] 
    3937;------------------------------------------------------------ 
    40 ; on le corrige si besoin est... 
     38; we correct it if there is the need to... 
    4139;------------------------------------------------------------ 
    4240for i = 0, n_elements(vectjournal)-1 do $ 
    4341 if strpos(vectjournal[i],'text_box' ) EQ -1 then $ 
    4442 vectjournal[i] = strtrim(strcompress(vectjournal[i]), 2) 
    45 ;2 lignes sont identiques ?? 
     43;2 line are identical ?? 
    4644for i = 0, n_elements(vectjournal)-2 do $ 
    4745 if vectjournal[i] EQ vectjournal[i+1] then vectjournal[i] = ' ' 
    … …  
    6563 
    6664; 
    67 ; on reecrit idlsave.pro 
     65; we rewrite idlsave.pro 
    6866putfile, myuniquetmpdir+'idlsave.pro', vectjournal 
    69 ; applique idlsave 
     67; apply idlsave 
    7068   cd,  current = curdir 
    7169   cd, myuniquetmpdir 
    7270@idlsave    
    7371   cd, curdir 
    74 ; le journal vient d'etre reouvert, et on y met les elements de 
    75 ; vectjournal  
     72; the journal has just been reopened, and we put in elements of vectjournal.  
    7673for i = 0, n_elements(vectjournal)-1 DO $ 
    7774journal, vectjournal[i] 
Note: See TracChangeset for help on using the changeset viewer.