scitex 2.1.3__py3-none-any.whl → 2.4.0__py3-none-any.whl

scitex/vis/model/styles.py

@@ -0,0 +1,246 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# File: ./src/scitex/vis/model/styles.py
+"""
+Style dataclasses for scitex.vis objects.
+
+Separating style properties from data makes:
+- UI property panels easy to auto-generate
+- Style copy/paste straightforward
+- Batch style application simple
+"""
+
+from typing import Optional, Dict, Any
+from dataclasses import dataclass, field, asdict
+
+
+@dataclass
+class PlotStyle:
+    """Style properties for plots."""
+
+    # Color and transparency
+    color: Optional[str] = None
+    alpha: Optional[float] = None
+
+    # Line properties
+    linewidth: Optional[float] = None
+    linestyle: Optional[str] = None
+
+    # Marker properties
+    marker: Optional[str] = None
+    markersize: Optional[float] = None
+
+    # Fill properties (for fill_between, etc.)
+    fill_color: Optional[str] = None
+    fill_alpha: Optional[float] = None
+
+    # Heatmap/image properties
+    cmap: Optional[str] = None
+    vmin: Optional[float] = None
+    vmax: Optional[float] = None
+    interpolation: Optional[str] = None
+
+    # Error bar properties
+    capsize: Optional[float] = None
+    xerr: Optional[float] = None
+    yerr: Optional[float] = None
+
+    # Bar properties
+    width: Optional[float] = None
+
+    # Histogram properties
+    bins: Optional[int] = None
+    density: bool = False
+    cumulative: bool = False
+
+    # Layering
+    zorder: Optional[int] = None
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary, omitting None values."""
+        return {k: v for k, v in asdict(self).items() if v is not None}
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "PlotStyle":
+        """Create from dictionary."""
+        return cls(**{k: v for k, v in data.items() if k in cls.__annotations__})
+
+
+@dataclass
+class AxesStyle:
+    """Style properties for axes."""
+
+    # Background
+    facecolor: Optional[str] = None
+
+    # Grid
+    grid: bool = False
+    grid_alpha: Optional[float] = 0.3
+    grid_linestyle: Optional[str] = "--"
+    grid_linewidth: Optional[float] = 0.5
+
+    # Spines visibility
+    spines_visible: Dict[str, bool] = field(
+        default_factory=lambda: {
+            "top": True,
+            "right": True,
+            "bottom": True,
+            "left": True,
+        }
+    )
+
+    # Font sizes
+    label_fontsize: Optional[float] = None
+    title_fontsize: Optional[float] = None
+    tick_fontsize: Optional[float] = None
+
+    # Legend
+    legend: bool = False
+    legend_loc: str = "best"
+    legend_fontsize: Optional[float] = None
+    legend_frameon: bool = True
+
+    # Aspect
+    aspect: Optional[str] = None  # "auto", "equal", or numeric
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary."""
+        return asdict(self)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "AxesStyle":
+        """Create from dictionary."""
+        return cls(**{k: v for k, v in data.items() if k in cls.__annotations__})
+
+
+@dataclass
+class GuideStyle:
+    """Style properties for guides (reference lines/spans)."""
+
+    color: Optional[str] = None
+    alpha: Optional[float] = None
+    linestyle: Optional[str] = "--"
+    linewidth: Optional[float] = None
+    zorder: Optional[int] = None
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary, omitting None values."""
+        return {k: v for k, v in asdict(self).items() if v is not None}
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "GuideStyle":
+        """Create from dictionary."""
+        return cls(**{k: v for k, v in data.items() if k in cls.__annotations__})
+
+
+@dataclass
+class TextStyle:
+    """Style properties for text/annotations."""
+
+    fontsize: Optional[float] = None
+    fontweight: Optional[str] = None  # "normal", "bold"
+    color: Optional[str] = None
+    ha: str = "center"  # Horizontal alignment
+    va: str = "center"  # Vertical alignment
+    rotation: Optional[float] = None
+    zorder: Optional[int] = None
+
+    # Bounding box (for text background)
+    bbox: Optional[Dict[str, Any]] = None
+
+    # Arrow properties (for annotate)
+    arrowprops: Optional[Dict[str, Any]] = None
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary, omitting None values."""
+        return {k: v for k, v in asdict(self).items() if v is not None}
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "TextStyle":
+        """Create from dictionary."""
+        return cls(**{k: v for k, v in data.items() if k in cls.__annotations__})
+
+
+# ============================================================================
+# Style Copy/Paste Helpers
+# ============================================================================
+
+
+def copy_plot_style(src_plot, dst_plot) -> None:
+    """
+    Copy style from one plot to another.
+
+    Parameters
+    ----------
+    src_plot : PlotModel
+        Source plot
+    dst_plot : PlotModel
+        Destination plot
+    """
+    dst_plot.style = PlotStyle.from_dict(src_plot.style.to_dict())
+
+
+def copy_axes_style(src_axes, dst_axes) -> None:
+    """
+    Copy style from one axes to another.
+
+    Parameters
+    ----------
+    src_axes : AxesModel
+        Source axes
+    dst_axes : AxesModel
+        Destination axes
+    """
+    dst_axes.style = AxesStyle.from_dict(src_axes.style.to_dict())
+
+
+def copy_guide_style(src_guide, dst_guide) -> None:
+    """
+    Copy style from one guide to another.
+
+    Parameters
+    ----------
+    src_guide : GuideModel
+        Source guide
+    dst_guide : GuideModel
+        Destination guide
+    """
+    dst_guide.style = GuideStyle.from_dict(src_guide.style.to_dict())
+
+
+def copy_text_style(src_annotation, dst_annotation) -> None:
+    """
+    Copy style from one annotation to another.
+
+    Parameters
+    ----------
+    src_annotation : AnnotationModel
+        Source annotation
+    dst_annotation : AnnotationModel
+        Destination annotation
+    """
+    dst_annotation.style = TextStyle.from_dict(src_annotation.style.to_dict())
+
+
+def apply_style_to_plots(style: PlotStyle, plots: list) -> None:
+    """
+    Apply the same style to multiple plots.
+
+    Parameters
+    ----------
+    style : PlotStyle
+        Style to apply
+    plots : list
+        List of PlotModel objects
+
+    Examples
+    --------
+    >>> blue_style = PlotStyle(color="blue", linewidth=2, alpha=0.8)
+    >>> apply_style_to_plots(blue_style, my_plots)
+    """
+    style_dict = style.to_dict()
+    for plot in plots:
+        plot.style = PlotStyle.from_dict(style_dict)
+
+
+# EOF

