Skip to content

QC-1248 Update QC Flag documentation #13720

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.

Sign up for GitHub

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

Merged
knopers8 merged 2 commits into from
Nov 27, 2024
Merged

QC-1248 Update QC Flag documentation #13720

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f50bd2
QC-1248 Update QC Flag documentation
knopers8 Nov 20, 2024
96af605
rm trailing whitespace
knopers8 Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions DataFormats/QualityControl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Data quality is determined through two methods:

Both methods utilize the same data format for Flags.
During processing (both synchronous and asynchronous), Checks produce Qualities and associate them with Flags.
The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (**not ready yet**, to be done in the scope of QC-978).
The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (more details in QC repository documentation).
Detector experts can then review the automatically generated Flags and make any necessary modifications or additions directly in the RCT.

### Quality Control Flag Structure
Expand Down Expand Up @@ -49,12 +49,13 @@ Each Flag Type has the following attributes:
#### Creating and Managing Flag Types

* **FlagTypeFactory** ensures a centralized and consistent list of available Flag Types.
New types can only be created through this factory.
New Flags can only be created through this factory.
* **[flagTypes.csv](etc/flagTypes.csv)** defines the existing Flag Types, including their ID, name, and "bad quality" determinant, factory method name and a switch to deprecate a flag.
The table serves as the source to automatically generate the corresponding methods in FlagTypeFactory.
* **Adding new Flag Types:** If a new issue requires a flag not currently defined, propose the addition by contacting the async QC coordinators.
They have the authority to add new Flag Types to the RCT.
These changes will then be reflected in the [flagTypes.csv](etc/flagTypes.csv) file through a pull request.
Any proposals for new Flag Types should describe the effects on usability of data from analyzer point of view and they should not be detector-specific unless well-argumented.
* **Modification of existing Flag Types:** Existing Flag Types should not be modified in terms of their definition.
Instead, one may create a new Flag Type and mark the existing one as obsolete in the CSV table.
This will add the `[[ deprecated ]]` attribute to the corresponding method.
Expand Down
Loading