Skip to content

Add alt_text option to save_plot_as_png #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ruaridhg wants to merge 1 commit into from
Closed

Add alt_text option to save_plot_as_png #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions src/zarr_benchmarks/plotting_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
import pandas as pd
import seaborn as sns
from matplotlib import pyplot as plt
from PIL import Image
from PIL.PngImagePlugin import PngInfo


def get_limits_custom(x_min: int, x_max: int, max_range: int) -> tuple[float, float]:
Expand Down Expand Up @@ -116,11 +118,9 @@ def add_error_bars(x, y, x_stddev, **kwargs):
title = title + " - 2 standard deviations errorbars"
graph.figure.suptitle(title)
graph.tight_layout()
alt_text = title

save_plot_as_png(
graph,
get_output_path(data, plots_dir, plot_name),
)
save_plot_as_png(graph, get_output_path(data, plots_dir, plot_name), alt_text)


def plot_relplot_benchmarks(
Expand Down Expand Up @@ -195,11 +195,9 @@ def plot_relplot_benchmarks(
if title is not None:
graph.figure.suptitle(title)
graph.tight_layout()
alt_text = title

save_plot_as_png(
graph,
get_output_path(data, plots_dir, plot_name),
)
save_plot_as_png(graph, get_output_path(data, plots_dir, plot_name), alt_text)


def get_axis_labels(
Expand Down Expand Up @@ -229,11 +227,19 @@ def get_output_path(
return plots_dir / f"{plot_name}_{date}_{machine_info}.png"


def save_plot_as_png(grid: sns.FacetGrid, output_path: Path) -> None:
def save_plot_as_png(
grid: sns.FacetGrid, output_path: Path, alt_text: str | None = None
) -> None:
output_path.parent.mkdir(parents=True, exist_ok=True)
grid.savefig(output_path, format="png", dpi=300)
plt.close()

if alt_text:
img = Image.open(output_path)
metadata = PngInfo()
metadata.add_text("Alt", alt_text)
img.save(output_path, pnginfo=metadata)


def plot_catplot_benchmarks(
data: pd.DataFrame,
Expand Down Expand Up @@ -283,8 +289,6 @@ def plot_catplot_benchmarks(
if title is not None:
graph.figure.suptitle(title)
graph.tight_layout()
alt_text = title

save_plot_as_png(
graph,
get_output_path(data, plots_dir, plot_name),
)
save_plot_as_png(graph, get_output_path(data, plots_dir, plot_name), alt_text)