plot_over_signal#

OrientationMap.plot_over_signal(signal, add_vector_markers=True, add_ipf_markers=True, add_ipf_correlation_heatmap=False, add_ipf_colorkey=True, vector_kwargs=None, **kwargs)[source]#

Convenience method to plot the orientation map and the n-best matches over the signal.

Parameters:

  • signal (BaseSignal) – The signal to plot the orientation map over.

  • add_vector_markers (bool) – If True, the vector markers will be added to the signal.

  • add_ipf_markers (bool) – If True, the IPF best fit will be added to the signal in an overlay

  • add_ipf_correlation_heatmap (bool) – If True, a correlation score heatmap as an IPF will be added to the signal in an overlay. This overrides the add_ipf_markers parameter.

  • add_ipf_colorkey (bool) – If True, the IPF colorkey will be added to the signal

  • vector_kwargs (dict) – Additional keyword arguments to pass to the to_single_phase_markers method

  • kwargs – Additional keyword arguments to pass to the hyperspy.api.signals.Signal2D.plot() method