add get_bpms

docs/measurements/procedures/get_bad_bpms.md

@@ -0,0 +1,148 @@
+# Get a list of Bad BPMs
+
+Every now and then BI asks for a list of BPMs that cause trouble for our measurements so that they can take a closer look during the next [(E?YET|L)S](https://regex101.com/r/ShN5hC/3).
+The following script is intended to facilitate the process of retrieving such a list.
+
+??? info "The script"
+
+ Here's the script, for reference.
+
+ Note that this is just a template, if specific measurements / globbing sounds better than just taking unchecked all the measurements in one (or several) output folder, feel free to adapt if necessary.
+
+ ```python
+ import pathlib
+ import tfs
+
+ ROOT = pathlib.Path("./Betabeat/")
+
+ DATES = [
+ "2023-09-06"
+ ]
+
+ OUTFILE = None
+
+ def main():
+ global OUTFILE
+ OUTFILE = open("bad_bpms.txt", "w")
+
+ get_the_bad_bpms()
+
+ OUTFILE.close()
+
+ def bad_bpms_per_date(date: pathlib.Path, plane: str, beam: str):
+ meas = (date / f"LHCB{beam}/Measurements")
+
+ measurements = [p for p in meas.iterdir() if p.is_dir()]
+
+ def get_bad_bpms(path: pathlib.Path):
+ for m in path.iterdir():
+ if m.suffix == f".bad_bpms_{plane}":
+ return m
+ return None
+
+ def get_iforest_bpms(path: pathlib.Path):
+ for m in path.iterdir():
+ if m.name == f"bad_bpms_iforest_{plane}.tfs":
+ return m
+ return None
+
+ measurements_svd = [get_bad_bpms(p) for p in measurements]
+ measurements_svd = [p for p in measurements_svd if p is not None]
+
+ measurements_iforest = [get_iforest_bpms(p) for p in measurements]
+ measurements_iforest = [p for p in measurements_iforest if p is not None]
+ return (measurements_svd, measurements_iforest)
+
+ def get_bad_bpms_for_beam_and_plane_svd(date: str, plane: str, beam: str, bad_bpms_list):
+ (measurements, measurements_iforest) = bad_bpms_per_date(ROOT / date , plane, beam)
+ for m in measurements:
+ appeared = []
+ #print(open(m).read())
+ for bpm in open(m):
+ words = bpm.split()
+ if words[0] in appeared:
+ continue
+ if "model" in words and "not" in words:
+ continue
+ appeared.append(words[0])
+ if words[0] in bad_bpms_list:
+ bad_bpms_list[words[0]] = bad_bpms_list[words[0]] + 1
+ else:
+ bad_bpms_list[words[0]] = 1
+ return len(measurements)
+
+ def get_bad_bpms_for_beam_and_plane_iforest(date: str, plane: str, beam: str, bad_bpms_list):
+ (measurements, measurements_iforest) = bad_bpms_per_date(ROOT / date , plane, beam)
+ for m in measurements_iforest:
+ appeared = []
+ #print(open(m).read())
+ bpm_tfs = tfs.read_tfs(m, index="NAME")
+ for bpm in bpm_tfs.index:
+ if bpm in appeared:
+ continue
+ appeared.append(bpm)
+ if bpm in bad_bpms_list:
+ bad_bpms_list[bpm] = bad_bpms_list[bpm] + 1
+ else:
+ bad_bpms_list[bpm] = 1
+ return len(measurements_iforest)
+
+
+ def do_print(msg: str):
+ global OUTFILE
+ print(msg)
+ OUTFILE.write(f"{msg}\n")
+
+ def get_the_bad_bpms():
+ for plane in ["x", "y"]:
+ for beam in ["1", "2"]:
+
+ pl = "H" if plane == "x" else "V"
+ do_print("")
+ do_print(f"BEAM {beam} {pl}")
+ do_print("{:20} | {} | {} | {:8} | {:7}".format("NAME", "PLANE", "BEAM", "FREQUENCY", "FROM"))
+ do_print("---------------------|-------|------|------------|-----------")
+ bad_bpms_list_iforest = {}
+ bad_bpms_list_svd = {}
+
+ n_svd = 0
+ n_iforest = 0
+ for date in DATES:
+ print(f"date {date}")
+ n_svd += get_bad_bpms_for_beam_and_plane_svd(date, plane, beam, bad_bpms_list_svd)
+ n_iforest += get_bad_bpms_for_beam_and_plane_iforest(date, plane, beam, bad_bpms_list_iforest)
+
+ print(f"SVD [{n_svd} files]")
+ for (k,v) in bad_bpms_list_svd.items():
+ v_perc = v / n_svd * 100
+ if v_perc > 75:
+ do_print(f"{k:20} | {plane:5} | {beam:4} | {v_perc:8.2f} % | SVD")
+ elif v_perc > 50:
+ do_print(f"{k:20} | {plane:5} | {beam:4} | {v_perc:8.2f} % | SVD")
+
+
+ print(f"IFOREST [{n_iforest} files]")
+ for (k,v) in bad_bpms_list_iforest.items():
+ v_perc = v / n_iforest * 100
+ if v_perc > 75:
+ do_print(f"{k:20} | {plane:5} | {beam:4} | {v_perc:8.2f} % | IFOREST")
+ elif v_perc > 50:
+ do_print(f"{k:20} | {plane:5} | {beam:4} | {v_perc:8.2f} % | IFOREST")
+
+ if __name__ == "__main__":
+ main()
+
+ ```
+
+It scans all measurements in a list of given GUI output folders (`DATES`) and compiles a list of bad BPMs with their given number of appearances after SVD and isolation forest.
+Output will be written to `"bad_bpms.txt"`
+
+## Usage:
+- [ ] Define a set of representative measurements (those shoulf probably span different optics configurations and different analysis purposes)
+- [ ] Make sure that the measurements have the desired cleaning method applied.
+ If needed rerun the measurements with the GUI.
+- [ ] Adapt the `DATES` list at the beginning of this script accordingly
+- [ ] a) Run this script in `OP_DATA` or
+ b) `ln -s OP_DATA/Betabeat` into your working dir or
+ c) change `ROOT` to a parent dir of your GUI output
+

mkdocs.yml

@@ -190,6 +190,7 @@ nav:
  - Rigid Waist Shift: measurements/procedures/rigid_waist_shift.md
  - Amplitude Detuning: measurements/procedures/ampdet.md
  - Crossing Angle Scan: measurements/procedures/xing_scan.md
+ - Compiling Bad BPMs for BI: measurements/procedures/get_bad_bpms.md
  - How To's:
  - Info: howto/about.md
  - General Setup: