Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Remove `Session.array_transform` attribute (obsolete single-transducer-pose model)

オープン
#485 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
リファクタリング
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
python
領域
database

調査の方向性

src/openlifu/db/session.py から始めて、Session のシリアライゼーションを確認します。次に、examples/tutorials/02_Database_Interaction.py と対応する notebook における Session の構築を確認します。tests/test_database.py のデータベーステストを実行し、tests/resources/example_db/ にある legacy の array_transform データを確認します。現行の fixture と examples がそのフィールドを参照しなくなり、from_dict が引き続き legacy の sessions を読み込めれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Summary

Remove the array_transform: ArrayTransform field from openlifu.db.Session, along with its to_dict / from_dict handling, the associated docstring notes, and every reference in examples, tests, and test-resource JSON.

Motivation

Session.array_transform was designed around the assumption that a session has a single canonical "the transducer position." In SlicerOpenLIFU that assumption no longer holds:

  • Each page that renders the transducer (pre-planning, localization, solution) picks whichever of the persisted transforms it needs (a specific approved virtual-fit result, a specific approved transducer-tracking result, or -- on the localization page -- both simultaneously).
  • The full list of transducer transforms lives in session.virtual_fit_results and session.transducer_tracking_results, keyed by target / photoscan.
  • Approval invalidation is now driven per-VF and per-TT rather than by writing back a single pose.

As a result, SlicerOpenLIFU has stopped reading and writing session.array_transform (see the accompanying downstream PR). The field is now unused by the primary consumer and only serves to confuse the persistence model.

Scope of changes required in this repo

  • src/openlifu/db/session.py
    • Remove the array_transform field definition on Session.
    • Remove the corresponding to_dict / from_dict handling for array_transform.
    • Update the solution_id field docstring, which currently claims the id is "cleared whenever the array_transform changes." That invalidation policy needs to be reconsidered (probably driven by VF / TT approval changes on the consumer side); at minimum, drop the array_transform reference from the doc.
  • examples/tutorials/02_Database_Interaction.py and the matching .ipynb -- drop the array_transform=ArrayTransform(...) argument from the Session(...) construction.
  • tests/test_database.py -- remove assertions on session.array_transform.matrix.shape / .units and any loop variables named array_transform that come from the same fixture.
  • Test resource JSON files under tests/resources/example_db/ that carry an "array_transform" block -- either drop the block or regenerate the fixtures so they no longer contain it. from_dict should tolerate the field being absent, so old on-disk sessions still load cleanly.
  • Sample database (openlifu-sample-database repo) sessions currently carry an "array_transform" block too; that repo will need a matching sweep, but that is out of scope for this issue.

Backwards compatibility

Session.from_dict should silently ignore a legacy "array_transform" key so that existing on-disk sessions (including the pinned openlifu-sample-database fixtures) still load with the new library version.

Downstream

Coordinated with the SlicerOpenLIFU cleanup that decommissions the array_transform read/write path on the consumer side.

主要言語
Python
スター
29
フォーク
20
平均マージ
4時間 31分
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenwaterHealth/openlifu-python のほかの issue

OpenwaterHealth/openlifu-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。