the value or the colour of every measurement or grain, and whether it is a value a colour map turns into colours: what a map plot draws, before it is drawn

Syntax

rgb, scalar = mapValues(ebsd, 'phase')

Phase colours.

v, scalar = mapValues(ebsd, 'mad')

A property, scalar is True.

rgb, scalar = mapValues(ebsd, None, ipfDirection=xvector) # inverse pole figure colours along x
rgb, scalar = mapValues(ebsd['Forsterite'], key)

Through an orientation colour key.

rgb, scalar = mapValues(ebsd, 'mad', at=ind)

The measurements ind alone.

Description

The colouring asked for is one of:

  • None or ‘phase’: the colours of the phases.
  • ‘orientation’, or an ipfDirection alone: every phase through the inverse pole figure key of its own frame.
  • an orientation per element: through the inverse pole figure key of its phase.
  • an orientationColorKey: the phases of its frame through the key, the others by their own inverse pole figure key for an ipfColorKey, else white.
  • the name of a property, or of a value per element the map or the grains compute (area, perimeter, aspectRatio, …): values.
  • a value or an RGB colour per element.
  • one colour, a name or an RGB triple, for all; or faceColor alone.

A site without an orientation is white, a not indexed phase too unless its frame has a colour of its own.

at= colours only the elements a picture shows, for a large map. Values are returned for all elements regardless, since the colour range belongs to the whole map; colours are returned one per entry of at.

Input

x EBSD or grain2d
color the colouring asked for, as listed above

Keywords

keyword default description
faceColor None one colour for all, when no colouring is asked for
ipfDirection None vector3d, the specimen direction of the inverse pole figure colours
at None the indices of the elements to colour

Output

values array, the RGB colours (n, 3) or the values (n,)
scalar bool, whether values are values a colour map maps, not colours

See also

EBSD.plot, grain2d.plot, ipfColors, 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/mapValues_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.