gwm17/SPS_SABRE_EventBuilder
1
0
Fork 0
mirror of https://github.com/sesps/SPS_SABRE_EventBuilder.git synced 2024-11-26 19:38:50 -05:00
Code Issues Projects Releases Wiki Activity

Updated Details (markdown)

Gordon McCann 2022-04-29 16:39:29 -04:00
parent a929960ccc
commit 9bec6c40df
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Details.md

@ -9,7 +9,7 @@ Most important for the performance of the code is the size of the data buffer. I
## `CompassRun` ## `CompassRun`
`CompassRun` is the main location of event building in the program. It serves as a hub for the separate event building operations and the collection of `CompassFiles` for the active run. `CompassRun` is given a list of filenames and loops over that list, generating either a `CompassFile` or passing the name along to the scaler analysis if it matches a name in the scaler list. Once the set of files has been created, `CompassRun` begins the event building operation of choice (fast, slow, etc.) by selecting the first hit in time from the collection of files. Once it identifies the earliest hit, it passes the hit along to the next stage, typically slow sorting. The `CompassFile` from which the hit was taken has it's flag flipped so that the next hit in the buffer is set to the active hit. This process continues until all files have been exhausted of data. `CompassRun` is the main location of event building in the program. It serves as a hub for the separate event building operations and the collection of `CompassFiles` for the active run. `CompassRun` is given a list of filenames and loops over that list, generating either a `CompassFile` or passing the name along to the scaler analysis if it matches a name in the scaler list. Once the set of files has been created, `CompassRun` begins the event building operation of choice (fast, slow, etc.) by selecting the first hit in time from the collection of files. Once it identifies the earliest hit, it passes the hit along to the next stage, typically slow sorting. The `CompassFile` from which the hit was taken has it's flag flipped so that the next hit in the buffer is set to the active hit. This process continues until all files have been exhausted of data.
## `GWMEventBuilder` ## `EVBApp`
This is the main API of the program. Think of this class as the application level class. It is the direct interface with the user input data, and properly generates and runs various `CompassRun` operations. If you want to add some new form of user input, it should be done through this class. This is the main API of the program. Think of this class as the application level class. It is the direct interface with the user input data, and properly generates and runs various `CompassRun` operations. If you want to add some new form of user input, it should be done through this class.
## `SlowSort, FastSort, SFPAnalyzer` ## `SlowSort, FastSort, SFPAnalyzer`