base class for assigning colours to directions with crystal symmetry

Syntax

rgb = key.direction2color(h)
key.plot()

Description

A concrete direction key maps symmetry-equivalent directions to the same colour. Colouring returns an array of shape h.shape + (3,) with RGB channels in [0, 1]. Plot the key alongside a direction or orientation map to show what its colours mean. Use HSVDirectionKey, TSLDirectionKey, HKLDirectionKey or spotDirectionKey to choose the colouring rule.

Input

CS referenceFrame or symmetry group defining equivalent directions

Properties

CS frame or symmetry supplied to the key
sym symmetry group used when folding directions
sR fundamental spherical sector used for colouring

See also

HSVDirectionKey, TSLDirectionKey, HKLDirectionKey, ipfColorKey

Members

direction2color the colours of directions, an (…, 3) array in [0, 1]
keySector a sector the key is drawn over
plot the key drawn on its sector, or with complete=True over the whole sphere

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