modularize emittance measurement #263
Merged
Conversation
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
Collaborator
roussel-ryan
commented
Apr 25, 2025
roussel-ryan
commented
- modify emittance optimization problem to use mean abs error in beamsize space to not prioritize fitting measurements where the beam size is large
- introduce wrapper and preprocessing functions for calculating emittance from machine units
- introduce wrapper and preprocessing functions for calculating emittance from machine units
There was a problem hiding this comment.
Pull Request Overview
This PR modularizes the emittance measurement by updating the optimization metric to use the mean absolute error in beamsize space and introducing wrapper and preprocessing functions to better handle inputs in machine units.
- Adjusts the optimization error metric in the loss functions for both torch and numpy implementations.
- Introduces a new compute_emit_bmag_machine_units wrapper and preprocessing function in the data module.
- Updates the QuadScanEmittance measurement by reducing the wait_time and adding a type validator for beamsize measurements.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lcls_tools/common/measurements/emittance_measurement.py | Updated imports, wait_time modification, added field validator, and integrated compute_emit_bmag_machine_units in the measurement workflow. |
| lcls_tools/common/data/emittance.py | Revised error metric in the loss functions, added preprocess_inputs, and introduced compute_emit_bmag_machine_units wrapper. |
Comments suppressed due to low confidence (2)
lcls_tools/common/data/emittance.py:116
- The loss function now computes the absolute error between the square roots of the calculated and measured values, effectively working in beamsize space instead of mean square beamsize space. Please update the associated docstring and any related documentation to reflect this change in the error metric.
total_squared_error = (torch.sqrt(amat @ sig) - torch.sqrt(beamsize_squared)).abs().sum()
lcls_tools/common/data/emittance.py:136
- The numpy loss function now computes the absolute error between the square roots of the computed and measured beam sizes. Consider updating the function documentation to ensure that the new metric is clearly described and matches the intended optimization behavior.
total_squared_error = np.sum(np.abs(np.sqrt(amat @ sig) - np.sqrt(beamsize_squared)))
pluflou
approved these changes
May 23, 2025
| @@ -190,6 +193,17 @@ def validate_rmat(cls, v, info): | |||
| assert v.shape == (2, 2, 2) | |||
| return v | |||
|
|
|||
| @field_validator("beamsize_measurement", mode="after") | |||
There was a problem hiding this comment.
Is there a reason beamsize_measurement isn't specified as ScreenBeamProfileMeasurement type on line 179? Would it still be necessary to do this here?
lcls_tools/common/data/emittance.py
Outdated
| @@ -112,7 +113,9 @@ def loss_torch(params): | |||
| params = torch.reshape(params, [*beamsize_squared.shape[:-2], 3]) | |||
| sig = torch.stack(beam_matrix_tuple(params), dim=-1).unsqueeze(-1) | |||
| # sig should now be shape batchshape x 3 x 1 (column vectors) | |||
| total_squared_error = (amat @ sig - beamsize_squared).abs().sum() | |||
| total_squared_error = ( | |||
There was a problem hiding this comment.
renaming this would enhance readability
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.