pysdic.Image.image

property Image.image: ndarray | None

[Get or Set] The image data.

The shape of the image must be (height, width) or (height, width, channels).

Note

The image will be automatically converted to a floating point format numpy.float64 for interpolation but it stores as unsigned integer internally to save memory. Only a view of the image data is returned when getting the image, so modifying the returned array will modify the internal image data. If you want to get a copy of the image data, you can use the to_array() method with copy=True.

Warning

If you update image coefficients without setting a new image, you must call image_update() to inform the view that the image has been updated are update the interpolation functions accordingly.

Parameters:

image (Optional[ArrayLike]) – The image data. The image have a shape of (height, width) or (height, width, channels). If not provided, the image will be set to None.

Returns:

The image data as a numpy array, or None if no image is set.

Return type:

Optional[numpy.ndarray]