Changeset 133 for trunk/SRC/ToBeReviewed/IMAGE/animgif.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/ToBeReviewed/IMAGE/animgif.pro (modified) (5 diffs)

trunk/SRC/ToBeReviewed/IMAGE/animgif.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:animgif
 ;
-; PURPOSE:construire une animation gif
+; @file_comments 
+; Build a gif animation
 ;
-; CATEGORY:pour faire des dessins animes
+; @categories Animated drawings.
 ;
-; CALLING SEQUENCE:animgif, 'toto.gif'
+; @param toto.gif {in}{required} It is the name of the gif file containing the animation.
+;                         Comment: this file is placed in the directory defined by iodir.
 ;
-; INPUTS:toto.gif: c''est le nom du fichier gif contenant
-; l''animation. Rq ce fichier est place dans le repertoire definit par
-; iodir.
+; @uses common.pro
 ;
-; KEYWORD PARAMETERS:
-;
-; OUTPUTS:
-;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:on utilise le Z buffer pour aller plus vite!.
-;              donc si on plante ds animgif il faut faire:
+; @restrictions We use the Z buffer to go faster!.
+;              So, if it failed in animgif, you have to do:
 ;              IDL> device, /close
 ;              IDL> set_plot, 'x'
 ;              IDL> retall
 ;
-; RESTRICTIONS: si on veut supprimer le @common,
-;               il faut definir a la main la taille de l''image (les
-;               variables xsize et ysize) ainsi que iodir.
+; @restrictions If we want to delete the @common,
+;               we have to define manually the picture's size 
+;               (variables xsize and ysize) just as iodir.
 ;
-; EXAMPLE:
+; @history Guillaume Roullet (grlod@ipsl.jussieu.fr)
+;          Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          30/4/1999
 ;
-; MODIFICATION HISTORY: Guillaume Roullet (grlod@ipsl.jussieu.fr)
-;                       Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       30/4/1999
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -47 +40 @@
 @common
 ;
-;  recupere la palette de couleur et la place dans rouge, vert, bleu
+;  It recuperates the color palette and put it in red, green, blue.
 ;
    tvlct,  rouge,vert,bleu,/get
 ;
-;  complete la palette courante sur 256 couleurs
+;  It completes the current palette on 256 colors.
 ;
    red = [rouge, replicate(255, 256-n_elements(rouge))] 
@@ -57 +50 @@
    blue = [bleu, replicate(255, 256-n_elements(rouge))] 
 ;
-; bascule sur le z device, permettant de creer l''image sans
-; l''afficher
+; It rocks on the z device, allowing to create the picture without display it.
    thisOS = !VERSION.OS_FAMILY
    thisOS = STRMID(thisOS, 0, 3)
    thisOS = STRUPCASE(thisOS)
    set_plot, 'z'
-; taille de l''image (en nombre de pixel:
+; size of the picture (in pixel):
    xsize = 30*(min(page_size, max = ma)*key_portrait + ma*(1-key_portrait))
    ysize = 30*(min(page_size, max = ma)*(1-key_portrait) + ma*key_portrait)
    device, set_resolution = [xsize, ysize]
 ;
-; commencement du fichier gif. ecriture d''une image vide 
+; Beginning of the gif file. Writing of an empty picture. 
 ;
    reinitplt
@@ -76 +68 @@
 ;
 ;----------------------------------------------------------------
-; debut de la partie a changer
+; Beggining of the part we want to change.
 ;----------------------------------------------------------------
 ;
-; boucle de creation de l''image
+; Loop of picture's creation.
 ;
    calen = TIMEGEN(366, START=JULDAY(1,1,2000)) 
@@ -107 +99 @@
 ;      plt, norme(nlec('unsurf', date, 'RE3'), nlec('vnsurf', date, 'RE3')), 0, 1.2, int = .1, /noerase
 ;
-;     Ecriture de l''image dans le fichier .gif
+;     Writing of the picture in the file .gif.
 ;
       write_gif,iodir+nomfic,tvrd(),red, green, blue, /multiple
    ENDFOR 
 ;----------------------------------------------------------------
-; fin de la partie a changer
+; End of the part we want to change.
 ;----------------------------------------------------------------
 ;
-; fermeture du fichier
+; Closing of the file.
    write_gif,iodir+nomfic,/close 
-; rebascule en mode terminal X
-   device, /close
+; Rerock on terminal X mode.
+;   device, /close
    CASE thisOS of
       'MAC': SET_PLOT, thisOS