Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
correction for documentation
  • Loading branch information
ludwigVonKoopa committed May 14, 2021
commit 006adc5f0b300e93a84333198945f91d4fb2cb0a
5 changes: 3 additions & 2 deletions src/py_eddy_tracker/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ def build_index(groups):
:param array groups: array that contains groups to be separated
:return: (first_index of each group, last_index of each group, value to shift groups)
:rtype: (array, array, int)
Examples
--------

:Example:

>>> build_index(array((1, 1, 3, 4, 4)))
(array([0, 2, 2, 3]), array([2, 2, 3, 5]), 1)
"""
Expand Down
6 changes: 3 additions & 3 deletions src/py_eddy_tracker/observations/network.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ def from_split_network(cls, group_dataset, indexs, **kwargs):

:param TrackEddiesObservations group_dataset: Group dataset
:param indexs: result from split_network
return NetworkObservations
:return: NetworkObservations
"""
index_order = indexs.argsort(order=("group", "track", "time"))
network = cls.new_like(group_dataset, len(group_dataset), **kwargs)
Expand Down Expand Up @@ -1598,8 +1598,8 @@ def group_translator(nb, duos):
:param int nb: size of translator
:param set((int, int)) duos: set of all groups that must be joined

Examples
--------
:Example:

>>> NetworkObservations.group_translator(5, ((0, 1), (0, 2), (1, 3)))
[3, 3, 3, 3, 5]
"""
Expand Down
1 change: 1 addition & 0 deletions src/py_eddy_tracker/poly.py
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,7 @@ def visvalingam(x, y, fixed_size=18):
"""Polygon simplification with visvalingam algorithm

X, Y are considered like a polygon, the next point after the last one is the first one

:param array x:
:param array y:
:param int fixed_size: array size of out
Expand Down