ebsd_master_pattern#

kikuchipy.data.ebsd_master_pattern(phase: str, allow_download: bool = False, show_progressbar: bool | None = None, **kwargs) EBSDMasterPattern[source]#

EBSD master pattern of an available phase of (1001, 1001) pixel resolution in both the square Lambert or stereographic projection.

Master patterns were simulated with EMsoft [Callahan and De Graef, 2013].

Parameters:
phase

Name of available phase. Options are (see Notes for details): ni, al, si, austenite, ferrite, steel_chi, steel_sigma.

allow_download

Whether to allow downloading the dataset from the internet to the local cache with the pooch Python package. Default is False.

show_progressbar

Whether to show a progressbar when downloading. If not given, the value of hyperspy.api.preferences.General.show_progressbar is used.

**kwargs

Keyword arguments passed to load().

Returns:
ebsd_master_pattern_signal

EBSD master pattern signal.

Notes

The master patterns are downloaded in HDF5 files (carrying a CC BY 4.0 license) from Zenodo.

phase

Name

Symbol

Energy [keV]

File size [GB]

Zenodo DOI

ni

nickel

Ni

5-20

0.3

10.5281/zenodo.7628443

al

aluminium

Al

10-20

0.2

10.5281/zenodo.7628365

si

silicon

Si

5-20

0.3

10.5281/zenodo.7498729

austenite

austenite

\(\gamma\)-Fe

10-20

0.3

10.5281/zenodo.7628387

ferrite

ferrite

\(\alpha\)-Fe

5-20

0.3

10.5281/zenodo.7628394

steel_chi

chi

Fe36Cr15Mo7

10-20

0.6

10.5281/zenodo.7628417

steel_sigma

sigma

FeCr

5-20

1.5

10.5281/zenodo.7628443

Examples

Import master pattern in the stereographic projection

>>> import kikuchipy as kp
>>> s = kp.data.ebsd_master_pattern("ni", hemisphere="both")  
>>> s  
<EBSDMasterPattern, title: ni_mc_mp_20kv, dimensions: (16, 2|1001, 1001)>
>>> s.projection  
'stereographic'