structure_factor_utils.structure_factor.StructureFactorArtist

class structure_factor_utils.structure_factor.StructureFactorArtist(axis)

Bases: object

Draws plots of the structure factor

Parameters:

_axis (matplotlib.axes.Axes) – axes the structure factor plots are drawn to

__init__(axis)

Constructor method

Methods

__init__(axis)	Constructor method
draw_structure_factor(structure_factor, ...)	Draws a color map of a structure factor.

Attributes

axis	Gets _axis

property axis

Gets _axis

draw_structure_factor(structure_factor, plane_vec1, plane_vec2, sample_shape)

Draws a color map of a structure factor.

Scattering vector inputs are chosen in a plane defined by plane_vec1, plane_vec2.

Parameters:

• structure_factor (StructureFactor) – a StructureFactor object that contains system

• plane_vec1 (tuple[float, float, float]) – a vector in the reciprocal lattice basis

• plane_vec2 (tuple[float, float, float]) – a vector in the reciprocal lattice basis

• sample_shape (int) – number of lines to sample along plane_vec1, plane_vec2

Raises:

ValueError – if the structure_factor argument is not an instance of a StructureFactor subclass.