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].

Note

Requires the optional pooch package to be installed.

Parameters:

phase: Name of available phase. Options are listed in the phase column in the table in Notes.
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.

See also

nickel_ebsd_master_pattern_small, ebsd_master_pattern

Notes

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

phase	Name	Symbol	Energy [keV]	File size [GB]	Zenodo DOI
ni	Nickel	Ni	5-20	0.3	10.5281/zenodo.7498644
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	Fe36Cr12Mo10	10-20	0.6	10.5281/zenodo.7628417
steel_sigma	Sigma	Fe-Cr-Mo	5-20	1.5	10.5281/zenodo.7628443
steel_sigma2	Sigma2	Fe-Cr-Mo	10-20	0.8	10.5281/zenodo.20376902
steel_r	R	Fe-Cr-Mo	10-20	3.0	10.5281/zenodo.20376827
steel_pi	Pi	Fe-Mo	10-20	0.5	10.5281/zenodo.20376759
steel_cr2n	Cr2N	Cr2N	10-20	0.5	10.5281/zenodo.20376533
al6mn	Al6Mn	Al6Mn	10-20	0.5	10.5281/zenodo.20376067
alpha_almnsi	Alpha-AlMnSi	\(\alpha\)-AlMnSi	10-20	1.1	10.5281/zenodo.20376378

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'