geone 1.2.17__tar.gz → 1.2.18__tar.gz

{geone-1.2.17/geone.egg-info → geone-1.2.18}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: geone
-Version: 1.2.17
+Version: 1.2.18
 Summary: Geostatistics tools and Multiple Point Statistics
 Author-email: Julien Straubhaar <julien.straubhaar@unine.ch>, Philippe Renard <philippe.renard@unine.ch>
 License: 
@@ -74,12 +74,14 @@ Requires-Dist: numpy<2,>=1
 Requires-Dist: pandas
 Requires-Dist: pyvista
 Requires-Dist: scipy
+Dynamic: license
+Dynamic: license-file
 
 # GEONE
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
-**Current version : 1.2.17** <!-- Update manually here! see src/geone/_version.py -->
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
 
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
@@ -111,7 +113,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -130,7 +132,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -154,7 +156,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -178,7 +180,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.17 → geone-1.2.18}/README.md

@@ -2,7 +2,7 @@
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
-**Current version : 1.2.17** <!-- Update manually here! see src/geone/_version.py -->
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
 
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
@@ -34,7 +34,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -53,7 +53,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -77,7 +77,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -101,7 +101,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.17 → geone-1.2.18/geone.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: geone
-Version: 1.2.17
+Version: 1.2.18
 Summary: Geostatistics tools and Multiple Point Statistics
 Author-email: Julien Straubhaar <julien.straubhaar@unine.ch>, Philippe Renard <philippe.renard@unine.ch>
 License: 
@@ -74,12 +74,14 @@ Requires-Dist: numpy<2,>=1
 Requires-Dist: pandas
 Requires-Dist: pyvista
 Requires-Dist: scipy
+Dynamic: license
+Dynamic: license-file
 
 # GEONE
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
-**Current version : 1.2.17** <!-- Update manually here! see src/geone/_version.py -->
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
 
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
@@ -111,7 +113,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -130,7 +132,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -154,7 +156,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -178,7 +180,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.17 → geone-1.2.18}/src/geone/_version.py

@@ -1,6 +1,6 @@
 # Version
 
 # major, minor, micro
-version_info = (1, 2, 17)
+version_info = (1, 2, 18)
 
 __version__ = '.'.join(map(str, version_info))

{geone-1.2.17 → geone-1.2.18}/src/geone/blockdata.py

@@ -58,6 +58,8 @@ class BlockData(object):
     activatePropMax : sequence of floats of length `nblock`, optional
         maximal proportion of informed nodes in the block, above which the block
         data constraint is deactivated, for each block (used if `blockDataUsage=1`)
+
+    **Methods**
     """
     def __init__(self,
                  blockDataUsage=0,

{geone-1.2.17 → geone-1.2.18}/src/geone/covModel.py

@@ -728,6 +728,8 @@ class CovModel1D(object):
             ('gaussian', {'w':10., 'r':100.0}), # elementary contribution
             ('nugget', {'w':0.5})               # elementary contribution
             ], name='gau+nug')                  # name (optional)
+
+    **Methods**
     """
     #
     # Methods
@@ -1434,6 +1436,8 @@ class CovModel2D(object):
                 ('nugget', {'w':0.5})                        # elementary contribution
                 ], alpha=-30.0,                              # angle
                 name='')                                     # name (optional)
+
+    **Methods**
     """
     #
     # The 2x2 matrix m for changing the coordinates system from Ox'y' to Oxy is:
@@ -2604,6 +2608,8 @@ class CovModel3D(object):
                 ('nugget', {'w':0.5})                            # elementary contribution
                 ], alpha=-30.0, beta=-40.0, gamma=20.0,          # angles
                 name='')                                         # name (optional)
+
+    **Methods**
     """
     #
     # The 3x3 matrix m for changing the coordinates system from Ox'''y'''z'''

{geone-1.2.17 → geone-1.2.18}/src/geone/deesseinterface.py

@@ -36,7 +36,7 @@ class SearchNeighborhoodParameters(object):
     Class defining search neighborhood parameters (for deesse).
 
     **Attributes**
-    --------------
+
     radiusMode : str {'large_default', 'ti_range_default', 'ti_range', \
                     'ti_range_xy', 'ti_range_xz', 'ti_range_yz', 'ti_range_xyz', \
                     'manual'}, default: 'large_default'
@@ -135,7 +135,6 @@ class SearchNeighborhoodParameters(object):
         power for computing weight according to distance
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  radiusMode='large_default',
@@ -189,7 +188,7 @@ class SoftProbability(object):
     Class defining probability constraints for one variable (for deesse).
 
     **Attributes**
