deltametrics.plan.compute_shoreline_roughness¶
- deltametrics.plan.compute_shoreline_roughness(shore_mask, land_mask, **kwargs)¶
Compute shoreline roughness.
Computes the shoreline roughness metric:
\[L_{shore} / \sqrt{A_{land}}\]given binary masks of the shoreline and land area. The length of the shoreline is computed internally with
compute_shoreline_length
.- Parameters:
shore_mask (
ShorelineMask
,ndarray
) – Shoreline mask. Can be aShorelineMask
object, or a binarized array.land_mask (
LandMask
,ndarray
) – Land mask. Can be aLandMask
object, or a binarized array.**kwargs – Keyword argument are passed to
compute_shoreline_length
internally.
- Returns:
roughness – Shoreline roughness, computed as described above.
- Return type:
float
Examples
Compare the roughness of the shoreline early in the model simulation with the roughness later. Here, we use the elevation_offset parameter (passed to
ElevationMask
) to better capture the topography of the pyDeltaRCM model results.