Skip to content

voiage.cli.calculate_threshold

calculate_threshold([positional or keyword] surface_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON surface data for threshold VOI'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save threshold result')) -> None

Calculate threshold, tipping-point, and robust VOI from a JSON surface file.

Calculate threshold-crossing summaries and robust strategy:

.. code-block:: bash

voiage calculate-threshold threshold_surface.json

Parameters:

  • surface_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON surface data for threshold VOI'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save threshold result'))

Returns: None