scverse / scverse/spatialdata-plot

Custom title when multiple coordinate system present and no coordinate system specified

Đang mở
#269 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

:speaking_head: discussion enhancement priority: medium
Ngôn ngữ chính
Python
Star
86
Fork
21
Merge trung bình
14 giờ 50 phút
Pull request đã merge (30 ngày)
3

Mô tả

When there is a object with 2 coordinate systems and pl.show() is called without specifying coordinate_systems, by default two subplots are created. If the user adjust the title=, both titles are changed, leading to a plot that is confusing, especially if it was not clear that the object (or an element of the object) was aligned to multiple coordinate systems.

This is exactly what happened in the following plots (that appeared from a bug reported by a user).

before setting the title

Screenshot 2024-05-30 at 11 55 06

after setting the title

not sure why the order changes but no big deal, not the point of this issue
Screenshot 2024-05-30 at 11 55 11

solution for this case

Solution for the user: here the fix is to specify coordinate_systems='global', which will lead to a single plot.

proposed solution

Discussed also with @melorona. I proposed to change the default behavior as follows:

  • coordinate_systems will have a new default of None.
  • if the object has a single coordinate system and coordinate_system is None, this will be plotted
  • elif the object has multiple coordinate system and coordinate_system is None and one of them is called 'global' (defined in from spatialdata.models._utils import DEFAULT_COORDINATE_SYSTEM), this will be plotted
  • if coordinate_system is not None and coordinate_system is available, this will be plotted
  • else (i.e. if coordinate_system is None, multiple coordinate systems are present and none of them is called 'global', or if coordinate_system is not None and it's not available in the data, then an error will be raised, printing the list of available coordinate systems.

What will change for the user:

  • with this change, by default we won't plot multiple coordinate systems; if this is still the desired behavior, the user can still pass a list of coordinate systems.

Extra comments:

  • with the incoming "transformations refactoring" it will be required to specify which coordinate system to plot because elements will not contain an explicit list of coordinate systems they are aligned to but there will only be a big graph of transformations where a lot of coordinate systems can be aligned to a lot of other coordinate systems. So it will be important to plot only what the user asks for
  • in general, the current default behavior is useful when there are multiple FOVs for a dataset (like in the MIBITOF example dataset); but in other cases where there is the same data in multiple coordinate systems, like in Xenium, or where the number of FOVs is very large, like in CosMx, the currently implemented default behavior is suboptimal, and requiring the proposed new default would be handier.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu từ điểm vào pl.show() và theo dõi cách các giá trị mặc định của coordinate_systems được chọn khi một đối tượng có một hoặc nhiều hệ tọa độ. Hoàn tất khi giá trị mặc định chọn hệ duy nhất hoặc hệ toàn cục, phát sinh lỗi kèm các hệ khả dụng khi không có giá trị mặc định hợp lệ, và vẫn cho phép bên gọi truyền một danh sách một cách rõ ràng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
data-visualization
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.