A method of crystalShape.
a crystal shape drawn as the polygons of its faces, in a 3D axes or onto a held map
Syntax
plot(cS)
The shape in a 3D axes.
plot(cS, faceColor='red', faceAlpha=0.5, edgeColor='k')
One colour, translucent.
plot(cS, faceColor=cS.faceArea)
A value per face through the colour map.
plot(cS, colored=True)
A colour per form, with a legend.
plot(cS, colored=ipfHSVKey(cS.CS))
The colours of a key of the normals.
plot(x, y, cS)
At positions, plot(x, y, z, cS) or plot(xy, cS).
plot(cS, Miller(1, 1, 0, cS.CS, 'hkl'))
The section by a lattice plane.
plot(cS, sS)
A slip system inside the shape.
Description
A list of shapes, ori * cS for instance, is drawn at once; with positions every shape is moved there first. Drawn while a map is held, the shapes are seen along the normal of the map at their positions in its plane, as plot(grains, cS) puts them.
By default the faces take the colour of the mineral, or LightSkyBlue. A lattice plane after the shape hands over to plotInnerFace, a slip system to plotSlipSystem. The keywords of the axes, parent and the like, are taken as by every plot; MATLAB’s legendSpacing is not provided.
Input
cS |
crystalShape, one or a list |
x, y, z |
the positions of the shapes, or xy an (n, 2) or (n, 3) array of them |
Keywords
| keyword | default | description |
|---|---|---|
faceColor |
None |
one colour, one per face, one per shape, or a value per face mapped through the colour map |
faceAlpha |
None |
the opacity of the faces |
edgeColor |
'k' |
the colour of the edges |
lineWidth |
0.8 |
the width of the edges |
colored |
None |
True gives every form its own colour with a legend; a direction or ipf key colours the faces by their normals |
colormap |
'viridis' |
the colour map of the values per face |
displayName |
None |
the label of the shape in a legend |
Output
h |
the matplotlib collection of the faces |
See also
crystalShape, crystalShape.plotInnerFace, crystalShape.plotInnerDirection, crystalShape.plotSlipSystem, faceColors, CrystalShapes
MATLAB’s crystalShape.plot
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/crystalShape.plot_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.