-
Notifications
You must be signed in to change notification settings - Fork 2
Synchronization of SuperKEKB BPMs #112
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
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6d42634
BPM Synchronization for SuperKEKB
Mael-Le-Garrec 4323b18
Version bump
Mael-Le-Garrec 93ee991
Add overwrite flag
Mael-Le-Garrec 95a721c
Use PathOrStr
Mael-Le-Garrec 39111b6
Cleaning imports
Mael-Le-Garrec 36f7dc9
Remove some personnal paths
Mael-Le-Garrec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| BPM Resynchronization | ||
| ********************** | ||
|
|
||
| .. automodule:: pylhc.bpm_resync |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| """ | ||
| BPM Synchronization | ||
| ------------------- | ||
|
|
||
| This script resyncs the BPMs from the `LER` and `HER` rings of `SuperKEKB`. | ||
| Those BPMs are often not aligned time-wise and the values can be off by a few turns. | ||
| The resynchronization is done by looking up the phase advance of each BPM to retrieve the turn | ||
| offset. | ||
| This requires a frequency and an optics analysis of the unsynchronized turn by turn data. | ||
|
|
||
| The script takes as input the original turn by turn data, the optics directory containing the | ||
| results of the optics analysis, as well as the output filename where the turn by turn data will be | ||
| written, in ASCII SDDS format. | ||
|
|
||
|
|
||
| Arguments: | ||
|
|
||
| *--Required--* | ||
|
|
||
| - **input** *(Path,str,TbtData)*: | ||
|
|
||
| Input turn by turn data to be resynchronized. | ||
| Can take the form of a `Path` to a file or directly a `TbtData` object. | ||
|
|
||
| flags: **['--input']** | ||
|
|
||
| - **optics_dir** *(Path,str)*: | ||
|
|
||
| Optics analysis path of the unsynchronized data, must contain the `total_phase_{x,y}.tfs` files. | ||
|
|
||
| flags: **['--optics_dir']** | ||
|
|
||
| - **output_file** *(Path,str)*: | ||
|
|
||
| Output file path where to write the synchronized turn by turn data. | ||
| The directory will be created if necessary. | ||
|
|
||
| flags: **['--output_file']** | ||
|
|
||
| - **ring** *(str)*: | ||
|
|
||
| Ring name, either `LER` or `HER`. | ||
|
|
||
| flags: **['--ring']** | ||
|
|
||
| choices: ``('LER', 'HER')`` | ||
|
|
||
| *--Optional--* | ||
|
|
||
| - **tbt_datatype** *(str)*: | ||
| Datatype of the TurnByTurn data provided as input. | ||
|
|
||
| flags: **['--tbt_datatype']** | ||
|
|
||
| choices: list of datatypes supported by `turn_by_turn`, in `turn_by_turn.io.TBT_MODULES` | ||
|
|
||
| default: ``lhc`` | ||
|
|
||
| - ** overwrite** *(bool)*: | ||
| Whether to overwrite the output file if it already exists. | ||
|
|
||
| flags: **['--overwrite']** | ||
|
|
||
| default: ``False`` | ||
| """ | ||
|
|
||
| from copy import deepcopy | ||
| from pathlib import Path | ||
|
|
||
| import numpy as np | ||
| import pandas as pd | ||
| import tfs | ||
| import turn_by_turn as tbt | ||
| from generic_parser import EntryPointParameters, entrypoint | ||
| from generic_parser.dict_parser import ArgumentError | ||
| from omc3.optics_measurements.constants import DELTA, NAME, PHASE, TUNE | ||
| from omc3.utils import logging_tools | ||
| from omc3.utils.iotools import PathOrStr | ||
|
|
||
| from pylhc.constants.bpm_resync import DEFAULT_DATATYPE, PHASE_FILE, RINGS | ||
|
|
||
| LOGGER = logging_tools.get_logger(__name__) | ||
|
|
||
|
|
||
| def _get_params() -> dict: | ||
| """ | ||
| Parse Commandline Arguments and return them as options. | ||
|
|
||
| Returns: | ||
| dict | ||
| """ | ||
|
|
||
| return EntryPointParameters( | ||
| input={ | ||
| "required": True, | ||
| "help": "Input turn by turn data to be resynchronized. Can take the form of a `Path` to" | ||
| "a file or directly a `TbtData` object.", | ||
| }, | ||
| optics_dir={ | ||
| "type": PathOrStr, | ||
| "required": True, | ||
| "help": "Optics path, must contain the `total_phase_{x,y}.tfs` files.", | ||
| }, | ||
| output_file={ | ||
| "type": PathOrStr, | ||
| "required": True, | ||
| "help": "Output file path where to write the turn by turn data. The directory will be" | ||
| "created if necessary.", | ||
| }, | ||
| ring={ | ||
| "type": str, | ||
| "required": True, | ||
| "choices": RINGS, | ||
| "help": (f"Ring name, from {RINGS}"), | ||
| }, | ||
| tbt_datatype={ | ||
| "type": str, | ||
| "required": False, | ||
| "choices": list(tbt.io.TBT_MODULES.keys()), | ||
| "default": DEFAULT_DATATYPE, | ||
| "help": "Datatype of the TurnByTurn data", | ||
| }, | ||
| overwrite={ | ||
| "type": bool, | ||
| "required": False, | ||
| "default": False, | ||
| "help": "Whether to overwrite the output file if it already exists.", | ||
| }, | ||
| ) | ||
|
|
||
|
|
||
| def sync_tbt(original_tbt: tbt.TbtData, optics_dir: Path, ring: str) -> tbt.TbtData: | ||
| """Resynchronize the BPMS in the the turn by turn data based on the phase advance. | ||
| Args: | ||
| original_tbt (tbt.TbtData): Original turn by turn data to be synchronized. | ||
| optics_dir (Path): Original optics directory containing the phase advance files. | ||
| ring (str): Ring name, either `LER` or `HER`. | ||
| Returns: | ||
| tbt.TbtData: Resynchronized turn by turn data. | ||
| """ | ||
| # Copy the original turn by turn data | ||
| synced_tbt = deepcopy(original_tbt) | ||
|
|
||
| # HER and LER are in opposite direction for the phase | ||
| ring_dir = 1 if ring == "HER" else -1 | ||
|
|
||
| # Some BPMs can exist in a plane but not the other, we need to check both planes to be sure | ||
| already_processed = set() | ||
| for plane in ("x", "y"): | ||
| phase_df = tfs.read(optics_dir / PHASE_FILE.format(plane=plane)) | ||
| qx = phase_df.headers[f"{TUNE}1"] | ||
| qy = phase_df.headers[f"{TUNE}2"] | ||
| bpms: pd.Series = phase_df[NAME] # using omc3 constants | ||
| dphase: pd.Series = phase_df[f"{DELTA}{PHASE}{plane.upper()}"] | ||
|
|
||
| tune = (1 - qx) if plane == "x" else (1 - qy) | ||
|
|
||
| # The phase advance divided by the tune will tell us how off the BPM is | ||
| ntune: pd.Series = dphase / tune | ||
| abs_ntune: pd.Series = ntune.abs() | ||
|
|
||
| # If the ratio ntune is close to 1, that's one turn, otherwise, it's likely -2 turns | ||
| mag: np.ndarray = np.select([abs_ntune >= 0.8, abs_ntune >= 0.1], [1, -2], default=0) | ||
| # The final number of turns also depends on the sign of the phase | ||
| final_correction: np.ndarray = (mag * np.sign(ntune) * ring_dir).astype(int) | ||
|
|
||
| # Iterate through all the BPMs and check their phase advance | ||
| for idx, bpm in enumerate(bpms): | ||
| # Check if we've seen that BPM before in the other plane | ||
| if bpm in already_processed: | ||
| continue | ||
| already_processed.add(bpm) | ||
|
|
||
| if (bpm_correction := final_correction[idx]) != 0: | ||
| LOGGER.info( | ||
| f" {bpm:15s} -> turn correction of {bpm_correction} (ntune={ntune[idx]:.2f})" | ||
| ) | ||
|
|
||
| # Shift the data | ||
| for plane in ("X", "Y"): | ||
| matrix = synced_tbt.matrices[0][plane] | ||
| orig_row = original_tbt.matrices[0][plane].loc[bpm] | ||
| matrix.loc[bpm] = orig_row.shift(bpm_correction, fill_value=0) | ||
|
|
||
| return synced_tbt | ||
|
|
||
|
|
||
| @entrypoint(_get_params(), strict=True) | ||
| def main(opt): | ||
| # Open the TbT file if needed | ||
| if isinstance(opt.input, (Path, str)): | ||
| original_tbt = tbt.read(opt.input, datatype=opt.tbt_datatype) | ||
| elif isinstance(opt.input, tbt.TbtData): | ||
| original_tbt = opt.input | ||
| else: | ||
| raise ArgumentError("input must be either a Path, str or a TbtData object") | ||
|
|
||
| opt.optics_dir = Path(opt.optics_dir) | ||
| opt.output_file = Path(opt.output_file) | ||
|
|
||
| # Synchronise TbT | ||
| LOGGER.info(f"Resynchronizing {opt.optics_dir.name}...") | ||
| synced_tbt = sync_tbt(original_tbt, opt.optics_dir, opt.ring) # type: ignore | ||
|
|
||
| # Save the resynced turn by turn data | ||
| if (opt.output_file).exists() and not opt.overwrite: | ||
| LOGGER.warning(f"File {opt.output_file} already exists, aborting.") | ||
| raise FileExistsError(f"File {opt.output_file} already exists, aborting.") | ||
| if (opt.output_file).exists() and opt.overwrite: | ||
| LOGGER.warning(f"Overwriting file {opt.output_file}.") | ||
|
|
||
| opt.output_file.parent.mkdir(exist_ok=True) | ||
| tbt.write(opt.output_file, synced_tbt) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| """ | ||
| Constants: BPM Resynchronization | ||
| -------------------------------- | ||
|
|
||
| Specific constants related to the BPM resynchronization script in ``PyLHC``. | ||
| """ | ||
|
|
||
| from typing import Final, Literal | ||
|
|
||
| # Available rings | ||
| RINGS: Final[set[Literal['LER', 'HER']]] = {'LER', 'HER'} | ||
|
|
||
| # Phase file containing the phase advance of the BPMs | ||
| PHASE_FILE: Final[str] = "total_phase_{plane}.tfs" | ||
|
|
||
| DEFAULT_DATATYPE: Final[Literal['lhc']] = "lhc" |
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| @ Measure_optics:version %s "0.27.0" | ||
| @ Date %s "11. February 2026, 18:56:48" | ||
| @ Compensation %s "none" | ||
| @ Q1 %le 0.545561396557 | ||
| @ Q2 %le 0.590880577381 | ||
| * S MUXMDL NAME S2 NAME2 PHASEX ERRPHASEX PHASEXMDL DELTAPHASEX ERRDELTAPHASEX | ||
| $ %le %le %s %le %s %le %le %le %le %le | ||
| 2.2500008 0.2321053 "MQC2LE" 2.2500008 "MQC2LE" 0 0.000733985330348 0 0 0.000733985330348 | ||
| 27.2720861 0.4859659 "MQLC7LE" 2.2500008 "MQC2LE" 0.256293937291 0.00291312042024 0.2538606 0.002433337291 0.00291312042024 | ||
| 77.1787307 1.3487054 "MQLB4LE" 2.2500008 "MQC2LE" 0.106984972657 0.00338876555354 0.1166001 -0.009615127343 0.00338876555354 | ||
| 119.0986538 2.3883387 "MQLA5LE" 2.2500008 "MQC2LE" 0.160726344998 0.00220870794024 0.1562334 0.004492944998 0.00220870794024 | ||
| 164.5639584 3.0658979 "MQD3E1" 2.2500008 "MQC2LE" 0.866894782895 0.00346375144436 0.8337926 0.0331021828951 0.00346375144436 | ||
| 230.8020191 4.13945 "MQEAE4" 2.2500008 "MQC2LE" 0.900857436455 0.0015240457914 0.9073447 -0.0064872635448 0.0015240457914 | ||
| 270.0136808 4.7448669 "MQD3E4" 2.2500008 "MQC2LE" 0.50139549147 0.00308079948379 0.5127616 -0.01136610853 0.00308079948379 | ||
| 306.4724249 5.2875858 "MQEAE6" 2.2500008 "MQC2LE" 0.049485696792 0.00164029807706 0.0554805 -0.005994803208 0.00164029807706 | ||
| 354.4092937 5.9879131 "MQTATNE1" 2.2500008 "MQC2LE" 0.194458960987 0.00158648098661 0.7558078 0.438651160987 0.00158648098661 | ||
| 397.7476034 6.4602091 "MQTATNE2" 2.2500008 "MQC2LE" 0.675587885323 0.00148601847999 0.2281038 0.447484085323 0.00148601847999 | ||
| 472.7108711 7.6286716 "MQEAE8" 2.2500008 "MQC2LE" 0.391819883042 0.0014916135612 0.3965663 -0.004746416958 0.0014916135612 | ||
| 548.3812769 8.7768074 "MQEAE10" 2.2500008 "MQC2LE" 0.526235491844 0.00170499807942 0.5447021 -0.018466608156 0.00170499807942 | ||
| 597.0252838 9.456808 "MQEAE11" 2.2500008 "MQC2LE" 0.22046885356 0.00175282051509 0.2247027 -0.00423384644 0.00175282051509 | ||
| 696.7698054 10.9793008 "MQR2NE1" 2.2500008 "MQC2LE" 0.728825016834 0.00296818349792 0.7471955 -0.018370483166 0.00296818349792 | ||
| 881.197528 13.2607736 "MQEAE13" 2.2500008 "MQC2LE" 0.0337180564701 0.0015699715775 0.0286683 0.0050497564701 0.0015699715775 | ||
| 947.4355886 14.3343257 "MQD3E12" 2.2500008 "MQC2LE" 0.136506648725 0.00386880500401 0.1022204 0.034286248725 0.00386880500401 | ||
| 983.8943327 14.8770446 "MQEAE16" 2.2500008 "MQC2LE" 0.639640121621 0.00148885652833 0.6449393 -0.005299178379 0.00148885652833 | ||
| 1023.1059944 15.4824615 "MQD3E14" 2.2500008 "MQC2LE" 0.266329667043 0.00347174272354 0.2503562 0.015973467043 0.00347174272354 | ||
| 1059.5647385 16.0251804 "MQEAE18" 2.2500008 "MQC2LE" 0.789406306452 0.00138825429604 0.7930751 -0.003668793548 0.00138825429604 | ||
| 1107.5016074 16.7255077 "MQTANFE1" 2.2500008 "MQC2LE" 0.492659512911 0.00151747177794 0.4934024 -0.000742887089001 0.00151747177794 | ||
| 1189.3444407 17.8235473 "MQD3E16" 2.2500008 "MQC2LE" 0.614782246359 0.00371486183198 0.591442 0.023340246359 0.00371486183198 | ||
| 1301.4735906 19.5144019 "MQEAE22" 2.2500008 "MQC2LE" 0.270785621186 0.00152642618843 0.2822966 -0.011510978814 0.00152642618843 | ||
| 1350.1175975 20.1944026 "MQEAE23" 2.2500008 "MQC2LE" 0.976272243168 0.00191120446419 0.9622973 0.0139749431679 0.00191120446419 | ||
| 1404.3012987 21.2105542 "MQI6E" 2.2500008 "MQC2LE" 0.977700472626 0.00225740145544 0.9784489 -0.0007484273738 0.00225740145544 | ||
| 1418.7440064 21.2913712 "MQI5E" 2.2500008 "MQC2LE" 0.064197099179 0.00144704517394 0.0592659 0.004931199179 0.00144704517394 | ||
| 1424.1361014 21.3069978 "MQI4E" 2.2500008 "MQC2LE" 0.091309691209 0.0012886002698 0.0748925 0.016417191209 0.0012886002698 | ||
| 1494.6206604 22.6992479 "MQX2RE" 2.2500008 "MQC2LE" 0.465169163917 0.00121668867702 0.4671426 -0.001973436083 0.00121668867702 | ||
| 1564.3492168 23.8089926 "MQM2E" 2.2500008 "MQC2LE" 0.591453258231 0.00325473069156 0.5768873 0.014565958231 0.00325473069156 | ||
| 1608.8759522 24.5204202 "MQM7E" 2.2500008 "MQC2LE" 0.297975857062 0.00269383162364 0.2883149 0.009660957062 0.00269383162364 | ||
| 1710.4692283 26.1148873 "MQEAE27" 2.2500008 "MQC2LE" 0.882293284639 0.0015095987124 0.882782 -0.000488715360799 0.0015095987124 | ||
| 1746.9279724 26.6576062 "MQD3E23" 2.2500008 "MQC2LE" 0.469819035015 0.0033193234245 0.4255009 0.044318135015 0.0033193234245 | ||
| 1786.1396341 27.2630231 "MQEAE29" 2.2500008 "MQC2LE" 0.0286904119644 0.00152753560153 0.0309178 -0.0022273880356 0.00152753560153 | ||
| 1813.166033 27.7311583 "MQEAE30" 2.2500008 "MQC2LE" 0.500736844416 0.00157831659097 0.499053 0.001683844416 0.00157831659097 | ||
| 1861.1278611 28.4218222 "MQTAFOE1" 2.2500008 "MQC2LE" 0.636146490598 0.00177489315603 0.1897169 0.446429590598 0.00177489315603 | ||
| 1905.3942301 28.8967378 "MQTAFOE2" 2.2500008 "MQC2LE" 0.122229765942 0.00163590880957 0.6646325 0.457597265942 0.00163590880957 | ||
| 1980.3824571 30.0555369 "MQEAE32" 2.2500008 "MQC2LE" 0.826542423411 0.00152909928067 0.8234316 0.003110823411 0.00152909928067 | ||
| 2465.4769137 37.0395836 "MQEAE39" 2.2500008 "MQC2LE" 0.266300040741 0.00158127047893 0.8074783 0.458821740741 0.00158127047893 | ||
| 2501.9356578 37.5823024 "MQD3E33" 2.2500008 "MQC2LE" 0.776516948261 0.00325074344111 0.3501971 0.426319848261 0.00325074344111 | ||
| 2541.1473195 38.1877194 "MQEAE41" 2.2500008 "MQC2LE" 0.408528089977 0.00140886797915 0.9556141 0.452913989977 0.00140886797915 | ||
| 2616.1355465 39.3465184 "MQTAOTE1" 2.2500008 "MQC2LE" 0.575607153823 0.0015129180727 0.1144131 0.461194053823 0.0015129180727 | ||
| 2660.4019155 39.821434 "MQTAOTE2" 2.2500008 "MQC2LE" 0.0311686850482 0.00159251723576 0.5893287 0.441839985048 0.00159251723576 | ||
| 2735.3901425 40.9802331 "MQEAE44" 2.2500008 "MQC2LE" 0.220665075012 0.00142938002831 0.7481278 0.472537275012 0.00142938002831 | ||
| 2784.0341494 41.6602337 "MQEAE45" 2.2500008 "MQC2LE" 0.876616688885 0.00146588124857 0.4281284 0.448488288885 0.00146588124857 | ||
| 2850.27221 42.7337858 "MQD3E40" 2.2500008 "MQC2LE" 0.956004212917 0.00467405934326 0.5016805 0.454323712917 0.00467405934326 | ||
| 2960.9918734 44.543746 "MQLB1RE" 2.2500008 "MQC2LE" 0.217017468206 0.00201667986156 0.3116407 -0.094623231794 0.00201667986156 | ||
| 3013.8146988 45.3142773 "MQC2RE" 2.2500008 "MQC2LE" 0.976447362224 0.000781106382587 0.082172 -0.105724637776 0.000781106382587 |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.