ni_gain#

kikuchipy.data.ni_gain(number: int = 1, allow_download: bool = False, show_progressbar: bool | None = None, **kwargs) → EBSD[source]#

EBSD dataset of (149, 200) patterns of (60, 60) pixels from polycrystalline recrystallized Ni, acquired on a NORDIF UF-1100 detector [Ånes et al., 2019].

Ten datasets are available from the same region of interest, acquired with increasing gain on the detector, from no gain to maximum gain.

Parameters:

number: Dataset number 1-10. The camera gains in dB are 0, 3, 6, 9, 12, 15, 17, 20, 22 and 24. Default is dataset number 1, acquired without detector gain.
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_signal: EBSD signal.

See also

ni_gain_calibration, nickel_ebsd_small, nickel_ebsd_large

Notes

The datasets are hosted in the Zenodo repository https://doi.org/10.5281/zenodo.7497682 and comprise about 100 MB each as zipped files and about 116 MB when unzipped. Each zipped file is deleted after it is unzipped.

The datasets carry a CC BY 4.0 license.

Examples

>>> import kikuchipy as kp
>>> s = kp.data.ni_gain(allow_download=True, lazy=True)  
>>> s  
<LazyEBSD, title: Pattern, dimensions: (200, 149|60, 60)>