A method of planarColorKey.

the colour key drawn as an image, hue along x and saturation along y; MATLAB’s planarColorKey.plot

Syntax

pK.plot()

The key alone, no labels.

h = pK.plot(v1, v2)

With the ranges and the labels of the data.

pK.plot(v1, v2, nHue=128)

A coarser image.

Description

Without data only the colours are drawn. With the two properties v1 and v2 the x axis spans the range of v1 (pK.range1, else that of the data) and the y axis that of v2 (pK.range2, else from the minimum to the quantile pK.quantileCap), labelled pK.label1 and pK.label2; a periodic first property (pK.periode) is labelled in fractions of pi, or in degrees when its values exceed 2 pi.

Input

pK planarColorKey
v1 the first property, mapped to the hue
v2 the second property, mapped to the saturation

Keywords

keyword default description
nHue 256 the number of pixels of the image along the hue, MATLAB 512
nSat 128 the number of pixels of the image along the saturation

Output

h the matplotlib image

See also

planarColorKey.property2color, ipfColorKey

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