-    --------------
+
     probabilityConstraintUsage : int, default: 0
         defines the usage of probability constraints:
 
@@ -293,7 +292,6 @@ class SoftProbability(object):
         `probabilityConstraintThresholdType=1`
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  probabilityConstraintUsage=0,
@@ -433,7 +431,7 @@ class Connectivity(object):
     Class defining connectivity constraints for one variable (for deesse).
 
     **Attributes**
-    --------------
+
     connectivityConstraintUsage : int, default: 0
         defines the usage of connectivity constraints:
 
@@ -512,7 +510,6 @@ class Connectivity(object):
         used if `connectivityConstraintUsage=3`
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  connectivityConstraintUsage=0,
@@ -604,7 +601,7 @@ class PyramidGeneralParameters(object):
     Class defining "pyramid general parameters" (for all variables) (for deesse).
 
     **Attributes**
-    --------------
+
     npyramidLevel : int, default: 0
         number of pyramid level(s) (in addition to original simulation grid),
         integer greater than or equal to zero; if positive, pyramid is used and
@@ -703,7 +700,6 @@ class PyramidGeneralParameters(object):
         for the j-th pyramid level
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  npyramidLevel=0,
@@ -863,7 +859,7 @@ class PyramidParameters(object):
     Class defining "pyramid parameters" for one variable (for deesse).
 
     **Attributes**
-    --------------
+
     nlevel : int, default: 0
         number of pyramid level(s) (in addition to original simulation grid)
 
@@ -927,7 +923,6 @@ class PyramidParameters(object):
         during the simulation in every level)
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  nlevel=0,
@@ -991,7 +986,7 @@ class DeesseInput(object):
     Class defining main input parameters for deesse.
 
     **Attributes**
-    --------------
+
     simName : str, default: 'deesse_py'
         simulation name (useless)
 
@@ -1466,7 +1461,6 @@ class DeesseInput(object):
     [<n> is written on 5 digits, with leading zeros]
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  simName='deesse_py',
@@ -6396,7 +6390,7 @@ class DeesseXInputSectionPath(object):
     Class defining main input parameters for cross-simulation (deesseX).
 
     **Attributes**
