to_ipf_correlation_heatmap_markers#

OrientationMap.to_ipf_correlation_heatmap_markers(offset_x: float = 0.85, offset_y: float = 0.85, scale: float = 0.2, cmap: str = 'inferno')[source]#

Get the outline of the IPF for the orientation map as a marker in the upper right hand corner including labels if desired. As well as the color mesh for the IPF.

Parameters:

  • offset (float) – The offset of the markers from the lower left of the plot (as a fraction of the axis).

  • scale (float) – The scale (as a fraction of the axis) for the markers.

Returns:

  • polygon_sector (hs.plot.markers.Polygons) – The outline of the IPF as a marker

  • texts (hs.plot.markers.Texts) – The text labels for the IPF axes

  • mesh (hs.plot.markers.Markers) – The color mesh for the IPF (using matplotlib.collections.QuadMesh)

Notes

It is recommended to have a large n_keep for this to look nice, e.g. 75% of the simulation bank.

This will not look good if the rotations used in the simulation(s) consists of multiple different regions in the IPF.