regularizepsf.visualize#

Visualization tools for PSFs.

Attributes#

Functions#

_generate_colormap(→ matplotlib.colors.ListedColormap)

visualize_patch_counts(→ matplotlib.axes.Axes)

Visualize the number of stars identified within each patch.

visualize_grid(→ None)

Visualize various indexed cubes.

Module Contents#

regularizepsf.visualize._generate_colormap() matplotlib.colors.ListedColormap[source]#
regularizepsf.visualize.DEFAULT_COLORMAP#
regularizepsf.visualize.PSF_IMSHOW_ARGS_DEFAULT#
regularizepsf.visualize.KERNEL_IMSHOW_ARGS_DEFAULT#
regularizepsf.visualize.visualize_patch_counts(counts: dict[tuple[int, int], int], ax: matplotlib.axes.Axes | None = None, label_pixel_bounds: bool = False) matplotlib.axes.Axes[source]#

Visualize the number of stars identified within each patch.

Parameters:
  • counts (dict[tuple[int, int], int]) – The counts returned by an ArrayPSFBuilder.build

  • ax (matplotlib.axes.Axes) – An Axes object on which to plot. If not provided, a new Figure will be generated.

  • label_pixel_bounds (bool) – If True, the axes of the plot will be labeled with the pixel range spanned by each patch.

regularizepsf.visualize.visualize_grid(data: regularizepsf.util.IndexedCube, second_data: regularizepsf.util.IndexedCube | None = None, title: str | tuple[str, str] = '', fig: matplotlib.figure.Figure | None = None, fig_scale: int = 1, patch_stride: int = 1, edge_trim: int = 0, imshow_args: dict | None = None, colorbar_label: str = '') None[source]#

Visualize various indexed cubes.

Parameters:
  • data (IndexedCube) – primary data set to visualize

  • second_data (IndexedCube) – second set of data visualize

  • title (str) – plot title

  • fig (mp.figure.Figure) – the figure to plot in

  • fig_scale (int) – increasing this will make the figure higher resolution

  • edge_trim (int) – how many pixels to drop on each side of the PSF for plotting

  • patch_stride (int) – multiple of how many patches to skip when plotting, 1 means no skipping, 2 plots every other, 3 every third

  • imshow_args (dict) – additional arguments for imshow

  • colorbar_label (str) – label for the colorbar

Return type:

None