Follow us on LinkedIn  for project updates and announcements

Module: group_bar_plot

Expand source code 
# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from typing import List
import numpy as np
import pandas as pd
from matplotlib import pyplot as plt
from cl.runtime import Context
from cl.runtime.plots.group_bar_plot_style import GroupBarPlotStyle
from cl.runtime.plots.matplotlib_plot import MatplotlibPlot
from cl.runtime.records.dataclasses_extensions import field


@dataclass(slots=True, kw_only=True)
class GroupBarPlot(MatplotlibPlot):
    """Base class for the 2D bar plot."""

    title: str = field()
    """Plot title."""

    bar_labels: List[str] = field()
    """List of bar labels."""

    group_labels: List[str] = field()
    """List of group labels."""

    values: List[float] = field()
    """List of values in the same order as bar and group labels."""

    bar_axis_label: str | None = None
    """Bar axis label."""

    value_axis_label: str | None = None
    """Value axis label."""

    value_ticks: List[float] | None = None
    """Custom ticks for the value axis."""

    def _create_figure(self) -> plt.Figure:
        # Load style object or create with default settings if not specified
        style = self._load_style()
        theme = self._get_pyplot_theme(style=style)

        data = (
            pd.DataFrame.from_records([self.values, self.bar_labels, self.group_labels], index=["Value", "Col", "Row"])
            .T.pivot_table(index="Row", columns="Col", values="Value", sort=False)
            .astype(float)
        )

        with plt.style.context(theme):
            fig = plt.figure()
            axes = fig.add_subplot()

            num_groups = data.shape[0]
            num_bars = data.shape[1]

            x_ticks = np.arange(num_groups)

            if num_bars % 2 != 0:
                bar_shifts_positive = list(range(1, num_bars // 2 + 1))
            else:
                bar_shifts_positive = [x + 1 / 2 for x in range(num_bars // 2)]

            bar_shifts = [-x for x in reversed(bar_shifts_positive)]

            if num_bars % 2 != 0:
                bar_shifts += [0]

            bar_shifts += bar_shifts_positive

            space = 1 / (num_bars + 1)

            for i, (bar_label, bar_shift) in enumerate(zip(data.columns, bar_shifts)):
                axes.bar(x_ticks + space * bar_shift, data[bar_label].values, space, label=bar_label)

            axes.set_xticks(x_ticks, data.index.tolist())

            if self.value_ticks is not None:
                axes.set_yticks(self.value_ticks)

            # Set figure and axes labels
            axes.set_xlabel(self.bar_axis_label)
            axes.set_ylabel(self.value_axis_label)
            axes.set_title(self.title)

            # Add legend
            axes.legend()

        return fig

    def _load_style(self) -> GroupBarPlotStyle:
        """Load style object or create with default settings if not specified."""
        style = Context.current().load_one(GroupBarPlotStyle, self.style, is_key_optional=True)
        if style is None:
            # Use default values if not found
            style = GroupBarPlotStyle(plot_style_id="Default")
            style.init_all()
        return style

Classes

class GroupBarPlot (*, plot_id: str = None, style: PlotStyleKey | None = None, title: str = None, bar_labels: List[str] = None, group_labels: List[str] = None, values: List[float] = None, bar_axis_label: str | None = None, value_axis_label: str | None = None, value_ticks: Optional[List[float]] = None)

Base class for the 2D bar plot.

Expand source code 
@dataclass(slots=True, kw_only=True)
class GroupBarPlot(MatplotlibPlot):
    """Base class for the 2D bar plot."""

    title: str = field()
    """Plot title."""

    bar_labels: List[str] = field()
    """List of bar labels."""

    group_labels: List[str] = field()
    """List of group labels."""

    values: List[float] = field()
    """List of values in the same order as bar and group labels."""

    bar_axis_label: str | None = None
    """Bar axis label."""

    value_axis_label: str | None = None
    """Value axis label."""

    value_ticks: List[float] | None = None
    """Custom ticks for the value axis."""

    def _create_figure(self) -> plt.Figure:
        # Load style object or create with default settings if not specified
        style = self._load_style()
        theme = self._get_pyplot_theme(style=style)

        data = (
            pd.DataFrame.from_records([self.values, self.bar_labels, self.group_labels], index=["Value", "Col", "Row"])
            .T.pivot_table(index="Row", columns="Col", values="Value", sort=False)
            .astype(float)
        )

        with plt.style.context(theme):
            fig = plt.figure()
            axes = fig.add_subplot()

            num_groups = data.shape[0]
            num_bars = data.shape[1]

            x_ticks = np.arange(num_groups)

            if num_bars % 2 != 0:
                bar_shifts_positive = list(range(1, num_bars // 2 + 1))
            else:
                bar_shifts_positive = [x + 1 / 2 for x in range(num_bars // 2)]

            bar_shifts = [-x for x in reversed(bar_shifts_positive)]

            if num_bars % 2 != 0:
                bar_shifts += [0]

            bar_shifts += bar_shifts_positive

            space = 1 / (num_bars + 1)

            for i, (bar_label, bar_shift) in enumerate(zip(data.columns, bar_shifts)):
                axes.bar(x_ticks + space * bar_shift, data[bar_label].values, space, label=bar_label)

            axes.set_xticks(x_ticks, data.index.tolist())

            if self.value_ticks is not None:
                axes.set_yticks(self.value_ticks)

            # Set figure and axes labels
            axes.set_xlabel(self.bar_axis_label)
            axes.set_ylabel(self.value_axis_label)
            axes.set_title(self.title)

            # Add legend
            axes.legend()

        return fig

    def _load_style(self) -> GroupBarPlotStyle:
        """Load style object or create with default settings if not specified."""
        style = Context.current().load_one(GroupBarPlotStyle, self.style, is_key_optional=True)
        if style is None:
            # Use default values if not found
            style = GroupBarPlotStyle(plot_style_id="Default")
            style.init_all()
        return style

Ancestors

Static methods

def get_key_type() -> Type

Inherited from: MatplotlibPlot.get_key_type

Return key type even when called from a record.

Fields

var bar_axis_label -> str | None

Bar axis label.

var bar_labels -> List[str]

List of bar labels.

var group_labels -> List[str]

List of group labels.

var plot_id -> str

Inherited from: MatplotlibPlot.plot_id

Unique plot identifier.

var style -> PlotStyleKey | None

Inherited from: MatplotlibPlot.style

Color and layout options.

var title -> str

Plot title.

var value_axis_label -> str | None

Value axis label.

var value_ticks -> Optional[List[float]]

Custom ticks for the value axis.

var values -> List[float]

List of values in the same order as bar and group labels.

Methods

def get_key(self) -> PlotKey

Inherited from: MatplotlibPlot.get_key

Return a new key object whose fields populated from self, do not return self.

def get_view(self) -> View

Inherited from: MatplotlibPlot.get_view

Return a view object for the plot, implement using ‘create_figure’ method.

def init_all(self) -> None

Inherited from: MatplotlibPlot.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.

def save_png(self) -> None

Inherited from: MatplotlibPlot.save_png

Save in png format to ‘base_dir/plot_id.png’, implement using ‘create_figure’ method.