get_virtual_dark_field_images#
- VirtualDarkFieldGenerator.get_virtual_dark_field_images(radius, normalize=False, out_signal_axes=None)[source]#
[Deprecated] Obtain the intensity scattered to each diffraction vector at each navigation position in an Diffraction2D Signal by summation in a circular window of specified radius.
- Parameters:
radius (float) – Radius of the integration window - in units of the reciprocal space.
normalize (boolean) – If True each VDF image is normalized so that the maximum intensity in each VDF is 1.
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:
vdfs – VirtualDarkFieldImage object containing virtual dark field images for all unique vectors.
- Return type:
Notes
Deprecated since version 0.17.0: Function get_virtual_dark_field_images() is deprecated and will be removed in version 1.0.0. Use pyxem.signals.DiffractionVectors2D.to_roi() instead.