get_coloring

giant.coverage.visualizer:

giant.coverage.visualizer.get_coloring(cov, stat_set='v_count', label=None, reduction_function=<function percent_below_threshold_reducer.<locals>.percent_below_threshold>)[source]

This helper function chooses the appropriate values from the coverage object for displaying, applying the reduction function if necessary.

Parameters:

  • cov (Coverage) – the Coverage object

  • stat_set (Literal['v_count', 'd_albedo', 'd_x_slope', 'd_y_slope', 'd_total']) – the stats to get the coloring for

  • label (str | None) – the label to use if labeled analysis was performed

  • reduction_function (Callable[[ndarray[tuple[Any, ...], dtype[float64]]], float]) – a callabe to reduce all the DOP values for a facet to a single value for display

Returns:

a numpy array containing the values to color map in the display

Return type:

ndarray[tuple[Any, …], dtype[float64]]