Image.contains

Image.contains(p: ndarray[tuple[int, int], dtype]) → bool | ndarray

Test if coordinate lies within image

Parameters:

p (array_like(2), ndarray(2,N)) – pixel coordinate

Returns:

whether pixel coordinate lies within image bounds

Return type:

bool, ndarray(N)

Example:

>>> from machinevisiontoolbox import Image
>>> import numpy as np
>>> img = Image.Zeros(size=10)
>>> img.contains((4,6))
np.True_
>>> img.contains((-1, 7))
np.False_
>>> img.contains(np.array([[4, 6], [-1, 7], [10, 10]]).T)
array([ True, False, False])