from __future__ import annotations # noqa: F404
from typing import Any
from IPython.display import DisplayHandle, display
from ipywidgets import widgets
from natsort import natsorted
from pypilecore.results.typing import CasesMultiCPTResultsLike
from pypilecore.viewers.interactive_figures.figure_cpt_results_plan_view import (
FigureCPTResultsPlanView,
)
[docs]
class ViewerCptResultsPlanView:
"""
Viewer for the CPT results of the bearing capacity calculations in
plan view for a fixed pile tip level (PTL).
It offers the following layout:
- Dropdown widgets:
- Case: to select the case to show.
- Result: to select the result to show.
- Pile tip level: to select the pile tip level to show.
- Figure CPT results vs. pile tip level:
- X axis: X coordinate.
- Y axis: Y coordinate.
- Each point represents a different CPT, but the same pile tip level.
"""
[docs]
def __init__(self, results_cases: CasesMultiCPTResultsLike) -> None:
"""Initialize the viewer.
Parameters
----------
results_cases : CasesMultiCPTResultsProtocol
The results of the bearing capacity calculations.
"""
# Initialize figure CPT results in plan view
self._figure_plan_view = FigureCPTResultsPlanView(results_cases=results_cases)
# Set up control widgets
self._case_dropdown = widgets.Dropdown(
description="Case:",
value=self._figure_plan_view.cases[0],
options=self._figure_plan_view.cases,
)
# Create a sorted list of unique result names
result_options = natsorted(
set(
[
result_def.name
for result_def in results_cases.cpt_results_table.result_def
]
)
)
self._result_dropdown = widgets.Dropdown(
description="Result:",
value=result_options[0],
options=result_options,
)
self._pile_tip_level_dropdown = widgets.Dropdown(
description="Pile tip level NAP:",
value=self._figure_plan_view.pile_tip_levels_nap[-1],
options=self._figure_plan_view.pile_tip_levels_nap,
)
# Update plot for initial selection of control widgets
self._update_case_result_and_ptl(None)
# Set up callbacks
self._case_dropdown.observe(self._update_case_result_and_ptl, "value")
self._result_dropdown.observe(self._update_case_result_and_ptl, "value")
self._pile_tip_level_dropdown.observe(self._update_case_result_and_ptl, "value")
# Set up layout
self._control_widgets = widgets.HBox(
[
self._case_dropdown,
self._result_dropdown,
self._pile_tip_level_dropdown,
]
)
self._layout = widgets.VBox(
[self._control_widgets, self._figure_plan_view.figure]
)
def _update_case_result_and_ptl(self, change: Any) -> None:
"""
Private method to update the figure when the case, result name or pile tip level
are changed in the control widgets.
"""
# Update the figure
self._figure_plan_view.show_case_result_and_ptl(
case_name=self._case_dropdown.value,
result_name=self._result_dropdown.value,
pile_tip_level_nap=self._pile_tip_level_dropdown.value,
)
[docs]
def display(self) -> DisplayHandle | None:
"""Display the figure."""
return display(self._layout)