EBSD#

class kikuchipy.signals.EBSD(*args, **kwargs)[source]#

Bases: KikuchipySignal2D

Scan of Electron Backscatter Diffraction (EBSD) patterns.

This class extends HyperSpy’s Signal2D class for EBSD patterns. See the docstring of Signal2D for the list of inherited attributes and methods.

Parameters:
*args

See Signal2D.

detectorEBSDDetector, optional

Detector describing the EBSD detector-sample geometry. If not given, this is a default detector (see EBSDDetector).

static_backgroundndarray or Array, optional

Static background pattern. If not given, this is None.

xmapCrystalMap

Crystal map containing the phases, unit cell rotations and auxiliary properties of the EBSD dataset. If not given, this is None.

**kwargs

See Signal2D.

See also

kikuchipy.data.nickel_ebsd_small

An EBSD signal with (3, 3) experimental nickel patterns.

kikuchipy.data.nickel_ebsd_large

An EBSD signal with (55, 75) experimental nickel patterns.

kikuchipy.data.silicon_ebsd_moving_screen_in

An EBSD signal with one experimental silicon pattern.

kikuchipy.data.silicon_ebsd_moving_screen_out5mm

An EBSD signal with one experimental silicon pattern.

kikuchipy.data.silicon_ebsd_moving_screen_out10mm

An EBSD signal with one experimental silicon pattern.

Examples

Load one of the example datasets and inspect some properties

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> s
<EBSD, title: patterns My awes0m4 ..., dimensions: (3, 3|60, 60)>
>>> s.detector
EBSDDetector (60, 60), px_size 1.0 um, binning 8, tilt 0.0, azimuthal 0.0, pc (0.5, 0.5, 0.5)
>>> s.static_background
array([[84, 87, 90, ..., 27, 29, 30],
       [87, 90, 93, ..., 27, 28, 30],
       [92, 94, 97, ..., 39, 28, 29],
       ...,
       [80, 82, 84, ..., 36, 30, 26],
       [79, 80, 82, ..., 28, 26, 26],
       [76, 78, 80, ..., 26, 26, 25]], dtype=uint8)
>>> s.xmap
Phase  Orientations  Name  Space group  Point group  Proper point group     Color
    0    9 (100.0%)  None         None         None                None  tab:blue
Properties:
Scan unit: px

Attributes

EBSD.detector

Return or set the detector describing the EBSD detector-sample geometry.

EBSD.static_background

Return or set the static background pattern.

EBSD.xmap

Return or set the crystal map containing the phases, unit cell rotations and auxiliary properties of the EBSD dataset.

Methods

EBSD.adaptive_histogram_equalization([...])

Enhance the local contrast in an EBSD scan inplace using adaptive histogram equalization.

EBSD.as_lazy(*args, **kwargs)

Create a copy of the given Signal as a LazySignal.

EBSD.average_neighbour_patterns([window, ...])

Average patterns inplace with its neighbours within a window.

EBSD.change_dtype(*args, **kwargs)

Change the data type of a Signal.

EBSD.deepcopy()

Return a "deep copy" of this Signal using the standard library's deepcopy() function.

EBSD.dictionary_indexing(dictionary[, ...])

Match each experimental pattern to a dictionary of simulated patterns of known orientations to index them [Chen et al., 2015, Jackson et al., 2019].

EBSD.fft_filter(transfer_function, ...[, ...])

Filter an EBSD scan inplace in the frequency domain.

EBSD.get_average_neighbour_dot_product_map([...])

Get a map of the average dot product between patterns and their neighbours within an averaging window.

EBSD.get_decomposition_model([components, ...])

Get the model signal generated with the selected number of principal components from a decomposition.

EBSD.get_dynamic_background([filter_domain, ...])

Get the dynamic background per EBSD pattern in a scan.

EBSD.get_image_quality([normalize, ...])

Compute the image quality map of patterns in an EBSD scan.

EBSD.get_neighbour_dot_product_matrices([...])

Get an array with dot products of a pattern and its neighbours within a window.

EBSD.get_virtual_bse_intensity(roi[, ...])

Get a virtual backscatter electron (VBSE) image formed from intensities within a region of interest (ROI) on the detector.

EBSD.normalize_intensity([num_std, ...])

Normalize image intensities in inplace to a mean of zero with a given standard deviation.

EBSD.plot_virtual_bse_intensity(roi[, ...])

Plot an interactive virtual backscatter electron (VBSE) image formed from intensities within a specified and adjustable region of interest (ROI) on the detector.

EBSD.refine_orientation(xmap, detector, ...)

Refine orientations by searching orientation space around the best indexed solution using fixed projection centers.

EBSD.refine_orientation_projection_center(...)

Refine orientations and projection centers simultaneously by searching the orientation and PC parameter space.

EBSD.refine_projection_center(xmap, ...[, ...])

Refine projection centers by searching the parameter space using fixed orientations.

EBSD.remove_dynamic_background([operation, ...])

Remove the dynamic background in an EBSD scan inplace.

EBSD.remove_static_background([operation, ...])

Remove the static background inplace.

EBSD.rescale_intensity([relative, in_range, ...])

Rescale image intensities inplace.

EBSD.save([filename, overwrite, extension])

Write the signal to file in the specified format.

EBSD.set_detector_calibration(delta)

Set detector pixel size in microns.

EBSD.set_scan_calibration([step_x, step_y])

Set the step size in microns.

Examples using EBSD#