Quality control coding

[In progress]

Shear-probe quality-control flags

The Q (quality control) flags associated with shear-probe measurements are bitwise flags with boolean values which are CF compliant. More information available here: https://mplnet.gsfc.nasa.gov/about-flags

Every dissipation estimate from every probe must have Q flag. The numerical values of the Q flags are as follows:

Flag Mask	Bit	Flag Meaning	Example threshold value	Ex: True =1 / False =0	Ex: Q value
1	Bit 0	if FOM > FOM_limit	2	0	0
2	Bit 1	if despike_fraction > despike_fraction_limit	40%	0	0
4	Bit 2	log(e_max)-log(e_min)|> diss_ratio_limit X \sigma_{\ln\varepsilon}	N/A	1	4
8	Bit 3	if despike_iterations > despike_iterations_limit	To be confirmed	0	0
16	Bit 4	if variance resolved less than a threshold	50%	1	16
32	Bit 5	manual flag to be defined by user	N/A	0	0
64	Bit 6	manual flag to be defined by user	N/A	0	0
128	Bit 7	manual flag to be defined by user	N/A	0	0
					Final Q = 20

The Q flags are combined by their addition. For example a Q value of 20 means that the dissipation estimated failed both dissipation ratio limit test and the resolved variance test. A value of 255 means that all tests failed. The reasons for a failure can be decoded by breaking the value of Q down to its powers of 2.