-    --------------
+
     sectionMode: str {'section_xy_xz_yz', \
                       'section_xy_yz_xz', \
                       'section_xz_xy_yz', \
@@ -6575,7 +6569,6 @@ class DeesseXInputSectionPath(object):
             simulation grid along x, y, z axis respectively
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  sectionMode='section_xz_yz',
@@ -6725,7 +6718,7 @@ class DeesseXInputSection(object):
     Class input parameters for one section type (deesseX).
 
     **Attributes**
-    --------------
+
     nx : int, default: 0
         number of cells along x axis in the entire simulation grid (SG);
         should be consistent with the "parent" class :class:`DeesseXInput`
@@ -6876,7 +6869,6 @@ class DeesseXInputSection(object):
         as in :class:`DeesseInput`
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  nx=0, ny=0, nz=0,
@@ -7526,7 +7518,7 @@ class DeesseXInput(object):
     Class defining main input parameters for deesseX (cross-simulation/X-simulation).
 
     **Attributes**
-    --------------
+
     simName : str, default: 'deesseX_py'
         simulation name (useless)
 
@@ -7659,7 +7651,6 @@ class DeesseXInput(object):
     [<n> is written on 5 digits, with leading zeros]
 
     **Methods**
-    -----------
     """
     def __init__(self,
                  simName='deesseX_py',

{geone-1.2.17 → geone-1.2.18}/src/geone/img.py

@@ -82,6 +82,8 @@ class Img(object):
 
     name : str
         name of the image
+
+    **Methods**
     """
     #
     # Methods
@@ -398,19 +400,19 @@ class Img(object):
     # ------------------------------------------------------------------------
 
     # ------------------------------------------------------------------------
-    def set_spacing(self, sx, sy, sz):
+    def set_spacing(self, sx=1.0, sy=1.0, sz=1.0):
         """
         Sets spacing, i.e. cell size along each axis.
 
         Parameters
         ----------
-        sx : float
+        sx : float, default: 1.0
             cell size along x axis
 
-        sy : float
+        sy : float, default: 1.0
             cell size along y axis
 
-        sz : float
+        sz : float, default: 1.0
             cell size along z axis
         """
         # fname = 'set_spacing'
@@ -421,7 +423,7 @@ class Img(object):
     # ------------------------------------------------------------------------
 
     # ------------------------------------------------------------------------
-    def set_origin(self, ox, oy, oz):
+    def set_origin(self, ox=0.0, oy=0.0, oz=0.0):
         """
         Sets grid origin (bottom-lower-left corner).
 
@@ -446,9 +448,9 @@ class Img(object):
     # ------------------------------------------------------------------------
     def set_grid(
             self,
-            nx, ny, nz,
-            sx, sy, sz,
-            ox, oy, oz,
+            nx=1,   ny=1,   nz=1,
+            sx=1.0, sy=1.0, sz=1.0,
+            ox=0.0, oy=0.0, oz=0.0,
             newval=np.nan):
         """
         Sets grid geometry (dimension, cell size, and origin).
@@ -1456,6 +1458,8 @@ class PointSet(object):
 
     name : str
         name of the point set
+
+    **Methods**
     """
     #
     # Methods
@@ -2129,14 +2133,14 @@ class Img_interp_func(object):
     iz : int or `None` (default)
         same as `ix`, but for z axis
 
-    angle_var: bool, default: False
+    angle_var : bool, default: False
         - if `True`: variable to be interpolated are considered as angles, and the \
         interpolation is done by first interpolating the cosine and the sine of \
         the angle values and then by retrieving the corresponding angle (by \
         using the function `numpy.arctan2`)
         - if `False`: values are interpolated directly
 
-    angle_deg: bool, default: True
+    angle_deg : bool, default: True
         used if `angle_var=True`:
 
         - if `True`: the variable values are angles in degrees
@@ -2184,6 +2188,8 @@ class Img_interp_func(object):
         >>>     method='linear', bounds_error=False, fill_value=np.nan)
         >>> v2 = interp2(points) # gives same values except for points beyond
         >>>                      # the domain of the image grid
+
+    **Methods**
     """
     def __init__(self,
                  im,

{geone-1.2.17 → geone-1.2.18}/src/geone/imgplot.py

@@ -928,7 +928,10 @@ def drawImage2Drgb(im, nancol=(1.0, 0.0, 0.0)):
     ind_isnan = np.any(np.isnan(vv), axis=1)
     vv[ind_isnan, :] = nancolf
 
-    plt.imshow(vv.reshape(im.ny, im.nx, -1), origin='lower')
+    min0, max0 = im.ox, im.xmax()
+    min1, max1 = im.oy, im.ymax()
+
+    plt.imshow(vv.reshape(im.ny, im.nx, -1), origin='lower', extent=[min0, max0, min1, max1])
 # ----------------------------------------------------------------------------
 
 # ----------------------------------------------------------------------------

{geone-1.2.17 → geone-1.2.18}/src/geone/tools.py

@@ -165,7 +165,7 @@ def add_path_by_drawing(
 # -----------------------------------------------------------------------------
 
 # -----------------------------------------------------------------------------
-def is_in_polygon(x, vertices, wrap=None, **kwargs):
+def is_in_polygon(x, vertices, wrap=None, return_sum_of_angles=False, **kwargs):
     """
     Checks if point(s) is (are) in a polygon given by its vertices forming a close line.
 
@@ -175,6 +175,10 @@ def is_in_polygon(x, vertices, wrap=None, **kwargs):
     and first one). Then, the point is in the polygon if and only if this sum
     is equal to +/- 2 pi.
 
+    Note that if the sum of angles is +2 pi (resp. -2 pi), then the vertices form
+    a close line counterclockwise (resp. clockwise); this can be checked by
+    specifying a point `x` in the polygon and `return_sum_of_angles=True`.
+
     Parameters
     ----------
     x : 2D array-like or 1D array-like
@@ -195,6 +199,9 @@ def is_in_polygon(x, vertices, wrap=None, **kwargs):
 
         by default (`None`): `wrap` is automatically computed
 
+    return_sum_of_angles : bool, default: False
+        if `True`, the sum of angles (computed by the method) is returned
+
     kwargs :
         keyword arguments passed to function `numpy.isclose`
 
@@ -205,6 +212,12 @@ def is_in_polygon(x, vertices, wrap=None, **kwargs):
         the polygon;
         note: if `x` is of shape (m, 2), then `out` is a 1D array of shape (m, ),
         and if `x` is of shape (2, ) (one point), `out` is bool
+
+    sum_of_angles : 1D array of floats, or float
+        returned if `return_sum_of_angles=True`; for each point in `x`, the sum
+        of angles computed by the method is returned (`nan` if the sum is not
+        computed);
+        note: `sum_of_angles` is an array of same shape as `out` or a float
     """
     # fname = 'is_in_polygon'
 
@@ -221,6 +234,8 @@ def is_in_polygon(x, vertices, wrap=None, **kwargs):
     # Initialization
     xx = np.atleast_2d(x)
     res = np.zeros(xx.shape[0], dtype='bool')
+    if return_sum_of_angles:
+        res_sum = np.full((xx.shape[0],), np.nan)
 
     xmin, ymin = vertices.min(axis=0)
     xmax, ymax = vertices.max(axis=0)
@@ -247,18 +262,25 @@ def is_in_polygon(x, vertices, wrap=None, **kwargs):
         c = b - a
         c_norm2 = (c**2).sum(axis=1)
         sign = 2*(a[:,0]*b[:,1] - a[:,1]*b[:,0] > 0) - 1
-        sum_angles = np.sum(sign*np.arccos(np.minimum(1.0, np.maximum(-1.0, (a_norm2 + b_norm2- c_norm2)/(2.0*ab_norm)))))
+        sum_angles = np.sum(sign*np.arccos(np.minimum(1.0, np.maximum(-1.0, (a_norm2 + b_norm2 - c_norm2)/(2.0*ab_norm)))))
 
         res[j] = np.isclose(np.abs(sum_angles), 2*np.pi)
+        if return_sum_of_angles:
+            res_sum[j] = sum_angles
 
     if np.asarray(x).ndim == 1:
         res = res[0]
+        if return_sum_of_angles:
+            res_sum = res_sum[0]
+
+    if return_sum_of_angles:
+        return res, res_sum
 
     return res
 # -----------------------------------------------------------------------------
 
 # -----------------------------------------------------------------------------
-def is_in_polygon_mp(x, vertices, wrap=None, nproc=-1, **kwargs):
+def is_in_polygon_mp(x, vertices, wrap=None, return_sum_of_angles=False, nproc=-1, **kwargs):
     """
     Computes the same as the function :func:`tools.is_in_polygon`, using multiprocessing.
 
@@ -287,6 +309,9 @@ def is_in_polygon_mp(x, vertices, wrap=None, nproc=-1, **kwargs):
     # Set wrap key in keywords arguments
     kwargs['wrap'] = True
 
+    # Set return_sum_of_angles key in keywords arguments
+    kwargs['return_sum_of_angles'] = return_sum_of_angles
+
     # Initialization
     xx = np.atleast_2d(x)
 
@@ -312,10 +337,25 @@ def is_in_polygon_mp(x, vertices, wrap=None, nproc=-1, **kwargs):
     pool.join()  # then, wait for the worker processes to exit.
 
     # Get result from each process
-    res = np.hstack([w.get() for w in out_pool])
+    if return_sum_of_angles:
+        res = []
+        res_sum = []
+        for w in out_pool:
+            r, s = w.get()
+            res.append(r)
+            res_sum.append(s)
+        res = np.hstack(res)
+        res_sum = np.hstack(res_sum)
+    else:
+        res = np.hstack([w.get() for w in out_pool])
 
     if np.asarray(x).ndim == 1:
         res = res[0]
+        if return_sum_of_angles:
+            res_sum = res_sum[0]
+
+    if return_sum_of_angles:
+        return res, res_sum
 
     return res
 # -----------------------------------------------------------------------------
@@ -363,20 +403,20 @@ def rasterize_polygon_2d(
     nx : int, optional
         number of grid cells along x axis; see above for possible inputs
 
-    ny : int
+    ny : int, optional
         number of grid cells along y axis; see above for possible inputs
 
-    sx : float
+    sx : float, optional
         cell size along x axis; see above for possible inputs
 
-    sy : float
+    sy : float, optional
         cell size along y axis; see above for possible inputs
 
-    ox : float
+    ox : float, optional
         origin of the grid along x axis (x coordinate of cell border);
         see above for possible
 
-    oy : float
+    oy : float, optional
         origin of the grid along y axis (y coordinate of cell border);
         see above for possible
 
@@ -559,6 +599,7 @@ def curv_coord_2d_from_center_line(
     -------
     u : 2D array or 1D array (same shape as `x`)
         coordinates in curvilinear system of the input point(s) `x` (see above)
+
     x_path : list of 2D arrays (or 2D array), optional
         path(s) from the initial point(s) to the point(s) I of the centerline
         (descending the gradient of the distance map):