Changeset 133 for trunk/SRC/Utilities/lineintersection.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Utilities/lineintersection.pro (moved) (moved from trunk/SRC/ToBeReviewed/UTILITAIRE/lineintersection.pro) (1 diff)

trunk/SRC/Utilities/lineintersection.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: lineintersection
 ;
-; PURPOSE: Calcule les coordonnees de l''intersection de 2 droites ou
-; d''une serie de 2 droites
+; @file_comments 
+; Calculate coordinates of the intersection between 2 straight lines 
+; or of a succession of 2 straight lines.
 ;
-; CATEGORY:petit truc qui peut etre utile (sans boucles, ca va de soit!)
+; @categories utilities
+; 
+; @param abc1 {in}{required} is the first table of dimension 3, number_of_pairs_of_straight_lines, 
+;         whose each line contain the 3 parameters a,b and c of the first linear 
+;         equation of the type ax+by+c=0
 ;
-; CALLING SEQUENCE: point=lineintersection(abc1, abc2)
-; 
-; INPUTS: abc est un tableau de dimensions 3,
-; nbre_de_couple_de_droites, dont chaque ligne contient les 3
-; parametres a, b, c de l''equation de droite du type ax+by+c=0
+; @param abc2 {in}{required} is second table of dimension 3, number_of_pairs_of_straight_lines, 
+;         whose each line contain the 3 parameters a,b and c of the second linear 
+;         equation of the type ax+by+c=0
 ;
-; KEYWORD PARAMETERS:
-;       /FLOAT: pour retourner l''output sous forme de tableau de
-;       reel plutot que de vecteur decomplexes (par defaut)
+; @keyword FLOAT To return the output as a table of real numbers instead of vectors of complex (by default)
 ;
-; OUTPUTS:2 possibilites:
-;      1) par defaut: c''est une vecteur de complexe dont chaque
-;      element est les coordonnees du point d''intersection d''un
-;      couple de droites.
-;      2) si /FLOAT est active, c'est un tableau de reels de
-;      dimensiones 2, nbre_de_couple_de_droites dont chaque
-;      ligne est les coordonnees du point d''intersection d''un
-;      couple de droites
+; @returns 2 possibilities:
+;      1) by default: it is a vector of complex whose each element is the coordinates 
+;                     of the intersection point of a pair of straight lines.
+;      2) if FLOAT is activated, it is a table of reals of dimension 2, 
+;         number_of_pairs_of_straight_lines whose each row is the coordinates 
+;         of the intersection point of a pair of straight line.
 ;
-; COMMON BLOCKS:
+; @restrictions If the 2 straight line are parallel, we return coordinates (!values.f_nan,!values.f_nan)
 ;
-; SIDE EFFECTS:si les deux droites dont paralleles, on retourne les
-; coordonnes (!values.f_nan,!values.f_nan)
+; @restrictions Beware of the precision of the machine which make 
+;               that calculated coordinates may not exactly verify 
+;               equations of the pair of straight lines.
 ;
-; RESTRICTIONS:attention a la precision de la machine qui fait que
-; les coordonnees calcules de verifient peut-etre pas exactement les
-; equations du couple de droites.
+; @examples IDL> abc1=linearequation(complex(1,2),[3,4])
+;           IDL> abc2=linearequation(complex(1,2),[8,15])
+;           IDL> print, lineintersection(abc1, abc2)
+;           (      1.00000,      2.00000)
+;           IDL> print, lineintersection(abc1, abc2,/float)
+;                 1.00000      2.00000
 ;
-; EXAMPLE:
-;     IDL> abc1=linearequation(complex(1,2),[3,4])
-;     IDL> abc2=linearequation(complex(1,2),[8,15])
-;     IDL> print, lineintersection(abc1, abc2)
-;     (      1.00000,      2.00000)
-;     IDL> print, lineintersection(abc1, abc2,/float)
-;           1.00000      2.00000
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      10 juin 2000
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------