get_dynamic_background#

EBSD.get_dynamic_background(filter_domain: str = 'frequency', std: int | float | None = None, truncate: int | float = 4.0, dtype_out: str | dtype | type | None = None, show_progressbar: bool | None = None, lazy_output: bool | None = None, **kwargs) → EBSD | LazyEBSD[source]#

Return the dynamic background per pattern in a new signal.

Parameters:
filter_domain

Whether to apply a Gaussian convolution filter in the "frequency" (default) or "spatial" domain.

std

Standard deviation of the Gaussian window. If not given, it is set to width/8.

truncate

Truncate the Gaussian filter at this many standard deviations. Default is 4.0.

dtype_out

Data type of the background patterns. If not given, it is set to the same data type as the input pattern.

show_progressbar

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

lazy_output

Whether the returned signal is lazy. If not given this follows from the current signal.

**kwargs

Keyword arguments passed to the Gaussian blurring function determined from filter_domain.

Returns:
s_out

Signal with the large scale variations across the detector. Whether it is lazy is determined from lazy_output.