add_overlay#

CrystalMapPlot.add_overlay(crystal_map: orix.crystal_map.CrystalMap, item: str)[source]#

Use a crystal map property as gray scale values of a phase map.

The property’s range is adjusted to [0, 1] for maximum contrast.

Parameters:
crystal_map

Crystal map object to obtain necessary data from.

item

Name of map property to scale phase array with. The property range is adjusted for maximum contrast.

Examples

>>> from orix import data, plot
>>> xmap = data.sdss_ferrite_austenite()

Plot a phase map with a map property as overlay

>>> fig = plt.figure()
>>> ax = fig.add_subplot(projection="plot_map")
>>> im = ax.plot_map(xmap)
>>> ax.add_overlay(xmap, xmap.dp)
../../_images/orix-plot-CrystalMapPlot-add_overlay-1.png

Examples using CrystalMapPlot.add_overlay#