"""
Defines the analysis and plotting functions for postprocessing regarding the mission
"""
# This file is part of FAST-OAD : A framework for rapid Overall Aircraft Design
# Copyright (C) 2024 ONERA & ISAE-SUPAERO
# FAST is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from os import PathLike
from typing import Union
import ipywidgets as widgets
import pandas as pd
import plotly.graph_objects as go
from IPython.display import clear_output, display
from fastoad._utils.files import as_path
from fastoad.model_base import FlightPoint
[docs]class MissionViewer:
"""
A class for facilitating the post-processing of mission and trajectories
"""
def __init__(self):
# The dataframes containing each mission
self.missions = {}
# The output widget containing the figure to display
self._output_widget = None
# The x selector
self._x_widget = None
# The y selector
self._y_widget = None
[docs] def add_mission(self, mission_data: Union[str, PathLike, pd.DataFrame], name=None):
"""
Adds the mission to the mission database (self.missions)
:param mission_data: path of the mission file or Dataframe containing the mission data
:param name: name to give to the mission
"""
if isinstance(mission_data, pd.DataFrame):
self.missions[name] = mission_data
else:
mission_data = as_path(mission_data)
if (
mission_data is not None
and mission_data.suffix == ".csv"
and mission_data.is_file()
):
self.missions[name] = pd.read_csv(mission_data, index_col=0)
else:
raise TypeError("Unknown type for mission data, please use .csv of DataFrame")
[docs] def display(self, layout_dict=None, layout_overwrite=False, **kwargs):
"""
Display the user interface
:param layout_dict: Dictionary of properties to be updated
:param layout_overwrite: If True, overwrite existing properties. If False, apply updates
to existing properties recursively, preserving existing
properties that are not specified in the update operation.
:param kwargs: Keyword/value pair of properties to be updated
:return the display object
"""
key = list(self.missions)[0]
keys = self.missions[key].keys()
self._output_widget = widgets.Output()
# By default ground distance
column_ground_distance = self._get_label(keys, "ground_distance", 3)
self._x_widget = widgets.Dropdown(value=column_ground_distance, options=keys)
self._x_widget.observe(self._show_plot, "value")
# By default altitude
column_altitude = self._get_label(keys, "altitude", 1)
self._y_widget = widgets.Dropdown(value=column_altitude, options=keys)
self._y_widget.observe(self._show_plot, "value")
self._show_plot(layout_dict=layout_dict, layout_overwrite=layout_overwrite, **kwargs)
toolbar = widgets.HBox(
[widgets.Label(value="x:"), self._x_widget, widgets.Label(value="y:"), self._y_widget]
)
ui = display(toolbar, self._output_widget)
return ui
# pylint: disable=unused-argument # change has to be there for observe() to work
def _show_plot(self, change=None, layout_dict=None, layout_overwrite=False, **kwargs):
"""
Updates and shows the plots
:param layout_dict: Dictionary of properties to be updated
:param layout_overwrite: If True, overwrite existing properties. If False, apply updates
to existing properties recursively, preserving existing
properties that are not specified in the update operation.
:param kwargs: Keyword/value pair of properties to be updated
"""
with self._output_widget:
clear_output(wait=True)
x_name = self._x_widget.value
y_name = self._y_widget.value
fig = None
for mission_name in self.missions:
if fig is None:
fig = go.Figure()
# pylint: disable=invalid-name # that's a common naming
x = self.missions[mission_name][x_name]
# pylint: disable=invalid-name # that's a common naming
y = self.missions[mission_name][y_name]
scatter = go.Scatter(x=x, y=y, mode="lines", name=mission_name)
fig.add_trace(scatter)
fig.update_layout(
title_text="Mission", title_x=0.5, xaxis_title=x_name, yaxis_title=y_name
)
fig.update_layout(layout_dict, overwrite=layout_overwrite, **kwargs)
fig = go.FigureWidget(fig)
display(fig)
@staticmethod
def _get_label(keys: pd.Index, quantity_name: str, default_idx: int):
"""
Gets the label corresponding to the desired quantity in the mission data if it exists.
Otherwise return the column corresponding to the default index.
"""
unit_quantity = FlightPoint.get_unit(quantity_name)
column_quantity = f"{quantity_name} [{unit_quantity}]"
label_quantity = column_quantity if column_quantity in keys else keys[default_idx]
return label_quantity