Changeset 142 for trunk/SRC/ToBeReviewed/CALCULS/norme.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/norme.pro (modified) (21 diffs)

trunk/SRC/ToBeReviewed/CALCULS/norme.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:norme
-;
-; PURPOSE: calcule la norme d''un champ de vecteurs, puis fait une
-; moyenne eventuelle.
-;          Rq1: le champ de vecteur peut etre, 2d:xy, 3d: xyz ou xyt,
-;          4d: xyzt
-;          Rq2: le calcul de la norme est fait avant l''eventuelle
-;          moyenne spatiale ou temporelle car la moyenne de la norme
-;          n''est pas egale a la norme des moyennes.
-;
-; CATEGORY: calcul de post traitement
-;
-; CALLING SEQUENCE:res=norme(champ_de_vecteurs)
-;
-; INPUTS:un tableau 2d, 3d ou 4d
-;
-; KEYWORD PARAMETERS:
-;
-;       BOXZOOM: boxzoom sur laquelle moyenner (par defaut le domaine
-;       selectionner par le dernier domdef effectue)
-;
-;       DIREC:'t' 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
-;       'xzt' 'yzt' 'xyzt' directions selon lesquelles effectuer les
-;       moyennes 
-;
-; OUTPUTS:tableau a tracer avec plt, pltz ou pltt.
-;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:
-;
-;      La norme est calculee aux points T. Pour faire ce calcul, on
-;      moyenne les champs U et V aux points T avant de calculer la norme.
-;      Au bord des cotes et du domaine, on ne peut pas calculer les
-;      champs U et V aux points T, ces points sont donc a la valeur
-;      !values.f_nan. 
+;
+; @file_comments 
+; calculate the norme of a field of vectors, then make a possible average.
+;   Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt,
+; 4d: xyzt
+;   Comment 2:
+; The calculation of the norme is made before the possible spatial or 
+; temporal average because the average of the norme is not equal to the 
+; norme of averages
+
+;
+; @categories
+; Post traitment calculation
+;
+; @param COMPOSANTEU {in}{required}
+; an 2d, 3d or 4d array
+;
+; @param COMPOSANTEV {in}{required}
+; an 2d, 3d or 4d array
+;
+; @keyword BOXZOOM
+; boxzoom on which do the average (by default the domain selected 
+; by the last domdef done)
+;
+; @keyword DIREC
+; 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
+;       'xzt' 'yzt' 'xyzt' Direction on which do averages 
+;
+; @returns
+; Array to trace with plt, pltz or pltt.
+;
+; @uses
+; common.pro
+;
+; @restrictions 
+; The norme is calculated on points TTo do this calculation, we average 
+; field U and Von points T before calculate the norme. At the edge of 
+; coast and of domain, we can not calculate fields U and V at points T, 
+; that is why these points are at value !values.f_nan. 
 ; 
-;      lorsqu''on fait le calcul sur un domaine geographique reduit,
-;      les champs U et V ne comprennent pas forcement le meme nombre
-;      de points. Dans ce cas on redecoupe U et V pour ne garder que
-;      les points en commun. Au passage on refait un domdef qui
-;      redefinit un domaine geographique sur lequel les champs U et V
-;      sont extraits sur les meme points.
-;
-; RESTRICTIONS:
-;
-;      pour savoir a quel type de tableau on a a faire, on teste la
-;      taille de celui-ci et les dates donnees par time[0] et
-;      time[jpt-1] pour savoir si il y a une dimension
-;      temporelle. Avant de lancer norme s''assurer que time et jpt
-;      sont bien definis comme il faut! 
-;
-; EXAMPLE:
-;
-;     pour calculer la moyenne de la norme des courants sur tout le
-;     dommaine entre 0 et 50:
+; When we calculate on a reduce geographic domain, field U and V have not 
+; necessarily the same number of point. In this case, we recut U and V to 
+; keep only common points. We profit of this to redo a domdef which redefine 
+; a geographic domain on which fields U and V are extracted on same points
+;
+; @restrictions
+; To know what type of array we work with, we  test its size and dates 
+; gave by time[0] and time[jpt-1] to know if thee is a temporal dimension. 
+; Before to start norme, make sure that time and jpt are defined how 
+; they have to! 
+;
+; @examples
+; To calculate the average of the norme of streams on all the domain 
+; between 0 et 50:
 ;      IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       9/6/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -81 +83 @@
   ENDIF
 ;---------------------------------------------------------
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; To key_performance
 ;
    IF finite(glamu[0])*finite(gphiu[0])*finite(glamv[0])*finite(gphiv[0]) EQ 0 THEN $
@@ -101 +103 @@
 ;------------------------------------------------------------
    if NOT keyword_set(direc) then direc = 0
-; construction de u et v aux pts T
+; construction of u and v at points T
    u = litchamp(composanteu)
    v = litchamp(composantev)
@@ -130 +132 @@
 
 ;------------------------------------------------------------
-; on trouve les points que u et v ont en communs
+; We find common points between u and v
 ;------------------------------------------------------------
    indicexu = (lindgen(jpi))[firstxu:firstxu+nxu-1]
@@ -154 +156 @@
          indice3d = indice3d[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1,firstzt:lastzt]
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of u and v on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -191 +193 @@
          endcase
 ;------------------------------------------------------------------
-; on reform u et v pour s'assurer qu'aucune dimension n'a ete ecrasee
+; We reshape u and v to make sure that no dimension has been erased
 ;------------------------------------------------------------------
          if nzt EQ 1 then begin
@@ -198 +200 @@
          endif
 ;------------------------------------------------------------------
