get_integrated_intensity#

CommonDiffraction.get_integrated_intensity(roi, out_signal_axes=None)[source]#

Obtains the intensity integrated over the scattering range as defined by the roi.

Parameters:

roi (hyperspy.roi.BaseInteractiveROI) – Any interactive ROI detailed in HyperSpy.
out_signal_axes (None, iterable of int or string) – Specify which navigation axes to use as signal axes in the virtual image. If None, the two first navigation axis are used.

Returns:

integrated_intensity – The intensity integrated over the scattering range as defined by the roi.

Return type:

hyperspy.signals.Signal2D or hyperspy.signals.Signal1D

Examples

>>> # For 1D diffraction signal, we can use a SpanROI
>>> roi = hs.roi.SpanROI(left=1., right=2.)
>>> virtual_image = dp.get_integrated_intensity(roi)

>>> # For 2D diffraction signal,we can use a CircleROI
>>> roi = hs.roi.CircleROI(3, 3, 5)
>>> virtual_image = dp.get_integrated_intensity(roi)