Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Yuhsuan/2015 scripting set channels #2184

Merged
merged 3 commits into from
Jun 11, 2023

Conversation

YuHsuan-Hwang
Copy link
Collaborator

@YuHsuan-Hwang YuHsuan-Hwang commented Jun 5, 2023

Description

Closes #2015 by adding new methods setChannel, setStokes, and setStokesByIndex.

  • The usage is documented in the codebase. I tried to clarify the usage with two terms:
    Polarization: corresponds to the options in the animator UI.
    image
    Stokes: defined as polarization index for standard polarization and polarization value for computed polarization. Used in protobuf messages.
  • Refactored code to use the new added methods.
  • setStokes is not used in frontend, so I noted “required for carta-python” to prevent deleting it.

Checklist

For linked issues (if there are):

  • assignee and label added
  • ZenHub issue connection, board status, and estimate updated

For the pull request:

  • reviewers and assignee added
  • ZenHub estimate, milestone, and release (if needed) added
  • e2e test passing / corresponding fix added
  • changelog updated / no changelog update needed
  • protobuf updated to the latest dev commit / no protobuf update needed
  • BackendService unchanged / BackendService changed and corresponding ICD test fix added

Copy link
Collaborator

@confluence confluence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks sensible to me. I will make a carta-python issue for updating the wrapper code to use this once it is merged.

Copy link
Collaborator

@kswang1029 kswang1029 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manual tests are fine as far as I can tell. No regression from e2e tests.

@kswang1029 kswang1029 merged commit f901501 into dev Jun 11, 2023
@kswang1029 kswang1029 deleted the yuhsuan/2015_scripting_set_channels branch June 11, 2023 13:33
@kswang1029
Copy link
Collaborator

@confluence i have merged in this for the python scripting interface.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scripting support: separate, consistent actions for changing the channel and polarization
4 participants