get_images_from_grid#

VirtualBSEGenerator.get_images_from_grid(dtype_out: Union[str, dtype, type] = 'float32') VirtualBSEImage[source]#

Return an in-memory signal with a stack of virtual backscatter electron (BSE) images by integrating the intensities within regions of interest (ROI) defined by the generator grid_shape.

Parameters:
dtype_out

Output data type, default is "float32".

Returns:
vbse_images

In-memory signal with virtual BSE images.

Examples

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> s
<EBSD, title: patterns My awes0m4 ..., dimensions: (3, 3|60, 60)>
>>> vbse_gen = kp.generators.VirtualBSEGenerator(s)
>>> vbse_gen.grid_shape = (5, 5)
>>> vbse = vbse_gen.get_images_from_grid()
>>> vbse
<VirtualBSEImage, title: , dimensions: (5, 5|3, 3)>