From b587549ae2a0ed02d06268c23ae1163323074a27 Mon Sep 17 00:00:00 2001
From: Lionel GUEZ <guez@lmd.ens.fr>
Date: Thu, 30 Nov 2023 22:56:18 +0100
Subject: [PATCH] Polish

---
 Inst_eddies/Documentation_texfol/documentation.tex | 12 ++++++------
 Overlap/Documentation_texfol/documentation.tex     |  9 ++++++---
 Trajectories/cost_function.py                      |  7 +++++--
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/Inst_eddies/Documentation_texfol/documentation.tex b/Inst_eddies/Documentation_texfol/documentation.tex
index 8e08378a..716e66b0 100644
--- a/Inst_eddies/Documentation_texfol/documentation.tex
+++ b/Inst_eddies/Documentation_texfol/documentation.tex
@@ -57,12 +57,12 @@
 
 \section{Divers}
 
-La première partie détecte les tourbillons à chaque date. Un
-tourbillon est caractérisé par un extremum de SSH et un \og contour le
-plus extérieur\fg{}. Le contour le plus extérieur est une ligne de
-niveau de SSH. Il contient l'extremum considéré et aucun autre
-extremum de SSH et, par définition, aucune ligne de niveau extérieure
-au contour le plus extérieur n'a ces propriétés.
+Le programme \verb+inst_eddies+ détecte les tourbillons à chaque
+date. Un tourbillon est caractérisé par un extremum de SSH et un \og
+contour le plus extérieur\fg{}. Le contour le plus extérieur est une
+ligne de niveau de SSH. Il contient l'extremum considéré et aucun
+autre extremum de SSH et, par définition, aucune ligne de niveau
+extérieure au contour le plus extérieur n'a ces propriétés.
 
 L'approche retenue représente les contours par des polygones. Le
 résultat est un ensemble de fichiers contenant ces polygones et les
diff --git a/Overlap/Documentation_texfol/documentation.tex b/Overlap/Documentation_texfol/documentation.tex
index 882060f2..291d7c03 100644
--- a/Overlap/Documentation_texfol/documentation.tex
+++ b/Overlap/Documentation_texfol/documentation.tex
@@ -122,6 +122,10 @@ inférieure à $\delta'$. De même, un tourbillon donné à une date donnée
 peut avoir des prédécesseurs à différentes distances
 temporelles. Cf. figures \ref{fig:delta} et \ref{fig:overlap} et
 commentaires sur la procédure overlap.
+En résumé, une propriété topologique du graphe produit est que les
+motifs représentés sur la figure \ref{fig:motif_impossible} ne peuvent
+être présents dans le graphe.
+
 \begin{figure}[htbp]
   \centering
   \includegraphics{delta}
@@ -130,6 +134,7 @@ commentaires sur la procédure overlap.
     donne le graphe de recouvrement correspondant.}
   \label{fig:delta}
 \end{figure}
+
 \begin{figure}[htbp]
   \centering
   \includegraphics{overlap}
@@ -150,9 +155,7 @@ commentaires sur la procédure overlap.
     overlap.}
   \label{fig:overlap}
 \end{figure}
-En résumé, une propriété topologique du graphe produit est que les
-motifs représentés sur la figure \ref{fig:motif_impossible} ne peuvent
-être présents dans le graphe.
+
 \begin{figure}[htbp]
   \centering
   \includegraphics{motif_impossible}
diff --git a/Trajectories/cost_function.py b/Trajectories/cost_function.py
index 287122d9..0c3f6a9b 100755
--- a/Trajectories/cost_function.py
+++ b/Trajectories/cost_function.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 """This script takes the graph of segments without cost and computes
-the non-local cost applied to edges.
+the cost applied to edges.
 
 Input:
 
@@ -61,7 +61,9 @@ def node_to_prop(node_list, e_overestim, SHPC, orientation):
     instantaneous eddies. This function returns some properties of the
     eddies, read from shapefiles: position of extremum, radius of
     outermost contour or maximum speed contour, and speed. The three
-    properties are in a dictionary, for each eddy.
+    properties are in a dictionary, for each eddy. So the function
+    returns a list of dictionaries: one dictionary for each element of
+    node_list.
 
     """
 
@@ -135,6 +137,7 @@ last_av_rad = g.new_vp('float')
 last_av_ros = g.new_vp('float')
 
 if args.debug:
+    # Make the properties internal to the graph:
     g.vp['pos_first'] = pos_first
     g.vp['pos_last'] = pos_last
     g.vp['first_av_rad'] = first_av_rad
-- 
GitLab