Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs & typehints - artifacts.py.{ccss_special_case(), filter_connections()} #127

Merged
merged 3 commits into from
Dec 3, 2024
Merged

docs & typehints - artifacts.py.{ccss_special_case(), filter_connections()} #127

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3694b3
docwork - artifacts.py - ccss_special_case(), filter_connections()
jGaboardi Dec 2, 2024
c8a33a1
another s
jGaboardi Dec 2, 2024
ba1b1da
it is inverse of not wanted
martinfleis Dec 3, 2024
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
84 changes: 63 additions & 21 deletions sgeop/artifacts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,35 @@ def _relate(neighs: tuple, cond: callable) -> bool:


def ccss_special_case(
primes, conts_groups, highest_hierarchy, relevant_nodes, split_points
):
# If there are primes on both Cs, connect them. If there's prime on one C,
# connect it to the other C. If there are no primes, get midpoints on Cs and
# connect those.
primes: gpd.GeoSeries,
conts_groups: gpd.GeoDataFrame,
highest_hierarchy: gpd.GeoDataFrame,
relevant_nodes: gpd.GeoDataFrame,
split_points: list,
) -> np.ndarray:
"""If there are primes on both ``C``s, connect them. If there's
prime on one ``C``, connect it to the other ``C``. If there are
no primes, get midpoints on ``C``s and connect those.

Parameters
----------
primes : geopandas.GeoSeries
Nodes that are external to the artifacts, but need to be kept
conts_groups : geopandas.GeoDataFrame
All ``C`` labeled edges dissolved by connected component label.
highest_hierarchy : geopandas.GeoDataFrame
``edges`` in the ``C`` continuity group – ``edges[~es_mask]``.
relevant_targets : geopandas.GeoDataFrame
The nodes forming the artifact.
split_points : list
Points to be used for topological corrections.

Returns
-------
np.ndarray
New linestrings for reconnections.
"""

if primes.empty:
# midpoints solution
c0 = conts_groups.geometry.iloc[0]
Expand Down Expand Up @@ -222,10 +246,34 @@ def ccss_special_case(
return new_connections


def filter_connections(primes, relevant_targets, conts_groups, new_connections):
# The skeleton returns connections to all the nodes. We need to keep only
# some, if there are multiple connections to a single C. We don't touch
# the other.
def filter_connections(
primes: gpd.GeoSeries,
relevant_targets: gpd.GeoDataFrame,
conts_groups: gpd.GeoDataFrame,
new_connections: np.ndarray,
) -> tuple[np.ndarray]:
"""The skeleton returns connections to all the nodes. We need to keep only
some, if there are multiple connections to a single C. We don't touch the other.

Parameters
----------
primes : geopandas.GeoSeries
Nodes that are external to the artifacts, but need to be kept
relevant_targets : geopandas.GeoDataFrame
The nodes forming the artifact.
conts_groups : geopandas.GeoDataFrame
All ``C`` labeled edges dissolved by connected component label.
new_connections : numpy.ndarray
New linestrings for reconnections.

Returns
-------
tuple[np.ndarray]
- Updated ``new_connections``
- Connections intersecting ``C``
- Connections intersecting ``primes``
"""

unwanted = []
keeping = []
conn_c = []
Expand Down Expand Up @@ -262,19 +310,13 @@ def filter_connections(primes, relevant_targets, conts_groups, new_connections):
unwanted.append(connections_intersecting_c)

if len(unwanted) > 0:
wanted_mask = ~np.isin(new_connections, np.concatenate(unwanted))
if len(keeping) > 0:
new_connections = np.concatenate(
[
new_connections[
~np.isin(new_connections, np.concatenate(unwanted))
],
np.concatenate(keeping),
]
[new_connections[wanted_mask], np.concatenate(keeping)]
)
else:
new_connections = new_connections[
~np.isin(new_connections, np.concatenate(unwanted))
]
new_connections = new_connections[wanted_mask]
return (
new_connections,
np.concatenate(conn_c) if len(conn_c) > 0 else np.array([]),
Expand All @@ -298,7 +340,7 @@ def avoid_forks(
highest_hierarchy : geopandas.GeoDataFrame
``edges`` in the ``C`` continuity group – ``edges[~es_mask]``.
new_connections : numpy.ndarray
New linestring for reconnections.
New linestrings for reconnections.
relevant_targets : geopandas.GeoDataFrame
The nodes forming the artifact.
artifact : geopandas.GeoDataFrame
Expand Down Expand Up @@ -342,7 +384,7 @@ def reconnect(
conts_groups : geopandas.GeoDataFrame
All ``C`` labeled edges dissolved by connected component label.
new_connections : numpy.ndarray
New linestring for reconnections.
New linestrings for reconnections.
artifact : geopandas.GeoDataFrame
The polygonal representation of the artifact.
split_points : list
Expand Down Expand Up @@ -387,7 +429,7 @@ def remove_dangles(
Parameters
----------
new_connections : np.ndarray
New linestring for reconnections.
New linestrings for reconnections.
artifact : geopandas.GeoDataFrame
The polygonal representation of the artifact.
eps : float = 1e-4
Expand Down
Loading