data#

Example datasets for use when testing functionality.

Some datasets are packaged with the source code while others must be downloaded from the web. For more test datasets, see Open datasets.

Datasets are placed in a local cache, in the location returned from pooch.os_cache(“pyxem”) by default. the location can be overwritten with a global PYXEM_DATA_DIR environment variable.

With every new version of pyxem, a new directory of datasets with the version name is added to the cache directory. Any old directories are not deleted automatically, and should then be deleted manually if desired.

Functions

au_grating([allow_download])

An au_grating 4-D STEM dataset used to show calibration.

pdnip_glass([allow_download])

A small PdNiP glass 4-D STEM dataset.

zrnb_precipitate([allow_download])

A small 4-D STEM dataset of a ZrNb precipitate for strain mapping.

twinned_nanowire([allow_download])

A small 4-D STEM dataset of a twinned nanowire for orientation mapping.

sample_with_g([allow_download])

A small 4-D STEM dataset for orientation mapping with mulitple overlapping grains.

mgo_nanocrystals([allow_download])

A small 4-D STEM dataset of overlapping MgO nanocrystals

tilt_boundary_data([correct_pivot_point])

si_phase()

Create a silicon phase with space group 227.

si_tilt()

si_grains([num_grains, seed, size, ...])

Generate a simulated dataset with grains in random orientations

si_grains_simple([seed, size, recip_pixels, ...])

Generate a simulated dataset with low-index zone axes

si_rotations_line()

simulated_stripes([beam_shifts])

Create a simulated diffraction pattern with stripes for showing magnetic DPC.

fe_multi_phase_grains([num_grains, seed, ...])

fe_fcc_phase()

Create a fe fcc phase with space group 225.

fe_bcc_phase()

Create a fe bcc phase with space group 229.

cuag_orientations([allow_download])

A small 4-D STEM dataset of CuAg with multiple orientations of the Cu FCC phase

organic_semiconductor([allow_download])

A small 4-D STEM dataset of an organic semiconductor for orientation mapping.

feal_stripes([allow_download])

A small 4-D STEM dataset for doing DPC on a set of magnetic FeAl stripes

sped_ag([allow_download])

A small 4-D STEM dataset of a Ag sample which is good for demonstrating the ML capabilities of pyxem.

pdcusi_insitu([allow_download])

A decently sized 5D STEM dataset of a PdCuSi alloy held at 390C.

simulated_constant_shift_magnitude([beam_radius])

Create a simulated diffraction pattern with a direct beam that is shifted by a constant magnitude across the entire pattern.

au_grating_20cm([allow_download])

A PACBED image of Gold grating with 20cm camera length for demonstrating the calibration of the camera length.

small_ptychography([allow_download])

A small 4-D STEM dataset of a bilayer WS2.

au_phase([allow_download])

A gold phase object for use in orix.

simulated_overlap([real_space_pixels, ...])

Create a simulated diffraction pattern with overlapping nanocrystals.

simulated_strain([navigation_shape, ...])

Create a simulated strain map from a simulated diffraction pattern and a strain matrix.

simulated_pn_junction([beam_shifts])

Create a simulated p-n junction diffraction pattern with alternating stripes.