DiffractionSpotsVisualization#

class abtem.visualize.DiffractionSpotsVisualization(measurements, ax, cbar=False, cmap=None, vmin=None, vmax=None, power=1.0, scale=0.1, common_scale=False, explode=False, figsize=None, interact=False)[source]#

Bases: abtem.visualize.BaseMeasurementVisualization2D

Display a diffraction pattern as indexed Bragg reflections.

Parameters
  • measurements (IndexedDiffractionPattern) – Diffraction pattern to be displayed.

  • scale (float) – Size of the circles representing the diffraction spots.

  • ax (matplotlib.axes.Axes, optional) – If given the plots are added to the axis.

Returns

figure, axis_handle

Return type

matplotlib.figure.Figure, matplotlib.axis.Axis

__init__(measurements, ax, cbar=False, cmap=None, vmin=None, vmax=None, power=1.0, scale=0.1, common_scale=False, explode=False, figsize=None, interact=False)[source]#

Methods

__init__(measurements, ax[, cbar, cmap, ...])

add_area_indicator(area_indicator[, panel])

adjust_axes_position(rect)

adjust_figure_aspect()

adjust_tight_bbox()

animate([interval, blit, repeat, adjust_scale])

axis_off([spines])

get_global_vmin_vmax([vmin, vmax])

rtype

tuple[float, float]

pick_events()

remove_miller_index_annotations()

set_artists()

set_axes_padding([padding])

Set the padding between the axes in an AxesGrid.

set_cbar_labels([label])

set_cbar_padding([padding])

set_cbar_size(fraction)

set_cbar_spacing(spacing)

set_cbars(**kwargs)

set_column_titles([titles, pad, format, ...])

set_ensemble_indices([indices])

Set the indices into the ensemble dimensions to select the visualized ensemble members.

set_hkl_threshold(threshold)

set_miller_index_annotations([threshold, ...])

set_normalization([power, vmin, vmax])

set_panel_labels([labels, frameon, loc, ...])

set_row_titles([titles, shift, format, units])

Set the titles for the rows of the grid of axes.

set_scale_units([units])

set_scalebars([panel_loc, label, size, loc, ...])

set_xlabels([label])

set_xlim([xlim])

Set the x-axis view limits.

set_xunits([units])

Set the units for the x-axis.

set_ylabels([label])

set_ylim([ylim])

Set the y-axis view limits.

set_yunits([units])

Set the units for the y-axis.

update_artists()

update_panel_labels()

Attributes

artists

autoscale

axes

axes_types

fig

indices

measurements

ncols

nrows

widgets

set_axes_padding(padding=(0.0, 0.0))#

Set the padding between the axes in an AxesGrid.

Parameters

padding (float or tuple of float) – The padding along columns and rows.

set_ensemble_indices(indices=())#

Set the indices into the ensemble dimensions to select the visualized ensemble members. Interactive visualization are updated.

Parameters

indices (int or tuple of int) –

set_row_titles(titles=None, shift=0.0, format='.3g', units=None, **kwargs)#

Set the titles for the rows of the grid of axes.

Parameters
  • titles (str or list of str, optional) – If given as list, each item is given as a title for a row, the list must have the same length as the number of rows. If given as string the same title is given to all rows. If not given the titles are derived from the axes metadata.

  • shift (float, optional) – Horizontal shift of the title positions.

  • format (str, optional) – String formatting of titles derived from axes metadata.

  • units (str, optional) – The units used for titles derived from axes metadata.

set_xlim(xlim=None)[source]#

Set the x-axis view limits.

set_xunits(units=None)[source]#

Set the units for the x-axis.

Parameters

units (str) – The name of the units. Must be compatible with existing units.

set_ylim(ylim=None)[source]#

Set the y-axis view limits.

set_yunits(units=None)[source]#

Set the units for the y-axis.

Parameters

units (str) – The name of the units. Must be compatible with existing units.