MTEX’s default direction key: white at the centre of the fundamental sector, the primary colours at its vertices

Syntax

HSVDirectionKey(cs)
HSVDirectionKey(cs, whiteCenter=v, maxAngle=5*degree)
HSVDirectionKey(cs, perceptual=True, hueLightness=0.5)

Description

A finite maxAngle makes the key sharp: the whole colour circle is spent on the cap of that opening about the white centre and everything outside it is black. perceptual=True takes the colours from a double cone in OKLab instead of MTEX’s HSL sphere: the colour changes at a nearly steady rate over the sector. hueLightness, from 0 to 1, lets the lightness of the boundary follow the hue towards where each hue is brightest: yellow comes back as yellow, and the key comes closer to MTEX’s and less even.

Input

CS referenceFrame, symmetry, or vector3d supplying its frame; default specimen frame
whiteCenter unit direction at the white centre; None uses the sector centre
maxAngle angular radius in radians of concentrated colouring; default infinity uses the whole sector
sR sphericalRegion to colour; None uses the conventional fundamental sector
colorStretching exponent controlling how the colour varies with polar distance; default 1
grayValue pair giving the gray contribution at the white and black centres
grayGradient pair controlling how rapidly gray fades away from those centres
antipodal colour opposite directions alike by using the Laue group; default False
perceptual use the OKLab colour construction; default False
hueLightness hue-dependent boundary lightness in the perceptual construction, from 0 to 1

Members

direction2color the colours of directions under the key

Used on

EBSDGROD, BoundaryPlots, GrainOrientationParameters, WBV

MATLAB’s HSVDirectionKey

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/HSVDirectionKey_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.