libera_utils.quality_flags.LiberaFlag

class libera_utils.quality_flags.LiberaFlag(value)

Bases: Flag

Subclass of Flag that add a method for decomposing a flag into its individual components and a property to return a list of all messages associated with a quality flag

__init__(*args, **kwds)

Methods

decompose()

Return the set of all set flags that form a subset of the queried flag value.

Attributes

summary

Summarize quality flag value

decompose()

Return the set of all set flags that form a subset of the queried flag value. Note that this is not the minimum set of quality flags but rather a full set of all flags such that when they are ORed together, they produce self.value

Returns:

A tuple containing (members, not_covered) members is a list of flag values that are subsets of value not_covered is zero if the OR of members recreates value. Non-zero otherwise if bits are set in value that do not exist as named values in cls.

Return type:

tuple

property summary

Summarize quality flag value

Returns:

(value, message_list) where value is the integer value of the quality flag and message list is a list of strings describing the quality flag bits which are set.

Return type:

tuple