Skip to content

Commit 7fc53cb

Browse files
committed
Improve replace_with_nodata docstring
1 parent d16d93f commit 7fc53cb

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

eis_toolkit/utilities/nodata.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,15 @@ def replace_with_nodata(
113113
"""
114114
Replace pixels values with nodata for a raster.
115115
116+
Can be used either for replacing all pixels with certain value with nodata, or for replacing all pixels with
117+
values less than, greater than, less than or equal to, or greater than or equal to the target value with nodata.
118+
116119
Args:
117120
input_raster: Input raster dataset.
118121
target_value: Value to be replaced with nodata.
119122
nodata_value: Value that will be used as nodata. If not provided, nodata is determined from input raster.
120-
replace_condition: Whether to replace certain value or values less than, greater than, less than or equal,
121-
or greater than or equal to target_value with nodata.
123+
replace_condition: Whether to replace pixels with certain value or values less than, greater than, less than or
124+
equal, or greater than or equal to target_value with nodata.
122125
123126
Returns:
124127
The input raster data with specified pixels replaced with nodata, and updated metadata.

0 commit comments

Comments
 (0)