Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs #16347

samaloney · 2024-04-26T10:45:37Z

Description

This pull request adds support for externally created customs coordinate frames to WCSAxes by altering how transform_coord_meta_from_wcs operates.

Creating a new variable CUSTOM_UCD_COORD_META_MAPPING which could be extended by external packages.
Move existing custom frame to this new variable

If this approach is ok then the custom sunpy frame could be moved into the sunpy repo.

~~I didn't add a new test as while there is new code the current tests cover it I think.~~

In an external package I could register new CTYPE to UCD and UCD to coord meta data mappings.

MYFRAME_CTYPE_TO_UCD1 = {
    "SXLT": "custom:pos.myframe.lat",
    "SXLN": "custom:pos.myframe.lon",
    "SXRZ": "custom:pos.myframe.z"
}
astropy.wcs.wcsapi.fitswcs.CTYPE_TO_UCD1_CUSTOM.update(MYFRAME_CTYPE_TO_UCD1)


MYFAME_UCD_COORD_META_MAPPING = {
    "custom:pos.myframe.lon": {
        "coord_wrap": 180.0 * u.deg,
        "format_unit": u.arcsec,
        "coord_type": "longitude",
    },

astropy.visualization.wcsaxes.wcsapi.CUSTOM_UCD_COORD_META_MAPPING.update(MYFAME_UCD_COORD_META_MAPPING)

Fixes #16339

By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

github-actions · 2024-04-26T10:46:02Z

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

Do the proposed changes actually accomplish desired goals?
Do the proposed changes follow the Astropy coding guidelines?
Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

github-actions

Welcome to Astropy 👋 and congratulations on your first pull request! 🎉

A project member will respond to you as soon as possible; in the meantime, please have a look over the Checklist for Contributed Code and make sure you've addressed as many of the questions there as possible.

If you feel that this pull request has not been responded to in a timely manner, please send a message directly to the development mailing list. If the issue is urgent or sensitive in nature (e.g., a security vulnerability) please send an e-mail directly to the private e-mail feedback@astropy.org.

github-actions · 2024-04-26T10:48:01Z

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

neutrinoceros

Thank you for your contribution ! I'll leave it to wcsaxes maintainers to discuss whether this approach is acceptable or not, but here's a quick technical review.
Even though the code might be covered already, I believe a test would also be needed to demonstrate the new feature (and to make sure we don't break it in the future).
You'll also need to provide a change log entry (see docs/changes/README.md). Thanks !

astropy/visualization/wcsaxes/wcsapi.py

Co-authored-by: Clément Robert <cr52@protonmail.com>

astrofrog

This is looking good! Just one comment below.

astrofrog · 2024-05-13T21:45:30Z

astropy/visualization/wcsaxes/tests/test_wcsapi.py

+
+    astropy.visualization.wcsaxes.wcsapi.CUSTOM_UCD_COORD_META_MAPPING.update(
+        myframe_mapping
+    )


I think we should avoid having this be the API to register custom mappings, and instead write a context manager similar to custom_ctype_to_ucd_mapping to make sure the changes are temporary and cleaned up after use.

This would also have the benefit of allowing this functionality to be documented via the API docs even if we don't add something to the main narrative docs.

Great thanks for the feedback, I've taken a first crack at adding a context manager similar custom_ctype_to_ucd_mapping.

Thanks! I don't think we should keep the test of modifying the dictionary, we should just be testing the context manager.

astrofrog

Looking good! Just a few small comments.

astrofrog · 2024-05-14T20:18:12Z

astropy/visualization/wcsaxes/tests/test_wcsapi.py

+
+    astropy.visualization.wcsaxes.wcsapi.CUSTOM_UCD_COORD_META_MAPPING.update(
+        myframe_mapping
+    )


Thanks! I don't think we should keep the test of modifying the dictionary, we should just be testing the context manager.

astrofrog · 2024-05-14T20:21:54Z

astropy/visualization/wcsaxes/wcsapi.py

+        self.mapping = {}
+        for k, v in mapping.items():
+            if k in CUSTOM_UCD_COORD_META_MAPPING:
+                raise ValueError(f"UCD metadata mapping {k} already exists.")


Ideally we might want to allow existing entries to be overriden, but if this is too much work we could always keep as-is for now and consider it a future improvement to allow overriding.

astrofrog · 2024-05-14T20:22:31Z

astropy/visualization/wcsaxes/tests/test_wcsapi.py

+            ax.coords
+            assert ax.coords["eggs"].coord_type == "longitude"
+            assert ax.coords["eggs"].coord_wrap == 360 * u.deg
+            assert ax.coords["eggs"].get_format_unit() == u.arcsec


It would be good if possible to add a test of two nested custom_ucd_wcscoord_mapping calls to make sure both apply at the same time.

Add support for custom frame in WCSAxes

3460113

github-actions bot added the visualization.wcsaxes label Apr 26, 2024

github-actions bot reviewed Apr 26, 2024

View reviewed changes

neutrinoceros reviewed Apr 26, 2024

View reviewed changes

astropy/visualization/wcsaxes/wcsapi.py Show resolved Hide resolved

Add test for custom frame

4de3ccf

pllim added this to the v7.0.0 milestone Apr 26, 2024

samaloney changed the title ~~Add support for custom frames in WCSAxes specifically transform_coord_meta_from_wcs~~ Add support for custom coordinate frames in WCSAxes specifically transform_coord_meta_from_wcs Apr 26, 2024

samaloney changed the title ~~Add support for custom coordinate frames in WCSAxes specifically transform_coord_meta_from_wcs~~ Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs Apr 26, 2024

samaloney and others added 2 commits April 26, 2024 15:44

Update astropy/visualization/wcsaxes/wcsapi.py

716cddb

Co-authored-by: Clément Robert <cr52@protonmail.com>

Add change log

c0708b3

samaloney force-pushed the feat-wcsaxes-custom-ucd branch 2 times, most recently from a3b1be7 to c28b372 Compare April 27, 2024 15:58

Fix changelog refs

e326827

samaloney force-pushed the feat-wcsaxes-custom-ucd branch from c28b372 to e326827 Compare April 27, 2024 16:26

samaloney marked this pull request as ready for review May 6, 2024 20:16

samaloney requested review from astrofrog and larrybradley as code owners May 6, 2024 20:16

astrofrog requested changes May 13, 2024

View reviewed changes

samaloney added 2 commits May 14, 2024 16:37

Add context manager for custom coord mappings.

54afdde

Add context manger for custom ctype to WCSAxes mappings.

1fc34ce

astrofrog requested changes May 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs #16347

Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs #16347

samaloney commented Apr 26, 2024 •

edited

github-actions bot commented Apr 26, 2024

github-actions bot left a comment

github-actions bot commented Apr 26, 2024

neutrinoceros left a comment

astrofrog left a comment

astrofrog May 13, 2024

astrofrog May 13, 2024

samaloney May 14, 2024

astrofrog May 14, 2024

astrofrog left a comment

astrofrog May 14, 2024

astrofrog May 14, 2024

astrofrog May 14, 2024

Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs #16347

Are you sure you want to change the base?

Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs #16347

Conversation

samaloney commented Apr 26, 2024 • edited

Description

github-actions bot commented Apr 26, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 26, 2024

neutrinoceros left a comment

Choose a reason for hiding this comment

astrofrog left a comment

Choose a reason for hiding this comment

astrofrog May 13, 2024

Choose a reason for hiding this comment

astrofrog May 13, 2024

Choose a reason for hiding this comment

samaloney May 14, 2024

Choose a reason for hiding this comment

astrofrog May 14, 2024

Choose a reason for hiding this comment

astrofrog left a comment

Choose a reason for hiding this comment

astrofrog May 14, 2024

Choose a reason for hiding this comment

astrofrog May 14, 2024

Choose a reason for hiding this comment

astrofrog May 14, 2024

Choose a reason for hiding this comment

samaloney commented Apr 26, 2024 •

edited