encode two scalar properties in one RGB colour

Syntax

key = planarColorKey('twilight')
rgb = key.property2color(angleValues, magnitudeValues)
key.plot(angleValues, magnitudeValues)

Description

The first property selects a colour from the colour map. The second blends it from white or black to full colour, making it suitable for displaying an angle together with a magnitude. A finite periode wraps the first property cyclically. Otherwise its range is scaled linearly. Explicit ranges keep colours comparable between data sets; inferred ranges depend on the data.

Keywords

keyword	default	description
`colorMap`		matplotlib colour-map name, or an array of RGB rows
`satRange`		pair of blend factors at the low and high ends of the second property
`shading`		‘white’ to fade towards white, otherwise fade towards black
`periode`		period of the first property in radians, or NaN for nonperiodic data; angular values exceeding 2*pi are interpreted as degrees
`quantileCap`		quantile used for an inferred upper limit of the second property
`range1`		minimum and maximum of the first property; NaN entries are inferred
`range2`		minimum and maximum of the second property; NaN entries are inferred
`label1`		label for the first property
`label2`		label for the second property

Output

key planarColorKey

Members

plot	the colour key drawn as an image, hue along x and saturation along y
property2color	convert paired property values to RGB colours

Used on

GrainSpatialPlots

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

The class planarColorKey