mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-26 07:00:17 -05:00
Magne Sjaastad
03409aed70
Introduce set_discrete_property_category_names on Case to bind integer result values to text labels and optional colors. Internally it creates a custom ColorLegend, appends one item per value (with an auto-assigned palette color when the caller does not provide one) and registers the legend as the default for the (case, resultName) pair. Also add Project.color_legend_collection() as a dedicated accessor for the project's ColorLegendCollection, pytest coverage for legend creation and the default-legend-for-result binding, and two PythonExamples demonstrating the end-to-end discrete property + category label flow. #13806 Python: Silence mypy warnings for category_mapping module
107 lines
3.3 KiB
Python
107 lines
3.3 KiB
Python
"""
|
|
Category name/color binding for discrete (INTEGER) grid cell results.
|
|
|
|
Provides a convenience API on Case for labeling integer result values with
|
|
human-readable names and optional colors. Internally, this reuses the existing
|
|
ColorLegend infrastructure: a new custom ColorLegend is created and registered
|
|
as the default legend for the (case, resultName) pair. When the property is
|
|
shown in a 3D view, the legend's item names are used as the category labels.
|
|
"""
|
|
|
|
from typing import Dict, List, Optional
|
|
|
|
from .pdmobject import add_method
|
|
from .project import Project
|
|
from .resinsight_classes import Case, ColorLegend
|
|
|
|
|
|
# Palette of distinct colors used when the caller does not supply colors.
|
|
# Mirrors RiaColorTables::categoryColors() in the C++ code.
|
|
_DEFAULT_PALETTE: List[str] = [
|
|
"#803e75",
|
|
"#d41c84",
|
|
"#f6768e",
|
|
"#c10020",
|
|
"#7f180d",
|
|
"#f13a13",
|
|
"#ff7a5c",
|
|
"#817066",
|
|
"#ff6800",
|
|
"#593315",
|
|
"#ff8e00",
|
|
"#cea262",
|
|
"#f4c800",
|
|
"#93aa00",
|
|
"#3b5417",
|
|
"#007d34",
|
|
"#367d7b",
|
|
"#00538a",
|
|
"#a6bdd7",
|
|
"#2e4ce0",
|
|
]
|
|
|
|
|
|
@add_method(Case)
|
|
def set_discrete_property_category_names(
|
|
self: Case,
|
|
property_name: str,
|
|
value_names: Dict[int, str],
|
|
value_colors: Optional[Dict[int, str]] = None,
|
|
legend_name: Optional[str] = None,
|
|
) -> Optional[ColorLegend]:
|
|
"""Bind integer values of a discrete grid property to text labels.
|
|
|
|
Use this after uploading a discrete property via set_grid_property(...,
|
|
data_type="INTEGER") or set_active_cell_property(..., data_type="INTEGER")
|
|
to display text labels instead of raw integers in the 3D view legend.
|
|
|
|
Arguments:
|
|
property_name (str): Name of the discrete property result.
|
|
value_names (Dict[int, str]): Mapping from integer value to label.
|
|
An empty dict removes any existing mapping for this property.
|
|
value_colors (Optional[Dict[int, str]]): Optional per-value colors as
|
|
strings accepted by QColor (e.g. "red", "#ff8800"). Values without
|
|
a color entry get an auto-assigned palette color.
|
|
legend_name (Optional[str]): Optional name for the color legend.
|
|
Defaults to the property name.
|
|
|
|
Returns:
|
|
The created ColorLegend, or None if value_names was empty.
|
|
"""
|
|
project = self.ancestor(Project)
|
|
if project is None:
|
|
raise RuntimeError("Could not find parent project")
|
|
|
|
collection = project.color_legend_collection()
|
|
if collection is None:
|
|
raise RuntimeError("Could not find ColorLegendCollection in project")
|
|
|
|
collection.delete_color_legend(case=self, result_name=property_name)
|
|
|
|
if not value_names:
|
|
return None
|
|
|
|
name = legend_name if legend_name else property_name
|
|
legend = collection.create_color_legend(name=name)
|
|
|
|
colors = value_colors or {}
|
|
palette_index = 0
|
|
for value, label in value_names.items():
|
|
color = colors.get(value)
|
|
if color is None:
|
|
color = _DEFAULT_PALETTE[palette_index % len(_DEFAULT_PALETTE)]
|
|
palette_index += 1
|
|
legend.add_color_legend_item(
|
|
category_value=value,
|
|
category_name=label,
|
|
color=color,
|
|
)
|
|
|
|
collection.set_default_color_legend_for_result(
|
|
case=self,
|
|
result_name=property_name,
|
|
color_legend=legend,
|
|
)
|
|
|
|
return legend
|