an EBSD map: positions, rotations and phase ids with the list of the phases’ frames and the properties of every measurement; MATLAB’s EBSD

Syntax

ebsd = EBSD(pos, rot, phaseId, CSList)

The measurements as a list.

ebsd = EBSD(pos, rot, phaseId, CSList, {'mad': mad})

With properties.

ebsd = EBSD(pos, rot, phaseId, CSList, prop, unitCell=uC)

The shape of a pixel stated.

Description

A map is a table of measurements, a row per pixel, or, gridified, the same arrays in map shape, ebsd[i, j] the pixel of row i and column j. phaseId indexes CSList, 0 the not indexed phase. A position that is NaN is dropped, as MATLAB drops it. The lattice of the positions, square or hexagonal, is read off the positions, or off the unit cell when it is given; loadEBSD, mtexdata and the simulations build maps the same way.

Input

`pos`	vector3d, or an (n, 2) or (n, 3) array, the centres of the pixels
`rotations`	rotation, the rotation of every pixel
`phaseId`	int array, the phase of every pixel as the index into CSList
`CSList`	phaseList, or a list of crystalFrame with ‘notIndexed’ first
`prop`	dict, a property per pixel of the shape of the map, ebsd.prop[‘mad’] and ebsd.mad

Keywords

keyword	default	description
`unitCell`	`None`	vector3d or (k, 2) array, the corners of a pixel about its centre, from which the lattice is built
`scanUnit`	`'um'`	the unit of the positions
`frame`	`None`	specimenFrame of the positions, by default that of pos or the default one
`lattice`	`None`	the lattice of the positions, when it is known, instead of reading it off them
`meta`	`None`	dict, what a file states besides the measurements
`phaseMap`	`None`	the phase number the file gives each entry of CSList
`id`	`None`	the id of every pixel, by default its position in the list
`isPadding`	`None`	the mask of the cells a grid adds to close it, MATLAB’s NaN phase

Output

ebsd EBSD

Properties

`pos`	vector3d measurement positions in the specimen frame
`rotations`	rotation coefficients of the measured orientations
`phaseId`	zero-based index into CSList for each measurement; zero is notIndexed
`CSList`	phaseList containing the phase frames and mineral metadata
`orientations`	orientation data for a selection containing one indexed phase
`prop`	additional arrays such as band contrast or grainId, also accessible as attributes
`id`	measurement ids, distinct from positional array indices after selection
`lattice`	geometry and spacing of a regular scan, or None for scattered data
`shape`	measurement-array shape: a list or a spatially gridded array
`isPadding`	mask of grid cells without an original measurement
`scanUnit`	unit of the spatial coordinates
`grainId`	grain assignments, available after calcGrains has written them to the map

Used on

EBSDKAM

MATLAB’s EBSD.EBSD

source

Citing this page. This page is part of the documentation of MTEX, a free and open source MATLAB toolbox for analyzing and modeling crystallographic textures. It was written by The MTEX Developers and is published at https://mtex-toolbox.github.io/EBSD.EBSD_py.html. If you use MTEX, or reuse text or figures from this page, in your research, please cite

F. Bachmann, R. Hielscher, H. Schaeben: Texture Analysis with MTEX - Free and Open Source Software Toolbox, Solid State Phenomena 160 (2010), 63-68. 10.4028/www.scientific.net/SSP.160.63

BibTeX

@article{bachmann2010mtex,
  author  = {F. Bachmann and R. Hielscher and H. Schaeben},
  title   = {Texture Analysis with MTEX - Free and Open Source Software Toolbox},
  journal = {Solid State Phenomena},
  volume  = {160},
  pages   = {63-68},
  year    = {2010},
  doi     = {10.4028/www.scientific.net/SSP.160.63},
  url     = {https://doi.org/10.4028/www.scientific.net/SSP.160.63}
}

Other papers describing specific MTEX methods are listed under Publications — please cite the one that best fits your application. The MTEX source code is licensed under the GNU General Public License v2.0; the text and figures of this documentation are licensed under CC BY 4.0, which permits reuse — including by automated systems — provided The MTEX Developers and this page are credited.

EBSD.EBSD