scverse / scverse/spatialdata

Helper functions around the pixel size in units

Open
#436 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

method: transforms 🔃
Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

Currently we have the capabilities to compute the pixel to unit scale factor, but doing this is not straightforward due to edge cases that can arise with general coordinate transformations.

As requested by @QuentinBlampey and @berombau, I plan to implement two functions to help with this. Here are the signatures.

def pixel_size(raster: SpatialImage | MultiscaleSpatialImage, target_coordinate_system: str) -> float:
    pass

def change_pixel_size(
    raster: SpatialImage | MultiscaleSpatialImage, 
    target_coordinate_system: str, 
    new_pixel_size: float
) -> SpatialImage | MultiscaleSpatialImage:
    pass

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing pixel-to-unit scale-factor computation and reviewing how it handles general coordinate transformations. Use the two proposed signatures as the scope; done means both helpers work for SpatialImage and MultiscaleSpatialImage inputs, including the stated edge cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.