Add support for custom coordinate frames in WCSAxes specifically in transform_coord_meta_from_wcs by samaloney · Pull Request #16347 · astropy/astropy

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 [email protected].

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 !

astrofrog

This is looking good! Just one comment below.

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

+
+    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.

Given there's no way to stop someone editing the dictionary shouldn't we keep a test for it?

I'd vote against it; we shouldn't be testing for implementation details.

If the dictionary isn't meant to be accessed directly maybe we should make it private to make it explicit?

I removed it, I don't think we need to make it private

I do think there is utility in people directly accessing the dict if packages like sunpy write their own coordinate frames they could add to the dict without the context manager to improve the plotting of those frames.

astrofrog

Looking good! Just a few small comments.

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

+
+    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

+        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.

Patched in opt-in support for overwriting (with a kwarg)

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

+            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.

github-actions · 2024-10-12T05:41:23Z

Hi humans 👋 - this pull request hasn't had any new commits for approximately 4 months. I plan to close this in 30 days if the pull request doesn't have any new commits by then.

In lieu of a stalled pull request, please consider closing this and open an issue instead if a reminder is needed to revisit in the future. Maintainers may also choose to add keep-open label to keep this PR open but it is discouraged unless absolutely necessary.

If this PR still needs to be reviewed, as an author, you can rebase it to reset the clock.

If you believe I commented on this pull request incorrectly, please report this here.

Co-authored-by: Clément Robert <[email protected]>

neutrinoceros · 2024-10-24T13:34:36Z

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


I'd vote against it; we shouldn't be testing for implementation details.

astrofrog

This seems good overall but just a small note on the changelog entry - and in addition I though wcscoord in the context manager name was a bit strange, what about using custom_ucd_coord_meta_mapping as the context manager name?

astrofrog · 2024-10-25T21:06:31Z

@Cadair - I pushed the changes I suggested in case you agree with them

Cadair · 2024-10-25T21:07:28Z

Lgtm thanks

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

Comment thread astropy/visualization/wcsaxes/wcsapi.py Resolved

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 force-pushed the feat-wcsaxes-custom-ucd branch 3 times, most recently 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

astrofrog requested changes May 14, 2024

View reviewed changes

github-actions Bot added the Close? Tell stale bot that this issue/PR is stale label Oct 12, 2024

Shane Maloney and others added 8 commits October 24, 2024 12:43

Add support for custom frame in WCSAxes

2a4f011

Add test for custom frame

1f35664

Update astropy/visualization/wcsaxes/wcsapi.py

0beb675

Co-authored-by: Clément Robert <[email protected]>

Add change log

b584c7a

Fix changelog refs

2bd2f0e

Add context manager for custom coord mappings.

d7e2ac7

Add context manger for custom ctype to WCSAxes mappings.

248a88a

Add nested test

410c7b8

Cadair force-pushed the feat-wcsaxes-custom-ucd branch from 1fc34ce to 410c7b8 Compare October 24, 2024 12:00

Refactor a little and add overwrite support

b46f41f

Cadair requested a review from astrofrog October 24, 2024 12:29

Don't use standard meta if custom meta matches

e23a1d6

Cadair added 3 commits October 24, 2024 13:42

typo

60a99b2

Pull context manager up to the top level API

f2e8195

cleanup

b6d1076

Cadair removed the Close? Tell stale bot that this issue/PR is stale label Oct 24, 2024

neutrinoceros reviewed Oct 24, 2024

View reviewed changes

Cadair added 3 commits October 24, 2024 17:25

Add missing break

3cb6582

Remove direct dict test

c5770a7

Fix doctest

1f64d73

astrofrog requested changes Oct 24, 2024

View reviewed changes

Comment thread docs/changes/visualization/16347.feature.rst Resolved

Renamed context manager and updated changelog entry

802fa05

astrofrog approved these changes Oct 25, 2024

View reviewed changes

astrofrog enabled auto-merge October 25, 2024 21:08

astrofrog merged commit ec17075 into astropy:main Oct 25, 2024

neutrinoceros mentioned this pull request Feb 10, 2025

BUG: ensure custom_ucd_coord_meta_mapping context manager performs a (correct) cleanup #17749

Merged

1 task

Conversation

samaloney commented Apr 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions Bot commented Apr 26, 2024

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 26, 2024

Uh oh!

neutrinoceros left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

astrofrog left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astrofrog left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Oct 12, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astrofrog left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

astrofrog commented Oct 25, 2024

Uh oh!

Cadair commented Oct 25, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

samaloney commented Apr 26, 2024 •

edited

Loading