Source code for gemseo_pymoo.post.petal
# Copyright 2022 Airbus SAS
# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# Contributors:
# INITIAL AUTHORS - initial API and implementation and/or initial
# documentation
# :author: Gabriel Max DE MENDONÇA ABRANTES
"""Petal diagram."""
from __future__ import annotations
import logging
from typing import TYPE_CHECKING
from typing import Any
from pymoo.visualization.petal import Petal as PymooPetal
from gemseo_pymoo.post.core.multi_objective_diagram import MultiObjectiveDiagram
if TYPE_CHECKING:
from numpy import ndarray
from pymoo.core.decomposition import Decomposition
LOGGER = logging.getLogger(__name__)
[docs]
class Petal(MultiObjectiveDiagram):
"""`Petal diagrams <https://pymoo.org/visualization/petal.html>`_).
Note:
This post-processor assumes the optimization has converged to a well-defined
pareto front.
"""
def _plot(
self,
decomposition: Decomposition,
weights: ndarray,
**scalar_options: Any,
) -> None:
"""Plot one petal diagram for each set of weights.
A `scalarization function <https://pymoo.org/misc/decomposition.html>`_ is used
to transform the multi-objective functions into a single-objective.
"""
super()._plot(
PymooPetal,
decomposition,
weights,
normalize_each_objective=False,
**scalar_options,
)