Skip to content
voiage

voiage.cli.plot_perspective_regret

plot_perspective_regret

Section titled “plot_perspective_regret”
plot_perspective_regret([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 a Value of Perspective regret plot'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save the perspective regret plot')) -> None

Plot the experimental Value of Perspective regret matrix.

Examples

Section titled “Examples”

Plot a perspective regret matrix:

.. code-block:: bash

voiage plot-perspective-regret perspective_surface.json –output regret.png

Parameters:

  • surface_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON surface data for a Value of Perspective regret plot'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save the perspective regret plot'))

Returns: None