Changeset 136 for trunk/SRC/Obsolete

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

File:

• trunk/SRC/Obsolete/extrait.pro (modified) (2 diffs)

trunk/SRC/Obsolete/extrait.pro

@@ -4 +4 @@
 ;+
 ;
-; @fie-comments 
-; extractoin of subdomains of matrixes; Even if the subdomain is "pierced" (see the example)
+; @file_comments 
+; extraction of subdomains of matrixes; 
+; Even if the subdomain is "pierced" (see the example)
 ; By default, IDL can make extractions of subdomain:
 ;
@@ -38 +39 @@
 ; @categories utilities
 ;
-; @param tab {in}{required} a 1,2,3 or 4 dim table
+; @param tab {in}{required} 
+; a 1,2,3 or 4 dim table
 ;
-; @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.
+; @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.
 ;
-; @param indicey {in}{required} the same thing that indicex but for dim 2.
+; @param indicey {in}{required} 
+; the same thing that indicex but for dim 2.
 ;
-; @param indicez {in}{required} the same thing that indicex but for dim 3.
+; @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.
+; @param indicet {in}{required} 
+; the same thing that indicex but for dim 4.
 ;
-; @returns a matrix 1,2,3 or 4d extract from tab
+; @returns 
+; a matrix 1,2,3 or 4d extract from tab
 ;
-; @restrictions res=-1 in case of mistake
+; @restrictions 
+; res=-1 in case of mistake
+; 
+; @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:
+;      
+; IDL> res=extrait(A,[2,3,7],[0,1])
 ;
+; other ex:
+; IDL> print, a 
+; a b c
+; d e f
+; g h i
+; IDL> print, extrait(a,[0,2],[0,2])        
+; a c
+; g i
 ; 
-; @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])
-;
-;other ex:
-;      IDL> print, a 
-;      a b c
-;      d e f
-;      g h i
-;      IDL> print, extrait(a,[0,2],[0,2])        
-;      a c
-;      g i
-;
-; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       12/1/1999
-;                       29/4/1999: correction of a bug and complement of the heading
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+; 12/1/1999
+; 29/4/1999: correction of a bug and complement of the heading
 ;
 ; @version $Id$