DiffractionVectors

class pyxem.signals.DiffractionVectors(*args, **kwargs)

Bases: BaseSignal

Class for diffraction vectors in reciprocal space.

Diffraction vectors are defined as the vectors from the center of the diffraction pattern to the diffraction peaks. Note the DiffractionVectors class is likely to change as the API for diffraction vectors is developed.

Variables:

• cartesian (np.array()) – Array of 3-vectors describing Cartesian coordinates associated with each diffraction vector.

• hkls (np.array()) – Array of Miller indices associated with each diffraction vector following indexation.

Attributes

DiffractionVectors.center	The center of the diffraction pattern in pixels.
DiffractionVectors.column_names
DiffractionVectors.detector_shape
DiffractionVectors.has_navigation_axis
DiffractionVectors.num_columns
DiffractionVectors.num_rows
DiffractionVectors.offsets
DiffractionVectors.pixel_calibration	[Deprecated]
DiffractionVectors.pixel_vectors	Returns the diffraction vectors in pixel coordinates.
DiffractionVectors.scales
DiffractionVectors.units

Methods

DiffractionVectors.calculate_cartesian_coordinates(...)	Get cartesian coordinates of the diffraction vectors.
DiffractionVectors.cluster(method[, ...])	This method clusters a list of vectors both in reciprocal space and in real space.
DiffractionVectors.filter_basis(basis[, ...])	Filter vectors to only the set of vectors which is close to a basis set of vectors.
DiffractionVectors.filter_detector_edge(...)	Filter the diffraction vectors to accept only those not within a user specified proximity to the detector edge.
DiffractionVectors.filter_magnitude(...)	Filter the diffraction vectors to accept only those with a magnitude within a user specified range.
DiffractionVectors.flatten_diffraction_vectors([...])	Flattens the diffraction vectors into a DiffractionVector2D object.
DiffractionVectors.from_peaks(peaks[, ...])	Takes a list of peak positions (pixel coordinates) and returns an instance of Diffraction2D
DiffractionVectors.get_diffracting_pixels_map([...])	Map of the number of vectors at each navigation position.
DiffractionVectors.get_magnitude_histogram(...)	Obtain a histogram of gvector magnitudes.
DiffractionVectors.get_magnitudes(*args, ...)	Calculate the magnitude of diffraction vectors.
DiffractionVectors.get_unique_vectors(*args, ...)	Returns diffraction vectors considered unique by: strict comparison, distance comparison with a specified threshold, or by clustering using DBSCAN [1].
DiffractionVectors.plot_diffraction_vectors([...])	Plot the unique diffraction vectors.
DiffractionVectors.plot_diffraction_vectors_on_signal(...)	[Deprecated] Plot the diffraction vectors on a signal.
DiffractionVectors.to_markers(**kwargs)
DiffractionVectors.to_polar()	Convert the diffraction vectors to polar coordinates.

Examples using DiffractionVectors

Finding Diffraction Vectors

Finding Diffraction Vectors

Operations on vectors

Operations on vectors

Glass Symmetry from Vectors

Glass Symmetry from Vectors

Clustering Vectors

Clustering Vectors