Optic orientation fix #163
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Aug 29, 2024
e10harvey
requested changes
Oct 1, 2024
| @@ -649,6 +649,7 @@ def get_optic( | |||
| Optic object | |||
There was a problem hiding this comment.
Not directly related to these changes. Suggestion for doc string:
Returns
-------
FacetEnsemble if ProcessSofastFringe.optic_type = 'multi', otherwise Facet
| """Sets the positions of the facets relative to the ensemble. | ||
| NOTE: Will remove previously set facet canting rotations | ||
| """ |
There was a problem hiding this comment.
Suggested change
| """Sets the positions of the facets relative to the ensemble. | |
| NOTE: Will remove previously set facet canting rotations | |
| """ | |
| """ | |
| Set the positions of the facets relative to one another. | |
| This function updates the positions of the facets in the ensemble. | |
| It will remove any previously set facet canting rotations. | |
| Parameters | |
| ---------- | |
| positions : Pxyz | |
| A sequence of positions to set for each facet. The length of | |
| this sequence must match the number of facets in the ensemble. | |
| Raises | |
| ------ | |
| ValueError | |
| If the length of `positions` does not match the number of facets | |
| in the ensemble. | |
| Notes | |
| ----- | |
| This method modifies the internal transformation of each facet | |
| based on the provided positions. | |
| """ | |
| # "ChatGPT 4o-mini" assisted with generating this docstring. |
Comment on lines
208
to
228
| """Sets facet canting relative to ensemble. | ||
| NOTE: Will remove previously set facet positionals | ||
| """ |
There was a problem hiding this comment.
Suggested change
| """Sets facet canting relative to ensemble. | |
| NOTE: Will remove previously set facet positionals | |
| """ | |
| """ | |
| Set the canting rotations of the facets relative to the ensemble. | |
| This function updates the canting rotations of the facets in the | |
| ensemble. It will remove any previously set facet positional | |
| transformations. | |
| Parameters | |
| ---------- | |
| canting_rotations : list[Rotation] | |
| A list of rotation objects to set for each facet. The length | |
| of this list must match the number of facets in the ensemble. | |
| Raises | |
| ------ | |
| ValueError | |
| If the length of `canting_rotations` does not match the number | |
| of facets in the ensemble. | |
| Notes | |
| ----- | |
| This method modifies the internal transformation of each facet | |
| based on the provided canting rotations and their corresponding | |
| positions. | |
| """ | |
| # "ChatGPT 4o-mini" assisted with generating this docstring. |
There was a problem hiding this comment.
@e10harvey, thanks for looking at this. I updated the documentation as per your suggestions.
And to answer your other question, it doesn't look like OpticOrientationAbstract is explicitly tested anywhere. However, it may be indirectly tested in test_MirrorPoint and test_MirrorParametric.
braden6521
force-pushed
the
133_OpticOrientation_fix
branch
from
d1a4734
to
d2e7850
Compare
e10harvey
approved these changes
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed OpticOrientationAbstract addressing #134 .