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

AI-generated: macsima() uses the OME plane positions as pixel padding widths, truncated

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
data

調査の方向性

src/spatialdata_io/readers/macsima.py の _get_translations() から始め、続いて MultiChannelImage._pad_images() と test_get_translations_returns_correct_values を読みます。readers/_utils/_utils.py にある既存の物理サイズの参照も確認します。maintainers または実際の MACSima データから、プレーンの位置がピクセルオフセットなのか物理的な長さなのかを確認し、そのうえで、選択した解釈と丸められたパディングの挙動を対象とする回帰テストまたはデータベースのテストを追加します。

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

説明

[!NOTE]
AI-generated issue, opened from #418 and not verified against real MACSima data. The
code pointers are accurate; the question at the end needs someone who knows what the
MACSima software writes into these fields.

What the code does

_get_translations() reads the position of the first plane of the OME metadata and turns it
into an integer — src/spatialdata_io/readers/macsima.py:

translations = {"translation_x": int(position_x), "translation_y": int(position_y)}

The values end up on ChannelMetadata.translation_x / translation_y and are consumed by
MultiChannelImage._pad_images(), which normalises them against their minimum and uses the
result directly as da.pad widths, i.e. as a number of pixels:

normalized_translations_x = [metadata.translation_x - min_translation_x for metadata in channel_metadata]
...
pad_width = ((0, 0), (pad_y_prepend, pad_y_append), (pad_x_prepend, pad_x_append))
img = da.pad(img, pad_width, mode="constant", constant_values=0)
Two things look off

1. int() truncates towards zero instead of rounding. int(0.9) == 0 and
int(-0.9) == 0, so a plane at x = 10.7 is placed at 10 and the direction of the error
depends on the sign of the position. After the normalisation against the minimum the residual
is below one pixel per channel, so this alone is minor — round() would halve the worst case
and make it sign-symmetric.

2. The positions are physical coordinates, but they are used as pixel counts. In OME,
Plane.position_x comes with a Plane.position_x_unit, and Pixels.physical_size_x gives the
size of a pixel in the same kind of unit (17.0 µm in the OMAP test data). Nothing in the
reader converts between the two, so if a MACSima file writes stage positions in micrometres the
padding is off by the pixel size — a factor of 17 for these datasets — rather than by a fraction
of a pixel. If instead the software writes pixel offsets there (position_x_unit is
REFERENCEFRAME, the OME default, i.e. unspecified, in the files I looked at), the current code
is right and only point 1 applies.

Both small test datasets (OMAP10_small, OMAP23_small) have position_x = None on every
plane, so _get_translations() returns (0, 0) there and this path is exercised by unit tests
only, never by the data-based ones.

What a fix would entail

Depending on the answer to "what unit does MACSima write":

  • if the positions are already in pixels: replace int(...) with round(...) in
    _get_translations() and extend test_get_translations_returns_correct_values with a
    fractional case (e.g. position_x=10.7, position_y=0.9 → {"translation_x": 11, "translation_y": 1});
  • if they are physical lengths: read position_x_unit / position_y_unit and
    Pixels.physical_size_x / physical_size_y alongside the positions, convert to pixels
    (ome_types exposes the unit enums; parse_physical_size() in
    readers/_utils/_utils.py already does this kind of lookup for the physical size), and round
    at the end. _get_translations() currently only receives the OME object, which is enough for
    both. ChannelMetadata.translation_x stays an int, so _pad_images() is unaffected.
  • either way, it would be good to have a data-based test: none of the datasets currently in CI
    has plane positions, so this would need either a file with real positions or a synthetic TIFF
    written with tifffile.imwrite(..., metadata={...}) in the style of
    test_images_with_invalid_ome_metadata_are_excluded.
Context

#418 originally rounded the positions as part of fixing the regressions from #411, but that
changes reader output on a point nobody has confirmed, so it was pulled out of the PR and filed
here instead. The current behaviour on main is unchanged: truncation.

主要言語
Python
スター
103
フォーク
65
平均マージ
1時間 8分
マージ済み PR(30日)
3

環境構築

はじめの一歩

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

scverse/spatialdata-io のほかの issue

scverse/spatialdata-io の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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