Changeset 133 for trunk/SRC/Obsolete/extrait.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Obsolete/extrait.pro (moved) (moved from trunk/SRC/ToBeReviewed/MATRICE/extrait.pro) (4 diffs)

trunk/SRC/Obsolete/extrait.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:extrait
 ;
-; PURPOSE:extraction de sous domaines de matrices. Meme si le sous
-; domaine est "troue". cf. : l''exemple
-; Par defaut IDL peut faire des extractions de sous domaines:
+; @fie-comments 
+; extractoin of subdomains of matrixes; Even if the subdomain is "pierced" (see the example)
+; By default, IDL can make extractions of subdomain:
 ;
 ;      IDL> a=indgen(5,5) 
@@ -24 +23 @@
 ;            15      17
 ;            20      22
-; mais 
+; but
 ;      IDL> print, a[[0,2],[3,4]] 
 ;            15      22
-; alors que
+; while
 ;      IDL> print, extrait(a,[0,2],[3,4])  
 ;            15      17
 ;            20      22
 ;
-; CATEGORY:bidouille avec les matrices
 ;
-; CALLING SEQUENCE:res=extrait(tab,indicex[,indicey[,indicez,[indicet]]])
+; you better use extrac2
 ;
-; INPUTS:
-;        tab: un tableau 1,2,3 ou 4 d
+; @obsolete
 ;
-;        indicex: indicex peut avoir deux formes:
-;              1)un vecteur contenant les indices des lignes a garder
-;              2)le string '*' dans ce cas touts les lignes sont
-;              gardees
+; @categories utilities
 ;
-;        indicey/z/t: la meme chose que indicex mais pour les
-;        dimensions 2,3 et 4.
+; @param tab {in}{required} a 1,2,3 or 4 dim table
 ;
-;        rq: il faut autant de vecteurs indice que tab a de dimensions
+; @param indicex {in}{required} can have 2 forms:
+;              1)a vector containing indexes of lines we want to keep
+;              2)the string '*' if we want to keep all lines.
 ;
-; KEYWORD PARAMETERS:
+; @param indicey {in}{required} the same thing that indicex but for dim 2.
 ;
-; OUTPUTS:
-;         res: une matice 1,2,3 ou 4d extraite a partir de tab
+; @param indicez {in}{required} the same thing that indicex but for dim 3.
+; 
+; @param indicet {in}{required} the same thing that indicex but for dim 4.
 ;
-; COMMON BLOCKS:
+; @returns a matrix 1,2,3 or 4d extract from tab
 ;
-; SIDE EFFECTS:res=-1 en cas d''erreur
+; @restrictions res=-1 in case of mistake
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-; j''ai une matrice A de dim 2. je veux en extraire une petite matrice
-; 2d interscetion de la ligne 2,3 et 7 et de la colonne 0 et 1
+; 
+; @examples I have a dim 2 matrix named A. I want extract a small intersection 
+;          matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
 ;      
 ;      res=extrait(A,[2,3,7],[0,1])
 ;
-;autre ex:
+;other ex:
 ;      IDL> print, a 
 ;      a b c
@@ -75 +69 @@
 ;      g i
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       12/1/1999
-;                       29/4/1999: correction d''un bug et complement
-;                       de l''en-tete
+;                       29/4/1999: correction of a bug and complement of the heading
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -88 +84 @@
   compile_opt idl2, strictarrsubs
 ;
-   taille = size(tab)
-;------------------------------------------------------------
-; test du nombre de parametres
-; et de la nature de indice (pour LE cas 'x')
-;------------------------------------------------------------
-   if n_params() NE taille[0]+1 THEN $
-    return, report('il faut autant d''indices que de dimension du tableau')
-   IF n_params() GE 5 THEN BEGIN 
-      if size(indicet,/type) EQ 7 then indicet = lindgen(taille[4]) $
-      ELSE indicet = long(indicet)
-      nt = n_elements(indicet) 
-   ENDIF 
-   IF n_params() GE 4 THEN BEGIN 
-      if size(indicez,/type) EQ 7 then indicez = lindgen(taille[3]) $
-      ELSE indicez = long(indicez)
-      nz = n_elements(indicez) 
-   ENDIF 
-   IF n_params() GE 3 THEN BEGIN 
-      if size(indicey,/type) EQ 7 then indicey = lindgen(taille[2]) $
-      ELSE indicey = long(indicey)
-      ny = n_elements(indicey) 
-   ENDIF
-   IF n_params() GE 2 THEN BEGIN 
-      if size(indicex,/type) EQ 7 then indicex = lindgen(taille[1]) $
-      ELSE indicex = long(indicex)
-      nx = n_elements(indicex) 
-   ENDIF
-   
-;------------------------------------------------------------
-; construction du tableau d''indice et du resultat suivant la taille
-; de tab
-;------------------------------------------------------------
-  case taille[0] of
-      1:res = tab[indicex]
-      2:BEGIN
-         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
-         res = tab[indice]
-      END 
-      3:BEGIN
-         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
-         indice = temporary(indice[*])#replicate(1, nz) $
-          +taille[1]*taille[2]*replicate(1, nx*ny)#indicez
-         res = tab[reform(indice, nx, ny, nz, /over)]
-      END 
-      4:BEGIN
-         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
-         indice = temporary(indice[*])#replicate(1, nz) $
-          +taille[1]*taille[2]*replicate(1, nx*ny)#indicez
-         indice = temporary(indice[*])#replicate(1, nt) $
-          +taille[1]*taille[2]*taille[3]*replicate(1, nx*ny*nz)#indicet
-         res = tab[reform(indice, nx, ny, nz, nz, /over)]
-      END 
-   endcase
-
-
-;------------------------------------------------------------
-;------------------------------------------------------------
-   return, res
+  case n_params() of
+      0:return, extrac2()
+      1:return, extrac2(tab)
+      2:return, extrac2(tab, indicex)
+      3:return, extrac2(tab, indicex, indicey)
+      4:return, extrac2(tab, indicex, indicey, indicez)
+      5:return, extrac2(tab, indicex, indicey, indicez, indicet)
+  endcase
 end