Skip to content

Commit 998698a

Browse files
committed
add documentation for shoreline_extraction_area parameter to extract shorelines documentation
1 parent 1ae158c commit 998698a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/coastsat/SDS_shoreline.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -330,9 +330,10 @@ def extract_shorelines(
330330
if True, no pan-sharpening is performed on Landsat 7,8 and 9 imagery
331331
's2cloudless_prob': float [0,100)
332332
threshold to identify cloud pixels in the s2cloudless probability mask
333-
output_directory: str
333+
output_directory: str (default: None)
334334
The directory to save the output files. If None, the output files will be saved in the same directory as the input files.
335-
335+
shoreline_extraction_area: gpd.GeoDataFrame (default: None)
336+
A geodataframe containing polygons indicating the areas to extract the shoreline from. Any shoreline outside of these polygons will be discarded.
336337
337338
Returns:
338339
-----------

0 commit comments

Comments
 (0)