OrientationMap#

class pyxem.signals.OrientationMap(*args, **kwargs)[source]#

Bases: DiffractionVectors2D

Signal class for orientation maps. Note that this is a special case where for each navigation position, the signal contains the top n best matches in the form of a nx4 array with columns [index,correlation, in-plane rotation, mirror(factor)]

The Simulation is saved in the metadata but can be accessed using the .simulation attribute.

Parameters:

Attributes

OrientationMap.num_rows

OrientationMap.simulation

Simulation object used to generate the orientation map.

Methods

OrientationMap.deepcopy([deepcopy_simulation])

Deepcopy the signal.

OrientationMap.get_simulation_arrays()

OrientationMap.plot_over_signal(signal[, ...])

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

OrientationMap.to_crystal_map()

Convert the orientation map to an orix.crystal_map.CrystalMap object

OrientationMap.to_ipf_colormap([direction, ...])

Create a colored navigator and a legend (in the form of a marker) which can be passed as the navigator argument to the plot method of some signal.

OrientationMap.to_ipf_correlation_heatmap_markers([...])

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

OrientationMap.to_ipf_markers([offset_x, ...])

Convert the orientation map to a set of inverse pole figure markers which visualizes the best matching orientations in the reduced S2 space.

OrientationMap.to_markers([n_best, ...])

Convert the orientation map to a set of markers for plotting.

OrientationMap.to_phase_index()

Convert the orientation map to a set of phase ids

OrientationMap.to_phase_map()

Create a colored navigator which can be passed as the navigator argument to the plot method of some signal.

OrientationMap.to_polar_markers([n_best, ...])

Convert the orientation map to a set of markers for plotting in polar coordinates.

OrientationMap.to_rotation([flatten])

Convert the orientation map to a set of orix.Quaternion.Rotation objects.

OrientationMap.to_single_phase_orientations(...)

Convert the orientation map to an Orientation-object, given a single-phase simulation.

OrientationMap.to_single_phase_polar_markers(...)

[Deprecated]

OrientationMap.to_single_phase_vectors([...])

[Deprecated]

OrientationMap.to_vectors([n_best_index, ...])

Get the reciprocal lattice vectors for each navigation position.

Examples using OrientationMap#

Multi Phase Orientation Mapping

Multi Phase Orientation Mapping

On Zone Orientation

On Zone Orientation

Single Phase Orientation Mapping

Single Phase Orientation Mapping