Spaces:
Build error
Build error
File size: 29,011 Bytes
b6f39f4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 | """Plotting utilities for diffusion models.
This module provides consistent styling and reusable plotting functions
for visualising diffusion model results.
Example usage:
>>> from ddpm.plotting import configure_matplotlib
>>> configure_matplotlib() # Set up LaTeX fonts
"""
from collections.abc import Sequence
from pathlib import Path
import matplotlib.pyplot as plt
import numpy as np
import torch
# =============================================================================
# Colour Palette
# =============================================================================
COLOURS: list[str] = [
"#ffbe0b", # Yellow
"#fb5607", # Orange
"#ff006e", # Pink
"#8338ec", # Purple
"#3a86ff", # Blue
"#06d6a0", # Green
"#390099", # Deep purple
"#ef476f", # Coral red
"#61E8E1", # Teal
"#00D4FF", # Cyan
]
# Default colours for reference vs generated comparison
REFERENCE_COLOUR = "#6f6f6f"
GENERATED_COLOUR = COLOURS[3] # Purple
ANALYTIC_COLOUR = "black"
# =============================================================================
# Matplotlib Configuration
# =============================================================================
_LATEX_CONFIG = {
"text.usetex": True,
"font.family": "serif",
"font.serif": ["Times New Roman", "DejaVu Serif"],
"mathtext.fontset": "cm",
"font.size": 10,
"axes.labelsize": 10,
"axes.titlesize": 10,
"xtick.labelsize": 9,
"ytick.labelsize": 9,
"legend.fontsize": 9,
"figure.titlesize": 11,
"text.latex.preamble": r"\usepackage{newtxtext,newtxmath}",
"figure.dpi": 300,
"savefig.dpi": 300,
"savefig.format": "pdf",
"savefig.bbox": "tight",
"axes.unicode_minus": False, # Use proper LaTeX minus sign
}
_FALLBACK_CONFIG = {
"text.usetex": False,
"font.family": "serif",
"font.serif": ["DejaVu Serif"],
"mathtext.fontset": "cm",
"font.size": 10,
"axes.labelsize": 10,
"axes.titlesize": 10,
"xtick.labelsize": 9,
"ytick.labelsize": 9,
"legend.fontsize": 9,
"figure.titlesize": 11,
"figure.dpi": 300,
"savefig.dpi": 300,
"savefig.format": "pdf",
"savefig.bbox": "tight",
}
def configure_matplotlib(use_latex: bool = True) -> bool:
"""Configure matplotlib
Args:
use_latex: Whether to attempt LaTeX rendering (default: True)
Returns:
True if LaTeX rendering is enabled, False otherwise
"""
if use_latex:
try:
plt.rcParams.update(_LATEX_CONFIG)
import matplotlib
matplotlib.use("Agg")
# Test LaTeX rendering
fig, ax = plt.subplots(1, 1)
ax.text(0.5, 0.5, r"$\mu$")
fig.canvas.draw()
plt.close(fig)
return True
except (RuntimeError, FileNotFoundError):
pass
plt.rcParams.update(_FALLBACK_CONFIG)
return False
def _to_numpy(data: torch.Tensor | np.ndarray) -> np.ndarray:
"""Convert tensor to numpy array."""
if isinstance(data, torch.Tensor):
return data.detach().cpu().numpy()
return data
def save_figure(fig: plt.Figure, save_path: Path | str | None) -> None:
"""Save figure to PDF.
Args:
fig: Matplotlib figure to save
save_path: Path to save figure (without extension), or None to show
"""
if save_path:
save_path = Path(save_path)
save_path.parent.mkdir(parents=True, exist_ok=True)
fig.savefig(save_path.with_suffix(".pdf"), dpi=300, bbox_inches="tight")
print(f"Saved figure to {save_path.with_suffix('.pdf')}")
plt.close(fig)
else:
plt.show()
def clean_axes(ax: plt.Axes) -> None:
"""Remove top and right spines from axes."""
ax.spines["top"].set_visible(False)
ax.spines["right"].set_visible(False)
# =============================================================================
# Generic Plotting Functions
# =============================================================================
def plot_trajectory_statistics(
reference: torch.Tensor | np.ndarray,
generated: torch.Tensor | np.ndarray,
time_array: np.ndarray,
reference_label: str = "Reference",
generated_label: str = "Generated",
ylabel_mean: str = r"$\mu(t)$",
ylabel_var: str = r"$\sigma^2(t)$",
xlabel: str = r"$t$",
reference_band_mode: str | None = "std",
generated_band_mode: str | None = "std",
analytic_mean: torch.Tensor | np.ndarray | None = None,
analytic_var: torch.Tensor | np.ndarray | None = None,
analytic_label: str = "Analytic",
save_path: Path | str | None = None,
) -> None:
"""Plot comparison of trajectory statistics (mean and variance).
Creates two subplots showing mean and variance comparison.
Args:
reference: Reference trajectories [n_trajectories, n_steps]
generated: Generated trajectories [n_trajectories, n_steps]
time_array: Time values [n_steps]
reference_label: Label for reference data
generated_label: Label for generated data
ylabel_mean: Y-axis label for mean plot
ylabel_var: Y-axis label for variance plot
xlabel: X-axis label
reference_band_mode: Spread band for reference curve: ``"std"``, ``"sem"``, or ``None``
generated_band_mode: Spread band for generated curve: ``"std"``, ``"sem"``, or ``None``
analytic_mean: Optional analytic mean curve [n_steps]
analytic_var: Optional analytic variance curve [n_steps]
analytic_label: Label used for analytic overlays
save_path: Path to save figure (without extension)
"""
reference = _to_numpy(reference)
generated = _to_numpy(generated)
analytic_mean = None if analytic_mean is None else _to_numpy(analytic_mean)
analytic_var = None if analytic_var is None else _to_numpy(analytic_var)
fig, axes = plt.subplots(2, 1, figsize=(6, 4.8), sharex=True)
def compute_mean_band(data: np.ndarray, mode: str | None) -> np.ndarray | None:
if mode is None:
return None
if mode == "std":
return data.std(axis=0)
if mode == "sem":
return data.std(axis=0) / np.sqrt(data.shape[0])
raise ValueError(f"Unknown band mode {mode!r}. Expected 'std', 'sem', or None.")
def compute_variance_band(data: np.ndarray, mode: str | None) -> np.ndarray | None:
if mode is None:
return None
centred = data - data.mean(axis=0, keepdims=True)
squared = centred**2
if mode == "std":
return squared.std(axis=0)
if mode == "sem":
return squared.std(axis=0) / np.sqrt(data.shape[0])
raise ValueError(f"Unknown band mode {mode!r}. Expected 'std', 'sem', or None.")
# Compute statistics
ref_mean = reference.mean(axis=0)
gen_mean = generated.mean(axis=0)
ref_mean_band = compute_mean_band(reference, reference_band_mode)
gen_mean_band = compute_mean_band(generated, generated_band_mode)
# Subplot 1: Mean comparison
ax = axes[0]
ax.plot(
time_array,
ref_mean,
color=REFERENCE_COLOUR,
linewidth=1.5,
label=f"{reference_label} (mean)",
)
if ref_mean_band is not None:
band_label = (
rf"{reference_label} ($\pm 1\sigma$)"
if reference_band_mode == "std"
else rf"{reference_label} (SEM)"
)
ax.fill_between(
time_array,
ref_mean - ref_mean_band,
ref_mean + ref_mean_band,
color="grey",
alpha=0.3,
label=band_label,
)
ax.plot(
time_array,
gen_mean,
color=GENERATED_COLOUR,
linewidth=1.5,
label=f"{generated_label} (mean)",
)
if gen_mean_band is not None:
band_label = (
rf"{generated_label} ($\pm 1\sigma$)"
if generated_band_mode == "std"
else rf"{generated_label} (SEM)"
)
ax.fill_between(
time_array,
gen_mean - gen_mean_band,
gen_mean + gen_mean_band,
color=GENERATED_COLOUR,
alpha=0.3,
label=band_label,
)
if analytic_mean is not None:
ax.plot(
time_array,
analytic_mean,
color=ANALYTIC_COLOUR,
linewidth=1.2,
linestyle="--",
label=analytic_label,
)
ax.set_ylabel(ylabel_mean)
ax.set_xlim(time_array[0], time_array[-1])
ax.legend(
frameon=False,
loc="lower left",
ncol=3,
bbox_to_anchor=(0.0, 1.04),
borderaxespad=0.0,
)
clean_axes(ax)
# Subplot 2: Variance comparison with standard error shading
ax = axes[1]
ref_var = reference.var(axis=0)
gen_var = generated.var(axis=0)
ref_var_band = compute_variance_band(reference, reference_band_mode)
gen_var_band = compute_variance_band(generated, generated_band_mode)
ax.plot(time_array, ref_var, color=REFERENCE_COLOUR, linewidth=1.5, label=reference_label)
ax.plot(time_array, gen_var, color=GENERATED_COLOUR, linewidth=1.5, label=generated_label)
if ref_var_band is not None:
band_label = (
rf"{reference_label} variance ($\pm 1\sigma$)"
if reference_band_mode == "std"
else rf"{reference_label} variance (SEM)"
)
ax.fill_between(
time_array,
np.clip(ref_var - ref_var_band, a_min=0.0, a_max=None),
ref_var + ref_var_band,
color="grey",
alpha=0.2,
label=band_label,
)
if gen_var_band is not None:
band_label = (
rf"{generated_label} variance ($\pm 1\sigma$)"
if generated_band_mode == "std"
else rf"{generated_label} variance (SEM)"
)
ax.fill_between(
time_array,
np.clip(gen_var - gen_var_band, a_min=0.0, a_max=None),
gen_var + gen_var_band,
color=GENERATED_COLOUR,
alpha=0.2,
label=band_label,
)
if analytic_var is not None:
ax.plot(
time_array,
analytic_var,
color=ANALYTIC_COLOUR,
linewidth=1.2,
linestyle="--",
label=analytic_label,
)
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel_var)
ax.set_xlim(time_array[0], time_array[-1])
ax.legend(
frameon=False,
loc="lower left",
ncol=3,
bbox_to_anchor=(0.0, 1.04),
borderaxespad=0.0,
)
clean_axes(ax)
fig.subplots_adjust(top=0.84, hspace=0.7)
save_figure(fig, save_path)
def plot_sample_trajectories(
reference: torch.Tensor | np.ndarray,
generated: torch.Tensor | np.ndarray,
time_array: np.ndarray,
n_samples: int = 5,
reference_label: str = "Reference",
generated_label: str = "Generated",
ylabel_ref: str | None = None,
ylabel_gen: str | None = None,
xlabel: str = r"$t$",
save_path: Path | str | None = None,
) -> None:
"""Plot sample individual trajectories.
Creates two subplots showing sample reference and generated trajectories.
Args:
reference: Reference trajectories [n_trajectories, n_steps]
generated: Generated trajectories [n_trajectories, n_steps]
time_array: Time values [n_steps]
n_samples: Number of sample trajectories to plot
reference_label: Label for reference data
generated_label: Label for generated data
ylabel_ref: Y-axis label for reference plot (default: uses reference_label)
ylabel_gen: Y-axis label for generated plot (default: uses generated_label)
xlabel: X-axis label
save_path: Path to save figure (without extension)
"""
reference = _to_numpy(reference)
generated = _to_numpy(generated)
if ylabel_ref is None:
ylabel_ref = rf"$x_{{\mathrm{{{reference_label}}}}}(t)$"
if ylabel_gen is None:
ylabel_gen = rf"$x_{{\mathrm{{{generated_label}}}}}(t)$"
fig, axes = plt.subplots(2, 1, figsize=(6, 4), sharex=True)
# Plot reference trajectories
ax = axes[0]
for i in range(min(n_samples, len(reference))):
ax.plot(time_array, reference[i], alpha=0.6, linewidth=1, color=REFERENCE_COLOUR)
ax.set_ylabel(ylabel_ref)
ax.set_xlim(time_array[0], time_array[-1])
clean_axes(ax)
# Plot generated trajectories
ax = axes[1]
for i in range(min(n_samples, len(generated))):
ax.plot(time_array, generated[i], alpha=0.6, linewidth=1, color=GENERATED_COLOUR)
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel_gen)
ax.set_xlim(time_array[0], time_array[-1])
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
def plot_acf_comparison(
real_acf: np.ndarray,
generated_acf: np.ndarray | None,
lag_axis: np.ndarray,
real_acf_std: np.ndarray | None = None,
generated_acf_std: np.ndarray | None = None,
analytic_acf: np.ndarray | None = None,
reference_label: str = "Reference",
generated_label: str = "Generated",
analytic_label: str = "Analytic",
xlabel: str = r"Lag $\tau$",
ylabel: str = r"$\rho(\tau)$",
save_path: Path | str | None = None,
) -> None:
"""Plot autocorrelation function comparison.
Args:
real_acf: Mean ACF of reference trajectories [max_lag+1]
generated_acf: Mean ACF of generated trajectories [max_lag+1], or None to omit
lag_axis: Lag values in physical time units [max_lag+1]
real_acf_std: Optional std of reference ACF for shading
generated_acf_std: Optional std of generated ACF for shading
analytic_acf: Optional analytic ACF curve [max_lag+1]
reference_label: Label for reference curve
generated_label: Label for generated curve
analytic_label: Label for analytic curve
xlabel: X-axis label
ylabel: Y-axis label
save_path: Path to save figure (without extension)
"""
fig, ax = plt.subplots(1, 1, figsize=(5, 3.2))
ax.plot(lag_axis, real_acf, color=REFERENCE_COLOUR, linewidth=1.5, label=reference_label)
if real_acf_std is not None:
ax.fill_between(
lag_axis,
real_acf - real_acf_std,
real_acf + real_acf_std,
color=REFERENCE_COLOUR,
alpha=0.25,
)
if generated_acf is not None:
ax.plot(
lag_axis, generated_acf, color=GENERATED_COLOUR, linewidth=1.5, label=generated_label
)
if generated_acf_std is not None:
ax.fill_between(
lag_axis,
generated_acf - generated_acf_std,
generated_acf + generated_acf_std,
color=GENERATED_COLOUR,
alpha=0.25,
)
if analytic_acf is not None:
ax.plot(
lag_axis,
analytic_acf,
color=ANALYTIC_COLOUR,
linewidth=1.2,
linestyle="--",
label=analytic_label,
)
ax.axhline(0, color="black", linewidth=0.6, linestyle=":")
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
ax.set_xlim(lag_axis[0], lag_axis[-1])
ax.legend(frameon=False, loc="upper right")
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
def plot_psd_comparison(
freqs: np.ndarray,
real_psd: np.ndarray,
generated_psd: np.ndarray | None,
reference_label: str = "Reference",
generated_label: str = "Generated",
xlabel: str = "Frequency",
ylabel: str = "PSD",
log_scale: bool = True,
freq_limit: float | None = None,
reference_freq: float | None = None,
save_path: Path | str | None = None,
) -> None:
"""Plot power spectral density comparison.
Args:
freqs: Frequency array [n_freq]
real_psd: Mean PSD of reference trajectories [n_freq]
generated_psd: Mean PSD of generated trajectories [n_freq], or None to omit
reference_label: Label for reference curve
generated_label: Label for generated curve
xlabel: X-axis label
ylabel: Y-axis label
log_scale: If True, use log scale on y-axis
freq_limit: Optional upper frequency limit for x-axis
reference_freq: Optional vertical dashed line at a known drive frequency
save_path: Path to save figure (without extension)
"""
fig, ax = plt.subplots(1, 1, figsize=(5, 3.2))
mask = freqs > 0 # Exclude DC component
if freq_limit is not None:
mask = mask & (freqs <= freq_limit)
ax.plot(
freqs[mask], real_psd[mask], color=REFERENCE_COLOUR, linewidth=1.5, label=reference_label
)
if generated_psd is not None:
ax.plot(
freqs[mask],
generated_psd[mask],
color=GENERATED_COLOUR,
linewidth=1.5,
label=generated_label,
)
if reference_freq is not None:
ax.axvline(
reference_freq,
color=ANALYTIC_COLOUR,
linewidth=1.0,
linestyle="--",
label="Drive freq.",
alpha=0.7,
)
if log_scale:
ax.set_yscale("log")
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
ax.legend(frameon=False, loc="upper right")
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
def plot_marginal_distribution(
real: np.ndarray | torch.Tensor,
generated: np.ndarray | torch.Tensor | None,
reference_label: str = "Reference",
generated_label: str = "Generated",
analytic_label: str = "Analytic",
xlabel: str = "Value",
n_bins: int = 80,
tail_fraction: float = 0.5,
analytic_pdf: tuple[np.ndarray, np.ndarray] | None = None,
save_path: Path | str | None = None,
) -> None:
"""Plot marginal distribution comparison as overlaid histograms.
Pools the stationary tail of all trajectories and overlays normalised
histograms for reference and generated data.
Args:
real: Reference trajectories [n_traj, n_timesteps] or flat array
generated: Generated trajectories [n_traj, n_timesteps] or flat array, or None to omit
reference_label: Label for reference histogram
generated_label: Label for generated histogram
analytic_label: Label for analytic PDF curve
xlabel: X-axis label
n_bins: Number of histogram bins
tail_fraction: Fraction of each trajectory to use (last portion)
analytic_pdf: Optional (x, pdf) tuple to overlay as a dashed analytic curve
save_path: Path to save figure (without extension)
"""
def _extract_tail(data: np.ndarray | torch.Tensor, frac: float) -> np.ndarray:
if isinstance(data, torch.Tensor):
data = data.detach().cpu().numpy()
if data.ndim == 2:
n_tail = max(1, int(data.shape[1] * frac))
data = data[:, -n_tail:]
return data.flatten()
real_vals = _extract_tail(real, tail_fraction)
if generated is not None:
gen_vals = _extract_tail(generated, tail_fraction)
all_vals = np.concatenate([real_vals, gen_vals])
else:
gen_vals = None
all_vals = real_vals
bin_edges = np.linspace(all_vals.min(), all_vals.max(), n_bins + 1)
fig, ax = plt.subplots(1, 1, figsize=(5, 3.2))
ax.hist(
real_vals,
bins=bin_edges,
density=True,
color=REFERENCE_COLOUR,
alpha=0.55,
label=reference_label,
)
if gen_vals is not None:
ax.hist(
gen_vals,
bins=bin_edges,
density=True,
color=GENERATED_COLOUR,
alpha=0.55,
label=generated_label,
)
if analytic_pdf is not None:
x_analytic, pdf_analytic = analytic_pdf
ax.plot(
x_analytic,
pdf_analytic,
color=ANALYTIC_COLOUR,
linewidth=1.4,
linestyle="--",
label=analytic_label,
)
ax.set_xlabel(xlabel)
ax.set_ylabel("Density")
ax.legend(frameon=False, loc="upper right")
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
def plot_combined_statistics(
real: np.ndarray | torch.Tensor,
generated: np.ndarray | torch.Tensor | None,
real_acf: np.ndarray,
lag_axis: np.ndarray,
generated_acf: np.ndarray | None = None,
real_acf_std: np.ndarray | None = None,
generated_acf_std: np.ndarray | None = None,
analytic_acf: np.ndarray | None = None,
reference_label: str = "Reference",
generated_label: str = "Generated",
analytic_label: str = "Analytic",
xlabel_marginal: str = r"$x$",
xlabel_acf: str = r"Lag $\tau$",
ylabel_acf: str = r"$C(\tau)/C(0)$",
tail_fraction: float = 0.5,
n_bins: int = 80,
analytic_pdf: tuple[np.ndarray, np.ndarray] | None = None,
title: str | None = None,
save_path: Path | str | None = None,
) -> None:
"""Plot combined marginal distribution and autocorrelation comparison.
Creates a single figure with two panels:
- Left: stationary marginal distribution :math:`p_{\\rm ss}(x)` as
overlaid normalised histograms
- Right: normalised autocorrelation :math:`C(\\tau)/C(0)` with per-sample
±1σ shading
Args:
real: Reference trajectories [n_traj, n_timesteps]
generated: Generated trajectories [n_traj, n_timesteps], or None
real_acf: Mean ACF of reference [max_lag+1]
lag_axis: Lag values in physical time units [max_lag+1]
generated_acf: Mean ACF of generated [max_lag+1], or None
real_acf_std: Per-traj std of reference ACF for shading
generated_acf_std: Per-traj std of generated ACF for shading
analytic_acf: Optional analytic ACF curve [max_lag+1]
reference_label: Legend label for reference data
generated_label: Legend label for generated data
analytic_label: Legend label for analytic curves
xlabel_marginal: X-axis label for the marginal-distribution panel
xlabel_acf: X-axis label for the ACF panel
ylabel_acf: Y-axis label for the ACF panel
tail_fraction: Fraction of each trajectory treated as stationary
n_bins: Number of histogram bins
analytic_pdf: Optional (x, pdf) tuple to overlay as a dashed curve
title: Optional overall figure title
save_path: Path to save figure (without extension)
"""
def _extract_tail(data: np.ndarray | torch.Tensor, frac: float) -> np.ndarray:
if isinstance(data, torch.Tensor):
data = data.detach().cpu().numpy()
if data.ndim == 2:
n_tail = max(1, int(data.shape[1] * frac))
data = data[:, -n_tail:]
return data.flatten()
real_vals = _extract_tail(real, tail_fraction)
if generated is not None:
gen_vals = _extract_tail(generated, tail_fraction)
all_vals = np.concatenate([real_vals, gen_vals])
else:
gen_vals = None
all_vals = real_vals
fig, (ax_marg, ax_acf) = plt.subplots(1, 2, figsize=(10, 3.5))
# ---- Left panel: marginal distribution ----
bin_edges = np.linspace(all_vals.min(), all_vals.max(), n_bins + 1)
ax_marg.hist(
real_vals,
bins=bin_edges,
density=True,
color=REFERENCE_COLOUR,
alpha=0.55,
label=reference_label,
)
if gen_vals is not None:
ax_marg.hist(
gen_vals,
bins=bin_edges,
density=True,
color=GENERATED_COLOUR,
alpha=0.55,
label=generated_label,
)
if analytic_pdf is not None:
x_pdf, pdf_pdf = analytic_pdf
ax_marg.plot(
x_pdf,
pdf_pdf,
color=ANALYTIC_COLOUR,
linewidth=1.2,
linestyle="--",
label=analytic_label,
)
ax_marg.set_xlabel(xlabel_marginal)
ax_marg.set_ylabel("Density")
ax_marg.legend(frameon=False, loc="upper right")
clean_axes(ax_marg)
# ---- Right panel: autocorrelation ----
ax_acf.plot(lag_axis, real_acf, color=REFERENCE_COLOUR, linewidth=1.5, label=reference_label)
if real_acf_std is not None:
ax_acf.fill_between(
lag_axis,
real_acf - real_acf_std,
real_acf + real_acf_std,
color=REFERENCE_COLOUR,
alpha=0.25,
)
if generated_acf is not None:
ax_acf.plot(
lag_axis,
generated_acf,
color=GENERATED_COLOUR,
linewidth=1.5,
label=generated_label,
)
if generated_acf_std is not None:
ax_acf.fill_between(
lag_axis,
generated_acf - generated_acf_std,
generated_acf + generated_acf_std,
color=GENERATED_COLOUR,
alpha=0.25,
)
if analytic_acf is not None:
ax_acf.plot(
lag_axis,
analytic_acf,
color=ANALYTIC_COLOUR,
linewidth=1.2,
linestyle="--",
label=analytic_label,
)
ax_acf.axhline(0, color="black", linewidth=0.6, linestyle=":")
ax_acf.set_xlabel(xlabel_acf)
ax_acf.set_ylabel(ylabel_acf)
ax_acf.set_xlim(lag_axis[0], lag_axis[-1])
ax_acf.legend(frameon=False, loc="upper right")
clean_axes(ax_acf)
if title is not None:
fig.suptitle(title, fontsize=11)
plt.tight_layout()
save_figure(fig, save_path)
def plot_loss_curve(
losses: Sequence[float],
val_losses: Sequence[float] | None = None,
xlabel: str = "Epoch",
ylabel: str = "Loss",
save_path: Path | str | None = None,
) -> None:
"""Plot training loss curve with optional validation loss.
Args:
losses: List of training loss values per epoch
val_losses: Optional list of validation loss values per epoch
xlabel: X-axis label
ylabel: Y-axis label
save_path: Path to save figure (without extension)
"""
fig, ax = plt.subplots(1, 1, figsize=(4, 3))
epochs = np.arange(1, len(losses) + 1)
ax.plot(epochs, losses, color=REFERENCE_COLOUR, linewidth=1, label="Train")
if val_losses is not None and len(val_losses) > 0:
val_epochs = np.arange(1, len(val_losses) + 1)
ax.plot(val_epochs, val_losses, color=GENERATED_COLOUR, linewidth=1, label="Val")
ax.legend(frameon=False, loc="upper right")
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
ax.set_xlim(1, len(losses))
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
def plot_phase_space(
trajectories: np.ndarray,
trajectories_2: np.ndarray | None = None,
n_samples: int = 10,
xlabel: str = r"$q$",
ylabel: str = r"$v$",
label_1: str = "Reference",
label_2: str = "Generated",
x_idx: int = 0,
y_idx: int = 1,
save_path: Path | str | None = None,
) -> None:
"""Plot phase space trajectories.
Args:
trajectories: First set of trajectories [n_trajectories, n_steps, n_dim]
trajectories_2: Optional second set for comparison
n_samples: Number of trajectories to plot
xlabel: X-axis label
ylabel: Y-axis label
label_1: Label for first set
label_2: Label for second set
x_idx: Index of x-coordinate in state vector
y_idx: Index of y-coordinate in state vector
save_path: Path to save figure (without extension)
"""
trajectories = _to_numpy(trajectories)
if trajectories_2 is not None:
trajectories_2 = _to_numpy(trajectories_2)
if trajectories_2 is None:
# Single subplot
fig, ax = plt.subplots(1, 1, figsize=(4, 4))
for i in range(min(n_samples, len(trajectories))):
x = trajectories[i, :, x_idx]
y = trajectories[i, :, y_idx]
ax.plot(x, y, alpha=0.6, linewidth=0.5, color=REFERENCE_COLOUR)
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
clean_axes(ax)
else:
# Two subplots
fig, axes = plt.subplots(1, 2, figsize=(8, 4))
ax = axes[0]
for i in range(min(n_samples, len(trajectories))):
x = trajectories[i, :, x_idx]
y = trajectories[i, :, y_idx]
ax.plot(x, y, alpha=0.6, linewidth=0.5, color=REFERENCE_COLOUR)
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
clean_axes(ax)
ax = axes[1]
for i in range(min(n_samples, len(trajectories_2))):
x = trajectories_2[i, :, x_idx]
y = trajectories_2[i, :, y_idx]
ax.plot(x, y, alpha=0.6, linewidth=0.5, color=GENERATED_COLOUR)
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
clean_axes(ax)
plt.tight_layout()
save_figure(fig, save_path)
|