the measurements of a volume: positions, rotations and phase ids of voxels with the list of the phases’ frames and the properties of every measurement
Syntax
ebsd = EBSD3(pos, rot, phaseId, CSList)
The voxels as a list.
ebsd = EBSD3(pos, rot, phaseId, CSList, prop={'ci': ci})
With properties.
ebsd = EBSD3(pos, rot, phaseId, CSList, D=D)
The steps of the voxel lattice stated.
ebsd = EBSD3square(rot, phaseId, CSList, dxyz=(dx, dy, dz))
An (n1, n2, n3) array of voxels.
Description
A volume is the three dimensional EBSD: a list of voxels, or arrays of shape (n1, n2, n3) with ebsd[i, j, k] one voxel, where orientation gradients are available along all three axes. phaseId indexes CSList, 0 being the not indexed phase. EBSD3.load reads the volumes of DREAM.3D and Neper.
The voxel lattice, the origin and the three steps d1, d2, d3, is inferred from the positions unless it is given: the steps are the shortest independent differences between neighbours, or the rows of D. Positions on no lattice leave ebsd.lattice None.
Input
pos |
vector3d, or an (…, 3) array, the centres of the voxels |
rotations |
rotation, the rotation of every voxel |
phaseId |
int array, the phase of every voxel as the index into CSList |
CSList |
phaseList, or a list of crystalFrame with ‘notIndexed’ first |
prop |
dict, a property per voxel of the shape of the volume |
Keywords
| keyword | default | description |
|---|---|---|
scanUnit |
the unit of the positions | |
frame |
specimenFrame of the positions, by default that of pos or the default one | |
lattice |
voxelLattice of the positions, when it is known, instead of inferring it | |
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 voxel, by default its position in the list | |
isPadding |
the mask of the cells a grid adds to close it | |
D |
3 x 3 array, the steps of the voxel lattice as rows, instead of inferring them |
Output
ebsd |
EBSD3 |
Properties
pos |
vector3d voxel-centre positions |
rotations |
measured rotation at each voxel |
phaseId |
phase-list index at each voxel, zero for notIndexed |
CSList |
phase metadata and crystal frames |
shape |
voxel-array shape or shape of a scattered selection |
lattice |
voxel grid geometry and spacing |
isPadding |
mask of unmeasured cells introduced by gridding |
scanUnit |
unit of spatial positions |
See also
EBSD3square, EBSD, voxelLattice, calcGrains, grain3d, EBSD3Analysis
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 |
| calcGrains | the grains of a map, the pixels joined across every boundary the criterion keeps |
| 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] |
| copy | a copy of the volume with its own arrays, the frames shared |
| curvature | the curvature tensor of every voxel |
| d1 | the first step vector of the voxel lattice |
| d2 | the second step vector of the voxel lattice |
| d3 | the third step vector of the voxel lattice |
| dPos | the shortest step of the voxel lattice, NaN without a lattice |
| dx | the length of the first step of the voxel lattice |
| dy | the length of the second step of the voxel lattice |
| dz | the length of the third step of the voxel lattice |
| EBSD3 | the measurements of a volume: positions, rotations and phase ids of voxels with the list of the phases’ frames and the properties of every measurement |
| EBSD3square | the measurements of a volume: positions, rotations and phase ids of voxels with the list of the phases’ frames and the properties of every measurement |
| extent | the bounding box of the voxels, [xmin, xmax, ymin, ymax, zmin, zmax], the padding left out |
| fill | the empty voxels of a volume filled from their nearest measured voxel |
| 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 |
| flatten | the voxels as a list, the volume itself when it is one |
| gradientDim | the derivative of the orientation along the array axis dim of a gridded volume per unit length, the forward difference, backwards at the last voxel, NaN across a grain boundary |
| gradientX | the derivative of the orientation along the first axis of the volume per unit length |
| gradientY | the derivative of the orientation along the second axis of the volume per unit length |
| gradientZ | the derivative of the orientation along the third axis of the volume per unit length |
| gridify | a list of voxels put back onto the (n1, n2, n3) array of its lattice |
| interp | the voxel holding every position, or none outside the box of voxel centres, as MATLAB’s nearest griddedInterpolant without extrapolation |
| interp | the voxel holding every position, or none outside the box of voxel centres, as MATLAB’s nearest griddedInterpolant without extrapolation |
| isGridded | whether the voxels are held as an (n1, n2, n3) array |
| KAM | the kernel average misorientation of a volume: the mean misorientation angle of every voxel to its neighbours |
| load | EBSD3.load(‘volume.dream3d’), EBSD3.load([‘s0.ang’, ‘s1.ang’], z=[0, 1]) |
| N | a volume has no measurement plane |
| plot | the voxels of a volume in three orthogonal slice planes, coloured by phase, by a value, a colour or an orientation per voxel |
| reduce | every n-th measurement along each lattice direction, which is the map at a coarser step |
| slice | the 2D map of the section of a volume through a plane |
| 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 voxels along a polyline, sampled at the voxel spacing, and their distance along it |
| spatialProfile | the voxels along a polyline, sampled at the voxel spacing, and their distance along it |
| 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 |
MATLAB’s EBSD3_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/EBSD3_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.