Skip to content

Commit a937f41

Browse files
luseverinchahank
andauthored
Clarify meaning of highest resolution in docstrings
Co-authored-by: Chahan M. Kropf <[email protected]>
1 parent 4ad866f commit a937f41

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

climada/engine/impact_calc.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@ def impact(
9292
Default: True
9393
assign_centroids : bool, optional
9494
indicates whether centroids are assigned to the self.exposures object.
95-
The default centroids assignement uses euclidean distance and a threshold equal to
96-
twice the highest resolution of the centroids (assuming a regular grid).
95+
The default centroids assignment uses Euclidean distance and a threshold equal to
96+
twice the highest resolution (smallest distance between any two nearest neighbours)
97+
of the centroids (assuming a regular grid).
9798
Recommendation: assign the centroids directly with control
9899
over the distance metric and the distance threshold using
99100
`exposure.assign_centroids(hazard)`. In this case, set assign_centroids to ``False``.

0 commit comments

Comments
 (0)