scitex/vis/tmp.txt

@@ -0,0 +1,239 @@
+ざっと構造レベルで見た限り、かなりきれいにまとまってます。
+「JSON ⇔ dataclass モデル ⇔ matplotlib (scitex.plt)」の三層がちゃんと分離されていて、将来の拡張もしやすそうです。
+
+20251121_105809-vis
+
+1. 全体の構成について
+
+scitex.vis パッケージ構造
+
+model/（Figure/Axes/Plot/Guide/Annotation + Style）
+
+backend/（parser, render, export）
+
+io/（project ディレクトリ構造との橋渡し）
+
+utils/（validate + journal テンプレート）
+
+__init__.py で
+
+FigureModel, AxesModel, PlotModel, GuideModel, AnnotationModel
+
+build_figure_from_json, export_figure 系
+
+get_template, list_templates, NATURE_SINGLE_COLUMN_MM など
+が top-level に綺麗にエクスポートされていて、
+import scitex as stx; stx.vis.xxx で使える API としては十分わかりやすいです。
+
+設計としては「論文図用の JSON DSL」として、もう “モジュールとして完成” しているレベルだと思います。
+
+2. backend 周りの確認ポイント
+2-1. validate_figure_json
+from ..utils import validate_json_structure, validate_axes_layout
+
+validate_json_structure(fig_json)
+fig_model = parse_figure_json(fig_json)
+fig_model.validate()
+validate_axes_layout(...)
+
+
+粗い JSON チェック → dataclass 化 → モデルの validate → レイアウト整合性
+というパイプラインになっていて、エントリポイントとしてとても良いです。
+
+io.load_figure_json(validate=True) からもこれを呼び出していて、
+「ファイル読み込み＝即 validation」になっているのも、SciTeX 全体の哲学と合っていると思います。
+
+2-2. render_figure / mm 制御
+
+width_mm, height_mm をインチに変換して stx.plt.subplots(...) に渡し、
+
+その上で nrows, ncols, dpi などを統一的に指定。
+
+ここはすでに「mm ベースの figure サイズ」は担保済みなので、
+後から left_mm などを stx.plt.subplots() の引数にマップするだけで、
+“完全 mm 制御” にアップグレードできます（TODO コメントも書いてあって良いです）。
+
+3. Axes / Plot / Guide / Annotation + Style
+
+backend.render から見える前提は：
+
+AxesModel に style: AxesStyle
+
+PlotModel に style: PlotStyle
+
+GuideModel に style: GuideStyle
+
+AnnotationModel に style: TextStyle
+
+があり、style.to_dict() で matplotlib に渡す kwargs を生成、という設計になっています。
+
+style = axes_model.style
+...
+if style.grid:
+    ax.grid(alpha=style.grid_alpha, ...)
+...
+if style.legend:
+    ax.legend(loc=style.legend_loc, ...)
+
+style_dict = plot_model.style.to_dict()
+...
+kwargs = {k: v for k, v in style_dict.items() if k in relevant_keys}
+
+kwargs = guide_model.style.to_dict()
+...
+kwargs = annotation_model.style.to_dict()
+
+3-1. モデル側で確認したいこと
+
+コード全体が長く、該当ファイルが途中でトランケートされているので推測も入りますが、
+最低限、次が守られているかだけ一度ローカルで確認しておくと安心です：
+
+各 Model に style フィールドが定義されていること
+
+AxesModel(style: AxesStyle = AxesStyle()) のような形
+
+PlotModel, GuideModel, AnnotationModel も同様
+
+.from_dict() が style を正しく復元していること
+
+例：
+
+@classmethod
+def from_dict(cls, data: Dict[str, Any]) -> "PlotModel":
+    style_data = data.pop("style", {})
+    obj = cls(**data)
+    obj.style = PlotStyle.from_dict(style_data)  # など
+    return obj
+
+
+こうしておかないと、JSON → Model の round-trip で style がただの dict のままになってしまいます。
+
+validate() が style に依存するフィールドにアクセスしていないこと
+
+たとえば旧実装では Annotation で self.ha, self.va を直接見ていましたが、
+これを style.ha, style.va に移しているなら、validate() も必ず style 経由に統一する必要があります。
+
+4. plot_type の網羅性（小さめの仕様ギャップ）
+
+PlotModel.validate() 側では、かなり多くの plot_type を許容しているはずです（line, scatter, bar, barh, hist, errorbar, fill_between, heatmap, imshow, contour, contourf, box, violin, step, stem など）。
+一方で render_plot() の本体は、現状だと line / scatter / errorbar / bar / barh / hist / fill_between / heatmap / imshow / contour / contourf までしか実装されていません。
+
+20251121_105809-vis
+
+結果として：
+
+plot_type="box" や "violin" を JSON では許容しているのに、
+
+実際に render_plot すると Unsupported plot type になります。
+
+提案
+
+どちらかに寄せる：
+
+(A) 先に実装する plot_type だけ validate() で許可する
+
+MVP の段階では line / scatter / bar / barh / hist / errorbar / heatmap / imshow / contour / contourf / fill_between に限定
+
+(B) box, violin, step, stem も最低限の実装を書く
+
+例えば：
+
+box: ax.boxplot(...)
+
+violin: ax.violinplot(...)
+
+step: ax.step(...)
+
+stem: ax.stem(...)
+
+MVP を急ぐなら (A) で一旦締めてしまって、
+Sigma UI 側のメニューからも「未実装タイプ」は隠すのが UX 的にも安全だと思います。
+
+5. I/O & プロジェクト構造
+
+io.load_figure_json_from_project / save_figure_json_to_project は
+
+project_dir/scitex/vis/figs/{figure_id}.json
+
+
+という構造で統一されていて、以前話していた project-dir/scitex/vis/figs にきちんと揃っています。
+
+20251121_105809-vis
+
+これは /vis/sigma/ フロントエンドとかなり綺麗につながる形になっていて、
+
+UI 側：Figure ツリーの編集 → JSON
+
+Django API：JSON を scitex.vis.io.save_figure_json_to_project(...) で保存
+
+解析/論文側：scitex.vis.backend.export_figure(...) or build_figure_from_json(...) で再利用
+
+というフローが素直に組めます。
+
+6. テストとしてやっておくといいこと
+
+ローカルで、次の 2〜3 個だけ回しておけば、かなり安心できると思います：
+
+最小構成 + line plot
+
+import scitex as stx
+import numpy as np
+
+fig_json = stx.vis.utils.get_template("nature_single", height_mm=100)
+fig_json["axes"] = [{
+    "row": 0,
+    "col": 0,
+    "xlabel": "X",
+    "ylabel": "Y",
+    "title": "Demo",
+    "plots": [{
+        "plot_type": "line",
+        "data": {
+            "x": list(range(10)),
+            "y": [i*i for i in range(10)],
+        },
+        # style はデフォルトに任せる or 最小限指定
+    }],
+    "annotations": [],
+    "guides": [],
+    # style は AxesStyle のデフォルト
+}]
+
+stx.vis.backend.validate_figure_json(fig_json)
+fig, axes = stx.vis.backend.build_figure_from_json(fig_json)
+stx.io.save(fig, "test.png", dpi=300)
+
+
+project round-trip
+
+stx.vis.io.save_figure_json_to_project("/tmp/proj", "fig-001", fig_json)
+loaded = stx.vis.io.load_figure_json_from_project("/tmp/proj", "fig-001")
+stx.vis.backend.validate_figure_json(loaded)
+
+
+存在しない plot_type でちゃんとエラーになるか
+
+plot_type="unknown" にして render_plot 実行 → ValueError になるか確認
+
+7. 結論
+
+モジュール構造・API 形状・mm ベース設計・project 連携まで含めて、
+「論文図用のバックエンド」としてかなり完成度が高いです。
+
+いま見えている主なタスクは：
+
+style dataclass と Model の整合性（style フィールドの from_dict/to_dict/validate）
+
+plot_type の実装範囲と validate() の整合性
+
+mm-based spacing を stx.plt.subplots にどう渡すか（これは TODO でも問題なし）
+
+ここまで出来ていれば、/vis/sigma/ からは
+
+JSON を組み立てて
+
+save_figure_json_to_project で保存し
+
+裏で export_figure を叩いて PNG を生成
+
+という「世界一まともな論文図パイプライン」の中核は、もう出来ていると言って良いと思います。

