add_circle_to_mask#

diffsims.utils.mask_utils.add_circle_to_mask(mask, x, y, r, fill=False)[source]#

Add a single circle to the mask

Parameters:
mask: (H, W) array of dtype bool

boolean mask for an image

x: float

x-coordinate of the circle center in pixels

y: float

y-coordinate of the circle center in pixels

r: float

radius of the circles in pixels

fill: int, optional

Fill value. 0 is black (negative, False) and 1 is white (True)

Returns:
None:

the mask is adjusted inplace