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 |
vector3d or (k, 2) array, the corners of a pixel about its centre, from which the lattice is built | |
scanUnit |
the unit of the positions | |
frame |
specimenFrame of the positions, by default that of pos or the default one | |
lattice |
the lattice of the positions, when it is known, instead of reading it off them | |
meta |
dict, what a file states besides the measurements | |
phaseMap |
the phase number the file gives each entry of CSList | |
id |
the id of every pixel, by default its position in the list | |
isPadding |
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 |
See also
loadEBSD, EBSDsquare, gridify, simulateEBSD, EBSDImport, EBSDSelect, EBSDPlotting, GrainReconstruction
Members
| calcGND | the geometrically necessary dislocation content of every pixel after Pantleon (2008) |
| calcGrains | the grains of a map, the pixels joined across every boundary the criterion keeps |
| calcGROD | the grain reference orientation deviation, mis2mean: the misorientation of every pixel from the mean orientation of its grain, or from a given reference |
| calcKernel | the kernel a density estimate of orientations or directions should use, a de la Vallee Poussin kernel of the halfwidth chosen from the sample |
| calcMisorientation | uncorrelated misorientations: those of random pairs of measurements far enough apart that they say nothing about one another |
| calcTensor | the texture average of a single crystal tensor over an ODF, a list of orientations or a map |
| calcTraces | the traces of subregions of a map or of sets of grains, the direction their lamellae run along |
| cat | the list of several maps, the phases of the first, MATLAB’s [ebsd1, ebsd2] |
| color | the colour of the one phase of the map, read and set on its frame: ebsd[‘Diopside’].color |
| colorList | the colours of the phases, in the order of CSList |
| copy | a copy of the map with its own arrays |
| CS | the crystal frame of the one indexed phase present |
| cube2hex | the row and column (counted from 0) of the cells with cube coordinates x, y, z, NaN for a cell outside the grid |
| curvature | the curvature tensor of every pixel, kappa = d omega / d x, in the specimen frame per scan unit |
| dPos | MATLAB’s spacing of the positions: the shortest distance from the first corner of the unit cell to the others, the step on a square lattice and the step over sqrt(3) on a hexagonal one, where lattice.dxy is the step |
| dtype | the floating point type of the rotations, single or double precision |
| EBSD | an EBSD map: positions, rotations and phase ids with the list of the phases’ frames and the properties of every measurement |
| EBSDgrid | an EBSD map: positions, rotations and phase ids with the list of the phases’ frames and the properties of every measurement |
| EBSDhex | an EBSD map: positions, rotations and phase ids with the list of the phases’ frames and the properties of every measurement |
| EBSDsquare | an EBSD map: positions, rotations and phase ids with the list of the phases’ frames and the properties of every measurement |
| EulerCorrection | the frame change the import applied to the Euler angles, the identity when none |
| export | write the EBSD map to a vendor format or a text table |
| extent | the bounds of the measured positions, [xmin, xmax, ymin, ymax] |
| fill | the map with every pixel that carries no measurement filled, the measured ones left as they are |
| fillByGrainId | the map with every pixel of a grain given the mean orientation of that grain, which is the map the grains describe rather than the one they were built from |
| findByLocation | the measurements closest to positions, or within a radius of them |
| findByOrientation | select measurements close to a reference orientation or an orientation fibre |
| flatten | the map as a list, one dimensional arrays in the order of the grid |
| frame | the specimen frame of the positions |
| gradient | the derivative of the orientation along the two axes of the plane of the map, per unit length, as a pair of framed vectors |
| gradientX | the derivative of the orientation along the specimen x axis per unit length, gradient(ebsd, xvector) |
| gradientY | the derivative of the orientation along the specimen y axis per unit length, gradient(ebsd, yvector) |
| gradientZ | the derivative of the orientation along the specimen z axis per unit length, gradient(ebsd, zvector) |
| grainMean | the average of a property over each grain |
| gridify | the same map with its arrays in map shape, the missing cells padding |
| hex2cube | the cube coordinates x, y, z of cells of a hexagonal grid, given by their row and column (counted from 0) or by their flat index |
| how2plot | the plotting convention of the specimen frame the map is written in |
| indexedPhaseId | the indexed phases at least one measurement belongs to |
| inpolygon | the mask of the measurements inside a rectangle [x, y, w, h] or a polygon (N, 2), edges included |
| interp | the map read at positions of one’s own choosing, a new map with these positions |
| isempty | whether the map holds no measurement |
| isGridded | whether the arrays are in map shape, two dimensional |
| isIndexed | whether a measurement belongs to an indexed phase |
| isPadding | the cells of a grid that hold no measurement |
| KAM | the kernel average misorientation: the mean misorientation angle of every pixel to its neighbours |
| latticeBasis | the basis, the stencil and the spacing a cell polygon of four or six corners describes |
| layout | the directions the indices of a gridded map run along (MATLAB ebsd.layout) |
| load | read an EBSD map from a supported vendor file or a text table |
| mineralList | the mineral names of the phases, in the order of CSList |
| N | the normal of the measurement plane |
| name2id | the phase id of a mineral name, MATLAB’s name2id |
| ndim | the number of array axes, 1 for a list and 2 for a grid |
| orientations | the orientations of the one indexed phase present, framed by it and by the specimen |
| phase | the phase numbers of the file, the phase ids translated through phaseMap |
| plot | a spatial EBSD map, coloured by phase, by a value, by orientation or by colours given |
| project2FundamentalRegion | the map with every orientation replaced by its representative in the fundamental region of its phase (MATLAB’s EBSD.project2FundamentalRegion) |
| quiver | arrows: tangent vectors at directions, a vector or axis field on the sphere, arrows at orientations in the sections of the current figure, or directions on a map or a volume |
| reduce | every n-th measurement along each lattice direction, which is the map at a coarser step |
| rotate | a rigid motion of the map |
| rotate | a rigid motion of the map |
| shape | the shape of the map, (n,) for a list and (rows, columns) for a grid |
| shift | the map with every position moved by the vector v, the arrays not reordered |
| size | the number of measurements, the padding of a grid included |
| smooth | the map with its orientations denoised, every one replaced by one computed from its neighbours, within the grains where the map knows them and within the phases otherwise |
| spatialProfile | the measurements along a polyline, in the order they are met, and the distance along the line of each of them |
| spatialProfile | the measurements along a polyline, in the order they are met, and the distance along the line of each of them |
| subsref | |
| text | text at directions on the sphere, at the measurements or grains of a map, or at a point of the current axes |
| transform | any map of the positions |
| unitCell | the cell of the lattice about a site, as its corners |
| weightedBurgersVec | the weighted Burgers vector: the net Burgers vector of the dislocations crossing the map per unit area, by the integral or the gradient method |
| x | the x coordinates of the positions |
| xyz | the positions as one array of shape shape + (3,) |
| y | the y coordinates of the positions |
| z | the z coordinates of the positions |
Used on
MATLAB’s EBSD_index
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_index_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.