the inverse pole figure key of every indexed phase in a map, drawn in insets to the right of the map

Syntax

axs = keyLegend(mP, ebsd)

The keys along z.

axs = keyLegend(mP, ebsd, ipfDirection=xvector, width=0.2)

Along x, narrower.

Description

A map coloured by orientation draws these itself with legend=True. Every phase present gets the HSV key of its frame, titled by its mineral, one row each; a fundamental sector that reaches into both hemispheres, of a group without the inversion, takes two insets in its row, the upper hemisphere above the lower.

Input

mP mapPlot, the map plot beside which the keys go
x EBSD or grain2d, whose phases are shown

Keywords

keyword default description
ipfDirection None vector3d, the specimen direction of the colouring; the keys, which live in crystal coordinates, are the same for every direction
width 0.28 the width of an inset, as a fraction of the width of the map axes
resolution None the mesh of a key in radians; by default from the size of the inset

Output

axs list of the inset axes

See also

ipfHSVKey, plotKey, EBSD.plot, EBSDIPFMap

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