the legend of the phases present in a map or grains, one patch per phase in its colour, a not indexed phase only when it was given a colour of its own
Syntax
leg = phaseLegend(mP, ebsd)
The phases of a map in the upper right.
leg = phaseLegend(mP, grains, loc='lower left')
Elsewhere.
Description
A map coloured by phase draws this itself with legend=True. A patch is labelled by the mineral of its phase.
Input
mP |
mapPlot, the map plot the legend goes into |
x |
EBSD or grain2d, whose phases are shown |
Keywords
| keyword | default | description |
|---|---|---|
loc |
'upper right' |
the place of the legend, as matplotlib’s legend takes it |
Output
leg |
the matplotlib Legend |
See also
keyLegend, plotEBSD, plotGrains
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/phaseLegend_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.