You should have received a copy of the GNU General Public License
along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
-######################################
-Interprétation du format SinusX
-######################################
+#############################################################
+Interpretation of the SinusX format: historic (for old files)
+#############################################################
-Structure du fichier et types de lignes
-=======================================
+File structure and line types
+=============================
+The ASCII file is structured in data blocks.
-Le fichier ASCII est structuré en blocs de données.
+The lines that start with *B* are block limiters.
-Les lignes commençant par *B* sont des délimiteurs de bloc.
+The lines starting with *CN* or *CP* complete the block definition.
-Les lignes commençant par *CN* ou *CP* complètent la définition du bloc.
+The other lines starting with *C* are comments.
-Les autres lignes commençant par *C* sont des commentaires.
+The lines that start with numbers are the block pointers.
-Les lignes commençant par des nombres sont les points du bloc.
+It is possible to describe scatter plots, xyz curves, profiles and isocontours.
-On peut décrire des semis de points, des courbes xyz, des profils, des courbes de niveau.
+Depending on the format, the curves may or may not be connected and may be closed or open.
+In practice, a curve that is not connected is a type of scatter plot...
+The SALOME HYDRO module takes into account xyz points, curves in the XOY plane (z=0)
+and curves in the XOZ plane (profiles).
+Three types of processing can be used to handle curves in space (any Z, variable or not)
+during import in the HYDRO module:
-Selon le format, les courbes peuvent être reliées ou non, fermées ou non.
-En pratique, une courbe non reliée est une sorte de semis de point...
+* Projection at z=0 to have a connected curve in the XOY plane.
+* Creation of a line in the XOZ plane (curvilinear abscissa for the XOY curve, altitude).
+* Import of x,y,z points that are not connected as Bathymetry/altimetry
-Le module HYDRO de SALOME prend en compte des points xyz, des courbes dans le plan XoY (z=0),
-des courbes dans le plan XoZ (profils).
-Pour traiter les courbes dans l'espace (Z quelconque, variable ou non),on peut faire 3 types
-de traitements lors de l'import dans le module HYDRO :
+The first import is the most important and should be done systematically.
-* projeter en z=0 pour avoir une courbe reliée dans le plan XoY.
-* créer une ligne dans le plan XoZ (abscisse curviligne de la courbe XoY, altitude).
-* importer les points x,y,z non reliés comme Bathymétrie/altimétrie.
+The second is useful for xyz curves, where Z is variable.
-Le premier import est le plus important et doit être fait systématiquement.
+The third is not easy to use directly in the HYDRO module, beyond the simple visualisation
+of the Bathymetry/altimetry point fields in 3D. The contour of the Bathymetry/altimetry
+field in the XOY plane is needed for the nodal interpolation of the altitude; however,
+it makes no real linear sense. On the other, a Bathymetry/altimetry can be
+reconstituted by combining the points of several lines (for example, a series of isocontours)
+in a single point cloud.
-Le second est utile pour des courbes xyz, quand Z est variable.
-
-Le troisième n'est pas facile à utiliser directement dans le module HYDRO, au delà de la simple visualisation
-des champs de points de Bathymétrie/altimétrie en 3D. Pour l'interpolation d'altitude au noeuds du maillage,
-on a besoin du contour du champ de Bathymetrie/altimétrie dans le plan XoY.
-Ce contour n'a pas vraiment de sens pour une ligne.
-Par contre, en combinant les points de plusieurs lignes (par exemple une série de courbes de niveau)
-dans un même nuage de points, on peut reconstituer une Bathymétrie/altimétrie.
-
-Délimiteur de bloc
-==================
+Block delimiter
+===============
::
- B type x1 y1 z1 dx dy dz rapport
+ B type x1 y1 z1 dx dy dz scale
type
----
-* type = S semis de point
-* type = C courbe xyz
-* type = P profil xyz
-* type = N courbe de niveau
+* type = S scatterplot
+* type = C xyz curve
+* type = P xyz profile
+* type = N isocontour
-x1 y1 z1 dx dy dz rapport
+x1 y1 z1 dx dy dz scale
-------------------------
-Origine et deltas pour convertir les mesures de la table à digitaliser en mètres.
+Origin and deltas for conversion of measurements to metres in the table to be digitized.
-On n'en tient pas compte à l'import.
+This is ignored on import
-exemples de lignes B
---------------------
+examples of B-type lines
+------------------------
::
B type 0.0 0.0 0.0 1.0 1.0 1.0 1.0
-ou plutôt, à préférer
+or, preferably, just
::
B type
-Nom du bloc
-===========
+Data Block Name
+===============
::
- CN le_nom_du_bloc
+ CN the_block_name
Import
------
-
-Remplacer les espaces par '_' (exemple : courbe 1 --> courbe_1)
+Replace spaces by an underscore ‘_’ (example: curve 1 -> curve_1)
Export
------
-Les noms des objets dans le module HYDRO. Éviter les espaces et caractères accentués dans les noms.
+Names of the objects in the HYDRO module. Avoid the use of spaces and accented characters in the names.
-Liaison Fermeture
-=================
+Closure connection
+==================
-Définition historique
+Historical definition
---------------------
::
- CP fermé relié
+ CP closed connection
-Deux booleens indiquant si la courbe est fermée, et si les points sont reliés
+Two booleans indicate whether the curve is closed or not and whether the points are connected
-*exemple* : CP 0 1 : courbe ouverte, points reliés.
+*example*: CP 0 1: open curve, linked points.
-En pratique, on ne doit pas avoir besoin de points non reliés, sauf les semis.
+In practice, there should be no need for unconnected points, except for the scatter plots
-Proposition d'interprétation et export
---------------------------------------
+Interpretation proposition and export
+-------------------------------------
::
- CP fermé spline
+ CP closed spline
-Deux booleens indiquant si la courbe est fermée, et si elle est de type spline ou ligne brisée.
-Il faudra corriger manuellement les jeux de données existant pour les courbes fermées, et les polygones.
+Two booleans indicate whether the curve is closed and whether it is the spline or broken-line type.
+The existing data sets for the closed curves and the polygons have to be corrected manually.
-Plan de définition
-==================
+Definition plane
+================
::
- CP numeroPlan
+ CP PlaneNumber
-Le numéro du plan vaut 0, 1 ou 2 (0 : plan XoY, 1 : plan YoZ, 2 : plan XoZ)
+The plane number is entered as 0, 1 or 2 (0: XOY plane, 1: YOZ plane, 2: XOZ plane).
-La plupart des blocs sont dans le plan XoY : CP 0
+Most data blocks are in the XOY plane: CP 0
-On peut utiliser les plans 1 ou 2 pour définir des profils / section dans un plan normal à l'axe hydraulique,
-avec deux coordonnées utiles. En pratique, on utilisera systématiquement le plan 2.
+Plane numbers 1 or 2 serve to define profiles / sections in a normal plane to the hydraulic axis,
+with two useful coordinates. In practice, plane 2 will be used systematically.
-Paramètres complémentaires selon le type de blocs
-=================================================
+Additional block-type related parameters
+========================================
-type = S semis de point
------------------------
+type = S scatterplot
+--------------------
-Sans objet
+Not applicable
-type = C courbe xyz
--------------------
+type = C xyz curve
+------------------
::
- CP (16 indicateurs réels)
+ CP (16 real indicators)
-Inutilisé - pas interprété à l'import.
+Not used – not interpreted on import.
-Soit on fait un export compatible::
+Either a compatible export is made:
- CP 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
+::
-Soit on ne met rien : préférable.
+ CP 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
-type = P profil xyz
--------------------
+Or nothing is input here: preferable.
-Définition historique
+type = P xyz profile
+--------------------
+
+Historical definition
~~~~~~~~~~~~~~~~~~~~~
::
CP Zref Xref dz dx
-Je n'ai pas compris comment c'était utilisé en altitude...
+TO BE COMPLETED
-interprétation proposée pour un profil dans le plan *XoZ*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-En pratique profil dans un plan vertical avec la donnée des 2 extrémités géoreférencées.
-On suppose que la troisième coordonnée des points est à 0.
+Proposed interpretation for a profile in the *XOZ* plan
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In practice, this is a profile in the vertical plane with the georeferenced
+positions of the two extremities given. It is assumed that the third coordinate of the points is 0.
::
- CP Xorig Yorig Xfin Yfin
-
-(Xorig, Yorig) et (Xfin, Yfin) extrémités géoréférencées du profil.
+ CP Xorig Yorig Xend Yend
-On passe d'un point (x,z) au point géoréférencé (ref +x*dx, yref +x*dy, z), avec (dx,dy) vecteur horizontal
-normé calculé à partir des 2 extrémités géoréférencées.
+(Xorig, Yorig) and (Xend, Yend) are the georeferenced positions of the profile endpoints.
-interprétation proposée pour un profil dans le plan *XoY*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+We go from a point (x, z) to the georeferenced point (ref +x*dx, yref +x*dy, z), with (dx, dy)
+the normalized horizontal vector calculated from the two georeferenced end-points.
-On suppose que les points sont déjà géoréférencés, avec leurs 3 coordonnées valides.
+Proposed interpretation for a profile in the XOY plan
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The points are assumed to be already georeferenced, each with three valid coordinates.
-On peut regrouper plusieurs profils dans SALOME HYDRO pour créer un objet rivière ('stream')
+Several profiles can be grouped together in SALOME HYDRO to create a river object ('stream').
-type = N courbe de niveau
--------------------------
+type = N isocontour
+-------------------
::
CP altitude
-Altitude de la courbe de niveau. On retrouve la valeur dans la coordonnée Z de chaque point.
+Altitude of the isocontour. This is the Z-coordinate value of each point.
-import : prendre cette valeur en référence,
-ignorer la coordonnée Z des points (toujours la même valeur dans les exemples) ?
+Import: take this value as reference, ignoring the Z coordinate of individual points (FIXME: always the same value in the examples?)
-Lignes de Commentaires
-======================
+Comment lines
+=============
::
- C texte quelconque
+ C any text
-ignoré à l'import
+Ignored on import
-on peut mettre en tête de fichier des informations d'export à définir, par exemple :
+Export information that needs to be defined can be put in the file header, for example:
C SALOME HYDRO version xxx
-C nom de l'étude SALOME
+C name of the SALOME study
-C date
+C date
-Lignes de points
-================
+Point lines
+===========
::
- X Y Z touche texte
+ X Y Z text key
-touche
-------
+key
+---
-inutilisé, ignorer
+Not used, ignore
-texte
------
+text
+----
-un label associé au point : inutilisé, ignorer
+A label associated with the point: not used, ignore
import
------
+For isocontours, the Z value can be ignored, as it is defined at block level.
-Pour les courbes de niveau, on peut ignorer Z, il est défini au niveau du bloc.
-
-Quand deux points consécutifs ont les mêmes coordonnées, il faut ignorer le deuxième point.
-(cas rencontré dans des jeux de données).
+When two consecutive points have the same coordinates (which may occur with
+some data sets), the second point should be ignored.
export
------
+Depending on the nature of the curves, the unnecessary coordinate is set to zero.
+Note: imported isocontours are converted to curves in the Z=0 plane and grouped together in scatter
+plots. The isocontour information is lost in SALOME and it is not possible to export them as isocontours with the altitude entered.
-Selon la nature des courbes, on met à zéro la coordonnée inutile.
-
-remarque : les courbes de niveau importées sont transformées en courbes dans le plan Z=0
-et regroupées en semis de points. On perd l'information courbe de niveau dans SALOME et on ne saura pas
-les exporter en tant que courbe de niveau avec l'altitude renseignée.
-
-Pour les courbes projetées dans le plan XoY::
+For curves projected in the XOY plane::
X Y 0.0
-Pour les courbes projetées dans le plan XoZ::
+For curves projected in the XOZ plane::
- X 0.0 Z
+ X 0.0 Z
-Pour les profils géoréférencés XoY::
+For the XOY georeferenced profiles::
X Y Z
-exemple de courbe XYZ
-=====================
+XYZ curve example
+=================
-Ici, il s'agit en réalité d'une courbe de niveau Z=9.0, mais elle n'est pas définie comme telle.
+This is actually an isocontour with Z=9.0, though not defined as such.
import
------
::
B C -3.333330E+03 +4.875000E+04 +0.000000E+00 +3.333330E+02 +1.666670E+02 +1.000000E+00 0.658992
- CN trait_cote_ile
- CP 1 1
- CP +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00
- CP 0
- C
+ CN island_shore_line
+ CP 1 1
+ CP +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00 +0.000000E+00
+ CP 0
+ C
211563.340 133489.165 9.000 A
211604.013 133517.519 9.000 A
211645.047 133544.734 9.000 A
``B C -3.3...``
- bloc de type C (courbe xyz), parametres de digitalisation ignorés
+ block type C (xyz curve), digitization parameters ignored
``CN ...``
- nom du bloc = trait_cote_ile
+ block name = island_shore_line
``CP 1 1``
- courbe fermée, spline
+ closed curve, spline
``CP +0.0...``
- ignoré
+ ignored``CP 0``
``CP 0``
plan XoY (ça doit toujours être le plan 0)
``C ...``
- les commentaires sont ignorés
+ the comments are ignored
``211563.340 133489.165 9.000 A``
- point x, y, z. Les informations supplémentaires sont ignorées.
+ x, y, z point data. The additional information is ignored.
-Si toutes les valeurs Z du bloc sont à zéro, les valeurs Z sont ignorées.
-Si au moins une valeur Z du bloc est différente de zéro, alors les points alimentent un semis
-regroupant les différentes courbes du fichier.
+If all the Z values of the block are zero, they are ignored.
+If at least one Z coordinate of the block has a non-zero value, then
+the points supply a scatter plot containing the data points of the different file curves.
export
------
-
-Courbe projetée dans le plan XoY sous forme de courbe de niveau à Z=0.
-C'est une courbe fermée, spline.
+A curve projected in the XOY plane in the form of an isocontour at Z = 0.
+It is a closed, spline curve.
::
B N
- CN trait_cote_ile
- CP 1 1
+ CN island_shore_line
+ CP 1 1
CP 0.0
CP 0
C
211569.826 133461.954 0.000
-exemple de courbe de niveau
-===========================
+Isocontour example
+==================
-Ici, on a repris l'exemple précédent en changeant le type de courbe : B N au lieu de B C
-et indication de l'altitude dans l'en tête : CP 9.0.
+Using the data from the example above, the curve type is changed: B N instead of B C
+and the altitude is indicated in the header: CP 9.0.
import
------
::
B N -3.333330E+03 +4.875000E+04 +0.000000E+00 +3.333330E+02 +1.666670E+02 +1.000000E+00 0.658992
- CN trait_cote_ile
- CP 1 1
- CP 9.0
- CP 0
- C
+ CN island_shore_line
+ CP 1 1
+ CP 9.0
+ CP 0
+ C
211563.340 133489.165 9.000 A
211604.013 133517.519 9.000 A
211645.047 133544.734 9.000 A
``B N -3.3...``
- bloc de type N (courbe de niveau), paramètres de digitalisation ignorés
+ block type N (isocontour), digitization parameters ignored
``CN ...``
- nom du bloc = trait_cote_ile
+ block name = island_shore_line
``CP 1 1``
- courbe fermée, spline
+ closed curve, spline
``CP 9.0``
- altitude de la courbe.
+ curve altitude
``CP 0``
- plan XoY
+ XoY plane
``C ...``
- les commentaires sont ignorés
+ the comments are ignored
``211563.340 133489.165 9.000 A``
- point x, y, z. Les informations supplémentaires sont ignorées.
+ x, y, z point data. The additional information is ignored.
-Les valeurs Z des points sont ignorées. On alimente le semis de points
-avec les points de la courbe avec z forcé à 9.0.
+The Z point values are ignored. The scatter plots are supplied with the
+curve points, with z forced to 9.0.
export
------
-Courbe projetée dans le plan XoY sous forme de courbe à Z=0.
-C'est une courbe fermée, spline.
+A curve, projected in the XOY plane in the form of a curve at Z = 0.
+It is a closed, spline curve.
::
B N
- CN trait_cote_ile
- CP 1 1
+ CN island_shore_line
+ CP 1 1
CP 0.0
CP 0
C
211597.633 133447.736 0.000
211569.826 133461.954 0.000
-
-Courbe projetée dans le plan XoZ selon l'abscisse curviligne.
-C'est une courbe ouverte de type spline, définie par convention dans le plan XoZ.
+Curve projected in the XOZ plane along the curvilinear abscissa.
+This is an open, spline-type curve, defined by convention in the XOZ plane.
::
B P
- CN altitude_trait_cote_ile
+ CN altitude_island_shore_line
CP 0 1
CP 0.0 0.0 0.0 0.0
CP 2
...
x 9.0
-*Les extrémités ne sont pas géoréférencées, on s'appuie sur une autre courbe XoY*.
-Pour distinguer les profils XoZ non géoréférencés de ceux qui le sont (par leur extrémités),
-on utilise une valeur particulière du champ CP avec des coordonnées nulles::
+*The ends are not georeferenced; they are defined with respect to another XOY curve.*
+To distinguish the XOZ profiles that are not georeferenced from those that
+are (by endpoints), a specific value with null coordinates is used for the CP field::
CP 0.0 0.0 0.0 0.0
-Les valeurs x des abscisses curvilignes sont exprimées en mètre le long de la courbe,
-ou sont normalisées entre 0 et 1. **A revoir**
+The x values of the curvilinear abscissae are expressed in metres along
+the curve or normalized between 0 and 1. **To be reviewed**.
-Synthèse
-========
+Summary
+=======
-Dans le module HYDRO de SALOME, lors de l'importation des fichiers SinusX existant,
+In the SALOME HYDRO module, when existing SinusX files are imported:
-- les semis de points sont transformés en Bathymétries.
-- les courbes de niveau sont transformées en courbes à Z=0 et profils dans le plan XoZ,
- non géoréférencés (abscisse curviligne, z).
-- les courbes xyz sont transformées en courbes à Z=0 et en profils dans le plan XoZ,
- non géoréférencés (abscisse curviligne, z).
-- les profils XoZ géoréférencés par les coordonnées des extrémités sont convertis
- en profils où tous les points sont définis par leurs 3 coordonnées X, Y, Z (profils XoY).
-- les profils XoZ non géoréférencés sont importés tels que
- (utilisés comme ligne d'altitude pour une autre ligne dans le plan XoY,
- ou comme section pour un canal, une digue...)
-- les profils XoY sont conservés tels quels (tous les points sont définis par leurs 3 coordonnées X, Y, Z).
-- l'ensemble des points des courbes de niveau (avec Z différent de 0) et des courbes xyz servent
- à créer un champ de Bathymétrie.
+- scatter plots are imported as Bathymetries.
+- isocontours are converted to curves at Z=0 and non-georeferenced profiles
+ profiles in the XOZ plane (curvilinear abscissa, z).
+- XYZ curves are converted to curves at Z=0 and profiles that are not
+ georeferenced in the XOZ plane (curvilinear abscissa, z).
+- XOZ profiles georeferenced by endpoint coordinates are converted into
+ profiles whose points are all defined by their X, Y, Z coordinates (XOY profiles).
+- XOZ profiles that are not georeferenced are imported as is (used as a line
+ of altitude for another line in the XOY plane or as a section for a channel, embankment, etc.)
+- the XOY profiles are kept as such (all points are defined by their respective
+ X, Y, Z coordinates).
+- All the point data of the isocontours (with non-zero Z values) and xyz
+ curves are used to create a Bathymetry field.
-Lors de l'export,
+During file export,
-- les polylignes sont exportées en courbes de niveau Z=0, ouvertes ou fermées, spline ou ligne brisée.
- (Que fait-on des sections ? Utiliser un commentaire de début de section sur le point ?)
-- les profils sont exportés en tant que profils (à approfondir)
-- Doit on exporter les bathymétries au format SinusX ou au format xyz ? (ne diffère que par la présence d'un en tête).
+- the polylines are exported as zero-level isocontours, open or closed, spline
+ or broken line. (What is done with the sections? Use a beginning of section comment on the point?)
+- the profiles are exported as such (to be developed)
+- Should bathymetries be exported in SinusX format or in xyz format?
+ (only differs by the presence of a header line)
+- Dans le module HYDRO de SALOME, lors de l'importation des fichiers SinusX existant,
.. only:: html
-
- :ref:`ref_formatsSpecs`
+
+ :ref:`ref_english_formatsSpecs`
