Skip to content

Commit 5f59710

Browse files
authored
DOC: expand on meaning of segment keyword in tessellation (#720)
1 parent b2fb44b commit 5f59710

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

momepy/elements.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,14 @@ def morphological_tessellation(
7171
object that will be automatically unioned.
7272
shrink : float, optional
7373
The distance for negative buffer to generate space between adjacent polygons.
74+
Shall be changed in sync with ``segment``.
7475
By default 0.4
7576
segment : float, optional
76-
The maximum distance between points after discretization. By default 0.5
77+
The maximum distance between points after discretization. A right value is
78+
a sweet spot between computational inefficiency (when the value is too low)
79+
and suboptimal resulting geometry (when the value is too large). The default
80+
is empirically derived for the use case on building footprints represented in
81+
meters. By default 0.5
7782
simplify: bool, optional
7883
Whether to attempt to simplify the resulting tesselation boundaries with
7984
``shapely.coverage_simplify``. By default True.
@@ -189,10 +194,14 @@ def enclosed_tessellation(
189194
enclosures : GeoSeries | GeoDataFrame
190195
The enclosures geometry, which can be generated using :func:`momepy.enclosures`.
191196
shrink : float, optional
192-
The distance for negative buffer to generate space between adjacent polygons).
197+
The distance for negative buffer to generate space between adjacent polygons.
198+
Shall be changed in sync with ``segment``.
193199
By default 0.4
194200
segment : float, optional
195-
The maximum distance between points after discretization. By default 0.5
201+
The maximum distance between points after discretization. A right value is
202+
a sweet spot between computational inefficiency (when the value is too low)
203+
and suboptimal resulting geometry (when the value is too large). The default
204+
is empirically derived for the use case on
196205
threshold : float, optional
197206
The minimum threshold for a building to be considered within an enclosure.
198207
Threshold is a ratio of building area which needs to be within an enclosure to

0 commit comments

Comments
 (0)