the grains of a volume as closed polyhedra, given by the incidence I_GF of grains and the faces of a grain3Boundary: what calcGrains returns for a volume, the counterpart of grain2d

Syntax

grains = calcGrains(ebsd3)
grain3d.fromFaces(V, F, I_GF, ori, CSList, phaseId)
grain3d.load('grains.dream3d')

Input

id persistent grain ids
phaseId phase-list index of every grain
CSList phaseList or list of crystal frames
numPixel voxel count of every grain
meanRotation rotation representing each grain mean
GOS grain orientation spread in radians
I_GF sparse signed grain-by-face incidence matrix
boundary grain3Boundary mesh shared by the grains
frame specimen reference frame
prop optional dictionary of per-grain properties
phaseMap optional mapping from phase-list entries to original file phase numbers

Properties

id grain ids, which need not equal positions in a selected list
phaseId phase-list index of each grain
numPixel number of voxels assigned to each grain
meanOrientation mean orientations for grains of one phase
GOS grain orientation spread in radians
boundary grain3Boundary mesh separating the grains
I_GF sparse signed incidence matrix, grain rows by boundary-face columns
volume enclosed volume of each grain in cubed spatial units
surfaceArea surface area of each grain in squared spatial units
frame specimenFrame of the geometry

Members

allV all vertices of the boundary, as vectors
cat cat(a, b, …) is type(a).cat(a, b, …): the list of the operands, MATLAB’s [a, b], the carried attributes joined
centroid the centroid of every grain, the centre of mass of the polyhedron
color the colour of the phase of every grain, n x 3, as MATLAB’s grains.color
CS the crystal frame of grains of one indexed phase
diameter the diameter of every grain, the largest distance between two of its vertices
extent the box of the vertices, [xmin, xmax, ymin, ymax, zmin, zmax]
F the faces of the boundary, an (m, 3) array of triangles or a list of polygons
fromFaces the grains of vertices, faces and the incidence of grains and faces
grain3d the grains of a volume as closed polyhedra, given by the incidence I_GF of grains and the faces of a grain3Boundary: what calcGrains returns for a volume, the counterpart of grain2d
histogram histogram(grains), histogram(grains, prop, bins): the area weighted distribution of a grain property as one histogram per indexed phase, drawn over each other, or with grouped=True side by side (MATLAB’s hist)
id2ind the position of grain ids
indexedPhaseId the ids of the indexed phases among the grains
intersected whether a plane runs through a grain
isIndexed whether the phase of every grain is indexed
load grain3d.load(‘grains.dream3d’), grain3d.load(‘grains.tess’, CS=cs)
meanOrientation the mean orientations of the grains, which must be of one phase
midPoint the largest distance between two vertices of every grain, on MATLAB’s rounding to 1e-4 the centre of the box of the vertices, as MATLAB’s midPoint
mineralList the names of the phases of the phase list
neighbors the ids of neighbouring grains
numFaces the number of faces of every grain
numNeighbors the number of neighbouring grains of every grain
orientFaces the faces turned consistently around every grain, the normals out of it, as MATLAB’s orientFaces
plot the 3D grains drawn by their faces, coloured by phase, by a value or an orientation per grain, or in one colour
principalComponents the half axes of the ellipsoid of the same second moments and volume, the longest first
quiver arrows at the centroids of 3D grains or of their boundary faces
reduceBoundary the grains with their triangulated boundary coarsened, the vertices within cells of n edges merged
refineBoundary the grains with their triangulated boundary refined, every triangle split into four at the midpoints of its edges, n times
rotate the grains turned about a centre, their faces and their orientations
size the number of grains
slice the 2D grains a plane cuts from 3D grains
smoothBoundary the grains with their boundary surfaces smoothed, hierarchically: the triple lines along themselves first, then the faces
subsref  
surface MATLAB’s name for the surface area
surfaceArea the surface area of every grain, the sum of the areas of its faces
triangulate the faces of polygonal grains as triangles, the fan from the first corner of every face
V the vertices the faces of the boundary use
volume the volume of every grain, by the divergence theorem over its oriented faces

MATLAB’s grain3d_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/grain3d_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.