scitex/vis/utils/__init__.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# File: ./src/scitex/vis/utils/__init__.py
+"""
+Utilities for scitex.vis.
+
+Includes validation functions and default templates for
+common publication formats.
+"""
+
+from .validate import (
+    validate_json_structure,
+    validate_plot_data,
+    check_schema_version,
+    validate_color,
+    validate_axes_layout,
+)
+
+from .defaults import (
+    # Constants
+    NATURE_SINGLE_COLUMN_MM,
+    NATURE_DOUBLE_COLUMN_MM,
+    NATURE_FULL_PAGE_MM,
+    SCIENCE_SINGLE_COLUMN_MM,
+    SCIENCE_DOUBLE_COLUMN_MM,
+    CELL_SINGLE_COLUMN_MM,
+    CELL_DOUBLE_COLUMN_MM,
+    PNAS_SINGLE_COLUMN_MM,
+    PNAS_DOUBLE_COLUMN_MM,
+    A4_WIDTH_MM,
+    A4_HEIGHT_MM,
+    # Template functions
+    get_nature_single_column,
+    get_nature_double_column,
+    get_science_single_column,
+    get_a4_figure,
+    get_square_figure,
+    get_presentation_slide,
+    get_template,
+    list_templates,
+    TEMPLATES,
+)
+
+__all__ = [
+    # Validation
+    "validate_json_structure",
+    "validate_plot_data",
+    "check_schema_version",
+    "validate_color",
+    "validate_axes_layout",
+    # Constants
+    "NATURE_SINGLE_COLUMN_MM",
+    "NATURE_DOUBLE_COLUMN_MM",
+    "NATURE_FULL_PAGE_MM",
+    "SCIENCE_SINGLE_COLUMN_MM",
+    "SCIENCE_DOUBLE_COLUMN_MM",
+    "CELL_SINGLE_COLUMN_MM",
+    "CELL_DOUBLE_COLUMN_MM",
+    "PNAS_SINGLE_COLUMN_MM",
+    "PNAS_DOUBLE_COLUMN_MM",
+    "A4_WIDTH_MM",
+    "A4_HEIGHT_MM",
+    # Templates
+    "get_nature_single_column",
+    "get_nature_double_column",
+    "get_science_single_column",
+    "get_a4_figure",
+    "get_square_figure",
+    "get_presentation_slide",
+    "get_template",
+    "list_templates",
+    "TEMPLATES",
+]
+
+# EOF