IPFColorKeyTSL#
- class orix.plot.IPFColorKeyTSL(symmetry: Symmetry, direction: Vector3d | list | tuple[float, float, float] | None = None)[source]#
Bases:
IPFColorKeyAssigns colors to orientations in a symmetry-aware manner.
- Parameters:
- symmetry
Crystal symmetry used to define the colormap. If symmetry is not a Laue Symmetry, the equivalent Laue symmetry will be used instead.
- direction
Sample direction. If not given, sample Z direction (out of plane) is used.
Notes
IPF color keys work by defining symmetry-specific color maps that convert every orientation into a color. Images such as EBSD maps can then be colored based on the crystal vector aligned with a queried sample direction. For the simple case where the sample direction is aligned with the viewing direction, this is akin to asking “what color is the crystal vector pointing out of the screen at me.”
The TSL colormaps map only the 11 Laue classes, as they can all be described as weighted combinations of red, green, and blue. For details on this map as well as options for less limiting alternative mappings, refer to [].
Attributes
Return or set the sample direction.
Return the direction color key of the IPF color key.
Return or set the IPF color key symmetry.
Methods
IPFColorKeyTSL.orientation2color(orientation)Return an RGB color per orientation given a Laue symmetry and a sample direction.
IPFColorKeyTSL.plot(-> None)Plot the inverse pole figure color key.