-; construction de u et v aux pts T
+; construction of u and v at points T
 ;-----------------------------------------------------------
          a=u[0,*,*]
@@ -207 +209 @@
          if NOT keyword_set(key_periodic) OR nx NE jpi then v[*,0,*]=a
 ;----------------------------------------------------------------------------
-; attribution du mask et des tableau de longitude et latitude
+; attribution of the mask and of logitude and latitude arrays
 ;----------------------------------------------------------------------------
          mask = tmask[indice3d]
@@ -222 +224 @@
          mask = where(mask eq 0)
          IF mask[0] NE -1 THEN res[mask] = valmask
-; moyennes en tous genres
+; All kind of average
          domdef, (glamt[indice2d])[0, 0], (glamu[indice2d])[nx-1, 0],(gphit[indice2d])[0, 0], (gphiv[indice2d])[0, ny-1], vert1, vert2, /meme
          if keyword_set(direc) then res = moyenne(res,direc,/nan, boxzoom = boxzoom, /nodomdef)
@@ -236 +238 @@
          indice2d = indice2d[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1]
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of u and v on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -258 +260 @@
          endcase
 ;------------------------------------------------------------------
-; construction de u et v aux pts T
+; construction of u and v at points T
 ;-----------------------------------------------------------
          a=u[0,*,*]
@@ -267 +269 @@
          if NOT keyword_set(key_periodic) OR nx NE jpi then v[*,0,*]=a
 ;----------------------------------------------------------------------------
-; attribution du mask et des tableau de longitude et latitude
-; on recupere la grille complette pour etablir un grand mask etendu ds les 4
-; directions pour couvrir les points pour lesquels un pt terre a ete pris en
-; compte (faire un petit dessin...)
+; attribution of the mask and of longitude and latitude arrays.
+; We recover the complete grid to establish a big mask extent in the four 
+; direction to cover pointsfor which a land point has been 
+; considerated (make a small drawing)
 ;----------------------------------------------------------------------------
          mask = tmask[indice2d+jpi*jpj*firstzt]
          if ny EQ 1 then mask = reform(mask, nx, ny, /over)
 ;-----------------------------------------------------------
-; construction de terre qui contient tous les point a masquer
+; construction of land containing all points to mask
 ;-----------------------------------------------------------
          if n_elements(valmask) EQ 0 THEN valmask = 1e20
@@ -308 +310 @@
          indice3d = indice3d[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1,firstzt:lastzt]
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of u and v on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -345 +347 @@
          endcase
 ;------------------------------------------------------------------
-; construction de u et v aux pts T
+; construction of u and v at points T
 ;-----------------------------------------------------------
          a=u[0,*,*,*]
@@ -354 +356 @@
          if NOT keyword_set(key_periodic) OR nx NE jpi then v[*,0,*,*]=a
 ;----------------------------------------------------------------------------
-; attribution du mask et des tableau de longitude et latitude
+; attribution of the mask and of logitude and latitude arrays
 ;----------------------------------------------------------------------------
          mask = tmask[indice3d]
@@ -375 +377 @@
             res[temporary(mask)] = valmask
          ENDIF
-; moyennes en tous genres
+; All kind of average
          domdef, (glamt[indice2d])[0, 0], (glamu[indice2d])[nx-1, 0],(gphit[indice2d])[0, 0], (gphiv[indice2d])[0, ny-1], vert1, vert2, /meme
          if keyword_set(direc) then res = grossemoyenne(res,direc,/nan, boxzoom = boxzoom, /nodomdef)
@@ -388 +390 @@
          indice2d = indice2d[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1]
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of u and v on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -410 +412 @@
          endcase
 ;------------------------------------------------------------------
-; on reform u et v pour s'assurer qu'aucune dimension n'a ete ecrasee
+; We reshape u and v to make sure that no dimension has been erased
 ;------------------------------------------------------------------
          if ny EQ 1 then begin
@@ -417 +419 @@
          endif
 ;------------------------------------------------------------------
-; construction de u et v aux pts T
+; construction of u and v at points T
 ;-----------------------------------------------------------
          a=u[0,*]
@@ -426 +428 @@
          if NOT keyword_set(key_periodic) OR nx NE jpi then v[*,0]=a
 ;----------------------------------------------------------------------------
-; attribution du mask et des tableau de longitude et latitude
-; on recupere la grille complette pour etablir un grand mask etendu ds les 4
-; directions pour couvrir les points pour lesquels un pt terre a ete pris en
-; compte (faire un petit dessin...)
+; attribution of the mask and of longitude and latitude arrays.
+; We recover the complete grid to establish a big mask extent in the four 
+; direction to cover pointsfor which a land point has been 
+; considerated (make a small drawing)
 ;----------------------------------------------------------------------------
          mask = tmask[indice2d+jpi*jpj*firstzt]
          if nyt EQ 1 THEN mask = reform(mask, nx, ny, /over)
 ;-----------------------------------------------------------
-; construction de terre qui contient tous les point a masquer
+; construction of land containing all points to mask
 ;-----------------------------------------------------------
          if n_elements(valmask) EQ 0 THEN valmask = 1e20
@@ -446 +448 @@
          mask = where(mask eq 0)
          IF mask[0] NE -1 THEN res[mask] = valmask
-; moyennes en tous genres
+; All kind of average
          domdef, (glamt[indice2d])[0, 0], (glamu[indice2d])[nx-1, 0],(gphit[indice2d])[0, 0], (gphiv[indice2d])[0, ny-1], vert1, vert2, /meme
          if keyword_set(direc) then res = moyenne(res,direc,/nan, boxzoom = boxzoom, /nodomdef)