add_a_star_contours

ripplemapper.analyse.add_a_star_contours(ripple_images: list[RippleImage] | RippleImage | RippleImageSeries, contour_index: list[int] = [0, 1], overwrite: bool = False) → list[RippleImage]

Add A* 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.

• contour_index (list[int], optional) – List of two integers indicating which contours to use, by default [0, 1].

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

Returns:

The list of RippleImage objects with added A* contours.

Return type:

list[RippleImage]

Raises:

ValueError – If contour_index does not have exactly two integers.