add_boundary_contours

ripplemapper.analyse.add_boundary_contours(ripple_images: list[RippleImage] | RippleImage | RippleImageSeries, overwrite: bool = False, level=None, **kwargs) → list[RippleImage]

Add boundary contours to a list of RippleImage objects.

Parameters:

• ripple_images (list[RippleImage] | RippleImage | RippleImageSeries) – A list of RippleImage objects or a single RippleImage or RippleImageSeries.

• overwrite (bool, optional) – Whether to overwrite existing boundary contours, by default False.

• level (optional) – Contour level parameter for the find_contours function, by default None.

• **kwargs – Additional keyword arguments for the find_contours function.

Returns:

The list of RippleImage objects with added boundary contours.

Return type:

list[RippleImage]