Generating test data

With this module, test data can be generated. Test data can be used as a dummy dataset to test processing methods.

>>> import pixstem.make_diffraction_test_data as mdtd

Single image

Generating a default image

The default settings creates test data consisting of a bright-field disk and a concentric diffraction ring. No input parameters are needed to generate this object. The test data contains a PixelatedSTEM object, which can be be plotted.

>>> import pixstem.make_diffraction_test_data as mdtd
>>> import hyperspy.api as hs
>>> a = mdtd.MakeTestData(default=True)
>>> a.signal
<PixelatedSTEM, title: , dimensions: (|100, 100)>
>>> a.signal.axes_manager[0].scale
1.0
>>> a.signal.axes_manager[1].scale
1.0
>>> a.signal.plot()
_images/TestData_default.png

Generating a bright-field disk

To generate other datasets that the default set the argument default to false, and add rings and disk manually. The below example generates a test data image with 1000x1000 pixels, and scale 0.1. The centre point of the disk is (45,55), and radius 5.

>>> a = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1, default=False)
>>> a.signal
<PixelatedSTEM, title: , dimensions: (|1000, 1000)>
>>> a.signal.axes_manager[0].scale
0.1
>>> a.add_disk(x0=45, y0=55, r=5)
_images/TestData_disk.png

Generating a diffraction ring

A diffraction ring can be added to a MakeTestData object. In addition to centre point radius (and intensity, as show later), the line width of the ring can be set. The radius is defined as the distance from the centre to the centre point of the pixel at outer edge of the ring (i.e radius + half of the scale). The line width of the ring in pixels, before it is blurred and rescaled in order to create a more smooth ring.

>>> a = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1,
...         default=False, blur=False, downscale=False)
>>> a.add_ring(x0=50, y0=50, r=30, lw_pix=2)
_images/TestData_ring.png

Advanced diffraction images

Smoothing and intensity

Below are three examples with a diffraction ring and bright field disk with slightly offset centre points. To mimic realistic patterns, the intensity of the ring will be set lower than the intensity of the disk. Blurring and rescaling is used to get a smoother features, and is on by default.. The two first examples, are blurred and rescaled to make the features more smooth. The sigma for the Gaussian blurring is different for the two to. Rescaling is done by down and upscaling the image back to its original dimensions. Perform rescaling by setting downscale to True. The last image is without blurring and rescaling.

>>> a = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1, default=False,
...         blur_sigma=2)
>>> a.add_ring(x0=50, y0=50, r=20, lw_pix=2, intensity=2)
>>> a.add_disk(x0=50.05, y0=50.02, r=5, intensity=10)
_images/TestData_advanced_smooth_2.png
>>> b = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1, default=False,
...         blur_sigma=1)
>>> b.add_ring(x0=50, y0=50, r=20, lw_pix=2, intensity=2)
>>> b.add_disk(x0=50.05, y0=50.02, r=5, intensity=10)
_images/TestData_advanced_smooth.png
>>> c = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1, default=False,
...         blur=False, downscale=False)
>>> c.add_ring(x0=50, y0=50, r=20, lw_pix=2, intensity=2)
>>> c.add_disk(x0=50.05, y0=50.02, r=5, intensity=10)
_images/TestData_advanced_non_smooth.png

Image offset

The offset of the image can be set through accessing the axes_manager of the PixelatedSTEM object. This is useful for radial integration. By setting the offset of the axes_manager as below, the coordinates of the centre point of the disks and ring is changed x=0 and y=0.

>>> a = mdtd.MakeTestData(size_x=100, size_y=100, scale=0.1,
...         default=False, blur_sigma=2)
>>> a.add_ring(x0=50, y0=50, r=20, lw_pix=2, intensity=5)
>>> a.add_ring(x0=50, y0=50, r=30, lw_pix=2, intensity=2)
>>> a.add_ring(x0=50, y0=50, r=10, lw_pix=2, intensity=2)
>>> a.add_disk(x0=50, y0=50, r=5, intensity=10)
>>> a.signal.axes_manager[0].offset = -50
>>> a.signal.axes_manager[1].offset = -50
_images/TestData_offset.png

Generate 4D dataset

It is also possible to make 4 dimensional test datasets using generate_4d_data(). This function uses the MakeTestData class to generate the individual images, then this function stacks the images into a 4D stack.

>>> s = mdtd.generate_4d_data()
>>> s.plot()

The signal can be highly customized, a full argument list can be found in the API documentation about the function: generate_4d_data().

Some of the parameters can vary as a function of probe position, by sending the argument as a NumPy array. This NumPy array must have the size as the probe dimension.

>>> import numpy as np
>>> disk_x = np.random.randint(5, 35, size=(20, 10))
>>> disk_y = np.random.randint(5, 45, size=(20, 10))
>>> s = mdtd.generate_4d_data(probe_size_x=10, probe_size_y=20,
...         image_size_x=40, image_size_y=50, disk_x=disk_x, disk_y=disk_y)
>>> s.plot()

The ring can be deactivated by setting ring_x=None, and the disk by setting disk_x=None:

>>> s_no_disk = mdtd.generate_4d_data(disk_x=None)
>>> s_no_ring = mdtd.generate_4d_data(ring_x=None)

Dummy data

There are several predefined test signal in pixstem.dummy_data.

These are useful for testing the various data processing functions in this library.

>>> import pixstem.dummy_data as dd
>>> s = dd.get_disk_shift_simple_test_signal()
>>> s_com = s.center_of_mass(show_progressbar=False)
>>> s_com.plot()