average_boundaries#

ripplemapper.contour.average_boundaries(self, contour_a=None, contour_b=None, iterations: int = 3, save_both: bool = True) ndarray[source]#

Average the two contours to get a more accurate representation of the interface.

Parameters:
  • contour_a (RippleContour, optional) – The first contour to average, by default self.contours[0].

  • contour_b (RippleContour, optional) – The second contour to average, by default self.contours[1].

  • iterations (int, optional) – The number of iterations to average the contours over, by default 3.

  • save_both (bool, optional) – Whether to save both averaged contours, by default True.

Returns:

The averaged contour.

Return type:

np.ndarray