skued.brillouin_zones

class skued.brillouin_zones(image, mask, peaks, center=None, optimization_radius=None)

Generate Brillouin zone projections in the particular 2D geometry based on Bragg peak locations.

Parameters:

  • image (~numpy.ndarray, shape (M,N)) – Image to be aligned.

  • mask (~numpy.ndarray, shape (M,N)) – Mask that evaluates to True on valid pixels of the array image.

  • center (~numpy.ndarray, shape (2,), optional) – center of the image. Else, calls autocentering functionality

  • optimization_radius (float) – Number of pixels around each Bragg peak to perform self-optimization. If not specified, auto-optimization skipped.

__init__(image, mask, peaks, center=None, optimization_radius=None)

Generate Brillouin zone projections in the particular 2D geometry based on Bragg peak locations.

Parameters:

  • image (~numpy.ndarray, shape (M,N)) – Image to be aligned.

  • mask (~numpy.ndarray, shape (M,N)) – Mask that evaluates to True on valid pixels of the array image.

  • center (~numpy.ndarray, shape (2,), optional) – center of the image. Else, calls autocentering functionality

  • optimization_radius (float) – Number of pixels around each Bragg peak to perform self-optimization. If not specified, auto-optimization skipped.

Methods

__delattr__(name, /)

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

__ge__(value, /)

Return self>=value.

__getattribute__(name, /)

Return getattr(self, name).

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(image, mask, peaks[, center, ...])

Generate Brillouin zone projections in the particular 2D geometry based on Bragg peak locations.

__init_subclass__

This method is called when a class is subclassed.

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__new__(**kwargs)

__reduce__()

Helper for pickle.

__reduce_ex__(protocol, /)

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return str(self).

__subclasshook__

Abstract classes can override this to customize issubclass().

determineConsistency([BZs])

Determines the consistency of the BZ determination.

getEquivalentScatteringVectors(Qvector[, ...])

For a given scattering vector `Q', determine all equivalent reduced scattering vectors based on the Bragg peaks determined to be visible by the methods of this class.

getVisibleBZs([symmetry, bbox])

Determines which BZs have the following criteria:

renderVisibleBZs(axis[, BZs])

Renders BZs (specified manually as argument or all visible ones determined by a previous run of :func: getVisibleBZs) on a given axis.

Attributes

__annotations__