sage.plotting.cumulative_volume

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

Created on 2026-03-21 17:49:02

__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_cumulative_volume(epoch, ranking_stat, labels, ...)

Plot cumulative detectable volume as a function of ranking-statistic threshold.

Module Contents

plot_cumulative_volume(epoch, ranking_stat, labels, source_params, distance_param='distance', export_dir=None, save=True, bins=50)[source]

Plot cumulative detectable volume as a function of ranking-statistic threshold.

For each threshold value, counts the number of signals above threshold and weights each signal by the volume element (distance/d_min)^3 to approximate a cumulative sensitive volume curve. Higher is better.

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; must contain distance_param.

  • distance_param (str) – Key for the luminosity distance array (default "distance").

  • export_dir (str or None) – Output directory.

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

  • bins (int) – Number of threshold bins (default 50).