get_virtual_bse_intensity#

EBSD.get_virtual_bse_intensity(roi: BaseInteractiveROI, out_signal_axes: Optional[Union[Iterable[int], Iterable[str]]] = None) VirtualBSEImage[source]#

Get a virtual backscatter electron (VBSE) image formed from intensities within a region of interest (ROI) on the detector.

Adapted from pyxem.signals.common_diffraction.CommonDiffraction.get_integrated_intensity().

Parameters:
roi

Any interactive ROI detailed in HyperSpy.

out_signal_axes

Which navigation axes to use as signal axes in the virtual image. If not given, the first two navigation axes are used.

Returns:
virtual_image

VBSE image formed from detector intensities within an ROI on the detector.

Examples

>>> import hyperspy.api as hs
>>> import kikuchipy as kp
>>> rect_roi = hs.roi.RectangularROI(
...     left=0, right=5, top=0, bottom=5
... )
>>> s = kp.data.nickel_ebsd_small()
>>> vbse_image = s.get_virtual_bse_intensity(rect_roi)