You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -34,45 +35,98 @@ Use the ++"Open Files"++{.green-gui-button} button to open turn-by-turn data.
34
35
The name of the model will appear at the top of the GUI.
35
36
This is required, as the BPMs are checked vs the model and sorted by longitunial location.
36
37
37
-
!!! warning "Naming Filter"
38
+
!!! tip "Naming Filter"
38
39
For the LHC, the displayed files in the file-dialog are automatically filtered to show only `@BunchTurn` files of the currently selected beam.
39
40
You can change/deactivate that filter ("Files of Type") at the bottom of the dialog!
40
41
41
42
Multiple files can be opened at once and are added to the current `Measurements` directory, as well as to the table of loaded files in the panel.
42
-
If the file contained multiple bunches, they are added as separate entries.
43
+
If the file contained multiple bunches, they are added as separate entries (see [below](#table-of-loaded-files)).
43
44
44
-
!!! warning "Supported Formats"
45
-
The GUI itself only supports the opening of LHC-type (dual plane BPMs) or SPS-type (single plane BPMs) binary `.sdds` files.
46
-
You can choose in the [gui tab of the settings](settings.md#gui-tab) which format your turn-by-turn data is and if you want
47
-
to convert it into one of the supported formats.
48
-
The GUI will then call the [`omc3.tbt_converter`][tbt_converter] to convert the file.
49
-
All formats that can be read by the [`turn-by-turn` package][tbt_package] are supported.
50
-
If you choose the **"DO NOT CONVERT"** option, the files are simply copied into the current `Measurements` directory.
45
+
If the ["Analyse TbT files on opening" setting](settings.md#gui-tab) is active, a window will open to prompt the user with the ["Do analysis Dialog"][do_analysis_dialog].
51
46
52
-
If the ["Analyse TbT files on opening" setting](settings.md#gui-tab) is active, a window will open to prompt the user with the ["Do analysis Dialog"](bpm_panel.md#do-analysis).
47
+
!!! tip "Reopening Files"
48
+
- If you are opening a file with the same filename as an already opened file, an error will be thrown.
49
+
- If you want to open a new file with the same name as an previously opened file, i.e. one with the same name in the `Measurements` directory,
50
+
a popup will ask if the old file should be overwritten or simply opened instead (without running the converter).
51
+
- If you restart the GUI and select the ["Load Data" option in the beam selection window](beam_selection.md#load-data),
52
+
all files in the `Measurements` directory will be reloaded (without running the converter).
53
53
54
-
## Investigating Data
54
+
#### Supported File Formats
55
+
56
+
The GUI itself only supports the opening of LHC-type (dual plane BPMs) or SPS-type (single plane BPMs) binary `.sdds` files.
57
+
You can choose in the [gui tab of the settings](settings.md#gui-tab) which format your turn-by-turn data is and if you want
58
+
to convert it into one of the supported formats.
59
+
The GUI will then call the [`omc3.tbt_converter`][tbt_converter] to convert the file.
60
+
All formats that can be read by the [`turn-by-turn` package][tbt_package] are supported.
61
+
If you choose the **"DO NOT CONVERT"** option, the files are simply copied into the current `Measurements` directory.
62
+
63
+
!!! tip "LHC ASCII files"
64
+
The old ASCII format (for SPS and LHC), which is still in use in some older conversion scripts and MAD-X tracking scripts,
65
+
are identified automatically by the converter when choosing `lhc` or `sps` as the file type to be opened.
66
+
Use then **the same format** for the conversion, i.e. `lhc` or `sps` respectively.
67
+
This looks weird, but the converter will output the data in binary format.
68
+
69
+
## Table of Loaded Files
70
+
71
+
<figure>
72
+
<center>
73
+
<imgclass="clickImg"src="../../assets/images/betabeat_gui/bpm_panel_table.png"width="100%"alt="Table of loaded files"/>
74
+
<figcaption>The Table of loaded files in the BPM Panel.</figcaption>
75
+
</center>
76
+
</figure>
77
+
78
+
The table at the top of the panel shows the files that are currently opened in the GUI.
79
+
These are not necessarily all files present in the `Measurement` directory, as they need to be explicitly opened!
80
+
81
+
82
+
-**File**:
83
+
Name of the file, without the path.
84
+
-**Bunch ID**:
85
+
The ID of the bunch within the file.
86
+
If the file contains multiple bunches, multiple entries with the same _File_ name, but different _Bunch IDs_ will be created.
87
+
-**Analysis Done**:
88
+
Idicator if the analysis has been performed on this file.
89
+
_(:fontawesome-solid-triangle-exclamation:{.warning-colored} [Currently not working.][issue285])_
90
+
-**Kick Group**:
91
+
Name of the [Kick Group](#measurement-groups-aka-kick-groups) this file belongs to.
92
+
_(:fontawesome-solid-triangle-exclamation:{.warning-colored} [Currently not working.][issue282])_
93
+
-**No. of bad BPMs**:
94
+
Number of [bad BPMs][bpm_filtering] identified in this file.
95
+
This value is `0` upon loading the file and will be updated when the harmonic analysis is done.
96
+
These will be marked in red in the BPM lists below.
97
+
98
+
!!! warning "Memory Usage"
99
+
File that are opened in this panel are stored in memory.
100
+
If your computer is running low on memory, you might want to close some of the open files.
101
+
102
+
### Removing Entries
103
+
104
+
Clicking on the ++"Remove"++{.red-gui-button} button will remove the selected entries from the table of loaded files.<br>
105
+
:fontawesome-solid-triangle-exclamation:{.warning-colored} This will **not** remove the files from the `Measurements` directory!
106
+
107
+
## Investigating Turn-by-Turn Data
55
108
56
109
After selecting one or more files in the table of loaded files, the turn-by-turn data is visualized in the two bottom charts, one for each plane.
57
110
The charts are [interactive](common_components.md#plotting) and can display either the measured amplitude values over turns for every BPM from the list or display the phase space, which is calculated by two consecutive BPMs.
58
111
You can select multiple measurements at once to compare them, but only one BPM per plane at a time.
59
112
60
113
<figure>
61
114
<center>
62
-
<imgsrc="../../assets/images/betabeat_gui/bpm_turn_by_turn_data.png"width="100%"alt="Turn-by-Turn view of BPM data"/>
115
+
<imgclass="clickImg"src="../../assets/images/betabeat_gui/bpm_turn_by_turn_data.png"width="100%"alt="Turn-by-Turn view of BPM data"/>
63
116
<figcaption>Turn-by-Turn view of BPM data with two measurements selected.</figcaption>
64
117
</center>
65
118
</figure>
66
119
67
120
<figure>
68
121
<center>
69
-
<imgsrc="../../assets/images/betabeat_gui/bpm_data_phase_space.png"width="100%"alt="Phase space view of BPM data"/>
122
+
<imgclass="clickImg"src="../../assets/images/betabeat_gui/bpm_data_phase_space.png"width="100%"alt="Phase space view of BPM data"/>
70
123
<figcaption>Phase space view of BPM data.</figcaption>
71
124
</center>
72
125
</figure>
73
126
74
127
!!! info "Bad BPMS"
75
128
After [harmonic-analysis](#do-analysis) has been performed, the [bad BPMS][bpm_filtering] will be marked in red in the lists.
129
+
_(To be checked: This feature might only work if you re-load the data after the analysis.)_
76
130
77
131
### Averages, Removal of Turns and Splitting Files
78
132
@@ -85,23 +139,18 @@ The buttons on the top left side of the pane provide some features to handle the
85
139
- ++"Remove Turns"++ can be used to cut turns from the start or the end, to focus on a specified range of the data.
86
140
- ++"Split Files"++ splits the current BPM data file into N files, where N is specified in the dialog and the resulting files will have old-turns/N turns.
87
141
88
-
## Do Analysis
89
-
90
-
-`Do Analysis` spawns the configuration dialogue for the external analysis.
91
-
This will call an external program to perform harmonic analysis of the BPM data, in order to compute tunes and similar beam properties.
92
-
The results from the analysis can be seen in the [Analysis Panel](analysis_panel.md).
93
-
94
-
!!! todo
95
-
96
-
Include of screenshot of `Do Analysis` dialogue window.
142
+
## Start Analysis
97
143
98
-
!!! note
144
+
The ++"Analyse Spectra"++{.green-gui-button} button spawns [the configuration dialog][do_analysis_dialog] for the harmonic analysis.
145
+
This will call an external program to perform a frequency analysis of the BPM data **of the selected files**, in order to compute tunes and similar beam properties.
146
+
The results from the analysis can be seen in the [Analysis Panel](analysis_panel.md), in which also the settings are discussed in detail.
99
147
100
-
The `Create Average` option requires synchronized data from withing the same bounds, otherwise the results will be meaningless.
101
-
The figure below shows three runs from LHC beam one with synchronized peaks for every turn and their corresponding averages.
148
+
The **"Run optics as well"** checkbox will define whether the _"Optics Analysis"_ in the _["Do analysis Dialog"][do_analysis_dialog]_ is automatically pre-checked.
0 commit comments