smpy.plotting.plot.plot_mass_map

smpy.plotting.plot.plot_mass_map(data, scaled_boundaries, true_boundaries, config, output_name=None, return_handles=False, map_category='convergence', counts_overlay=None)[source]

Plot a mass-like map (E/B mode) with styling and overlays.

Parameters:

  • data (numpy.ndarray) – 2D convergence map data (E or B mode).

  • scaled_boundaries (dict) – Scaled coordinate boundaries for plotting extent.

  • true_boundaries (dict) – True coordinate boundaries for tick labels.

  • config (dict) – Plot configuration settings including figsize, cmap, scaling, ‘coordinate_system’, optional ‘axis_reference’ (pixel only), and optional x-ray contour settings under xray_contours.

  • output_name (str, optional) – Path for saving the plot file.

  • return_handles (bool, optional) – If True, return (fig, ax, im) instead of closing.

  • map_category (str, optional) – Map category used for scaling and overlays. Options: ‘convergence’, ‘snr’, ‘counts’.

  • counts_overlay (numpy.ndarray, optional) – If provided, overlays integer per-pixel counts (using existing counts labeling logic) on top of the rendered image. Used when general.overlay_counts_map: true for convergence plots.

Returns:

handles – Returns (fig, ax, im) if return_handles=True.

Return type:

tuple, optional