sage.plotting.output_param_heatmap

Filename : output_param_heatmap.py Description : Short description of the file

Created on 2026-03-21 17:45:01

__author__ = Narenraju Nagarajan __copyright__ = Copyright 2026, ProjectName __license__ = MIT Licence __version__ = 0.0.1 __maintainer__ = Narenraju Nagarajan __affiliation__ = N/A __email__ = N/A __status__ = [‘inProgress’, ‘Archived’, ‘inUsage’, ‘Debugging’]

GitHub Repository: NULL

Documentation: NULL

Functions

plot_output_vs_param_heatmap(epoch, ranking_stat, ...)

2D histogram heatmap of network ranking statistic vs a source parameter.

Module Contents

plot_output_vs_param_heatmap(epoch, ranking_stat, labels, source_params, param_name, export_dir=None, save=True, bins_x=30, bins_y=30)[source]

2D histogram heatmap of network ranking statistic vs a source parameter.

Shows how the network output varies across the range of param_name for both signal and noise events. A strong vertical gradient indicates the parameter drives the detection score.

Parameters:

  • epoch (int or str) – Epoch identifier for the title and filename.

  • ranking_stat (array-like, shape (N,)) – Network ranking statistics.

  • labels (array-like, shape (N,)) – Binary ground-truth labels.

  • source_params (dict[str, array-like]) – Per-event parameter arrays.

  • param_name (str) – Key of the parameter to use on one axis.

  • export_dir (str or None) – Output directory.

  • save (bool) – If True, save to disk; otherwise display.

  • bins_x (int) – Number of parameter bins (default 30).

  • bins_y (int) – Number of ranking-statistic bins (default 30).