Skip to content

Commit

Permalink
QC-1248 Update QC Flag documentation (#13720)
Browse files Browse the repository at this point in the history
* QC-1248 Update QC Flag documentation

Small updates wrt what is ready to use and some clarifications.

* rm trailing whitespace
  • Loading branch information
knopers8 authored Nov 27, 2024
1 parent 96e4188 commit d8d7b7c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions DataFormats/QualityControl/README.md
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

0 comments on commit d8d7b7c

Please sign in to comment.