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`	`'um'`	the unit of the positions
`frame`	`None`	specimenFrame of the positions, by default that of pos or the default one
`lattice`	`None`	voxelLattice of the positions, when it is known, instead of inferring it
`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 voxel, by default its position in the list
`isPadding`	`None`	the mask of the cells a grid adds to close it
`D`	`None`	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

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/EBSD3square.EBSD3square_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.

EBSD3square.EBSD3square