Propagate changes in orbcorr tracking dimension flag#305
Merged
vellosok75 merged 13 commits intomasterfrom Sep 19, 2025
Merged
Conversation
- with the introduction of `use6dorb` in recent commits, code using `OrbRespmat` and `OrbitCorr` classes, such as LOCO, broke. - In a an effort to propagate this new convention to other classes, we agreed to standardize the flag name to `use6dtrack` instead of of `use6dorb`.
…` flag) - with the introduction of `use6dorb` in recent commits, code using `OrbRespmat` and `OrbitCorr` classes got broken. - In a an effort to propagate this new convention to other classes, we agreed to standardize the flag name to `use6dtrack` instead of of `use6dorb`.
- with the introduction of `use6dorb` flag in recent commits, code using `OrbRespmat` and `OrbitCorr` classes got broken. - In a an effort to propagate this change to other classes, we agreed to standardize the flag name to `use6dtrack` instead of of `use6dorb`.
- with the introduction of `use6dorb` flag in recent commits, code using `OrbRespmat` and `OrbitCorr` classes got broken. - In a an effort to propagate this change to other classes, we agreed to standardize the flag name to `use6dtrack` instead of of `use6dorb`.
…dtrack` flag) - with the introduction of `use6dorb` flag in recent commits, code using `OrbRespmat` and `OrbitCorr` classes got broken. - In a an effort to propagate this change to other classes, we agreed to standardize the flag name to `use6dtrack` instead of of `use6dorb`.
vellosok75
requested review from
Gabrielrezende-asc,
fernandohds564 and
xresende
vellosok75
changed the title
fernandohds564
approved these changes
Aug 27, 2025
Gabrielrezende-asc
approved these changes
Aug 29, 2025
xresende
approved these changes
Sep 1, 2025
- some files have not been change since we started to format w/ ruff - others (mostly LOCO's) have already been formatted, however, we recently agreed to go back to single-quotes, instead of doubles - some imports also have been sorted
- import function incorrectly removed in previous commits
fernandohds564
approved these changes
Sep 9, 2025
- the default values for `use6dtrack` in the Params and Correction classes were different - this raised ValueError when stantiating `OrbitCorr` with default values + default instantiatied `CorrParams` object - this error was observed when using `lattice_errors.create_machines`, as exemplified in `examples/generate_random_machines.py`
- in `apsuite.orbcorr` the default values for `use6dtrack` in the Params and Correction classes were different - this raised `ValueError` when instantiating `OrbitCorr` with default values + default instantiated `CorrParams` object - this error was observed when using `lattice_errors.create_machines`, as exemplified in `examples/generate_random_machines.py` - the previous commit standardized the flag to `True` in orbcorr - here I am explicitly declaring `use6dtrack=False`, as in the example file
Contributor
Author
|
@xresende there have been updates since your last review. Could you please take another look? |
xresende
approved these changes
Sep 19, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
In PR #303, the string convention for specifying tracking dimension in
OrbitCorrandOrbRespmatwas replaced by a boolean flag:dim="4D"->use6dorb=False.This PR propagates this new convention to other codes using these classes. Since
use6dorbwas quite specific for orbit and orbit correction contexts, this flag was renameduse6dtrackto be more generic, specifically because of its use in optics correction contexts (LOCO,OpticsCorr,CouplingCorr).