libera_utils.footprint_matching.types.FmatchCoverageFlag#

class libera_utils.footprint_matching.types.FmatchCoverageFlag(*values)#

Bases: IntFlag

Bitwise coverage/QA flags folded into a footprint’s Quality_Flag variable.

Set by the product orchestrator from the CERES 75%/95% PSF-energy coverage rule once the external-variable aggregation has run. The values are OR-combined and tested bitwise, and an empty (zero) value means “no coverage issue”. The PARTIAL_COVERAGE bit deliberately shares bit 0 with CameraFootprintQualityFlag.PARTIAL_COVERAGE so the camera segmentation’s own partial-coverage flag and the PSF-energy partial-coverage flag OR together into one consistent “partial” bit; the other bits use positions the camera flag does not (it uses bit 1 for CENTER_PIXEL_SUBSTITUTED).

Variables:

PARTIAL_COVERAGE – 75% <= coverage < 95% of the PSF’s 95%-energy weight was backed by usable ancillary data (accepted, but flagged partial). Bit 0.
INSUFFICIENT_COVERAGE – coverage < 75% – below the CERES acceptance threshold. The footprint is retained but flagged (a flag-not-discard policy; see the product module). Bit 2.
LIMB_TRUNCATED – The footprint’s bounding box was clipped at the Earth’s limb (BoundingBox.truncated), so it only ever had partial ground coverage. Bit 3.
OFF_LIMB – The view’s centroid is off the Earth’s limb (a space / calibration look), so compute_footprint_bounding_box() reports no Earth footprint at all. The record is retained for index alignment but its external variables are left at their fill sentinel and its coverage is forced to zero – it must never be scored as a real observation. Bit 4.

__init__(*args, **kwds)#

Methods

`conjugate`()	Returns self, the complex conjugate of any int.
`bit_length`()	Number of bits necessary to represent self in binary.
`bit_count`()	Number of ones in the binary representation of the absolute value of self.
`to_bytes`([length, byteorder, signed])	Return an array of bytes representing an integer.
`from_bytes`(bytes[, byteorder, signed])	Return the integer represented by the given array of bytes.
`as_integer_ratio`()	Return a pair of integers, whose ratio is equal to the original int.
`is_integer`()	Returns True.

Attributes

`real`	the real part of a complex number
`imag`	the imaginary part of a complex number
`numerator`	the numerator of a rational number in lowest terms
`denominator`	the denominator of a rational number in lowest terms
`PARTIAL_COVERAGE`
`INSUFFICIENT_COVERAGE`
`LIMB_TRUNCATED`
`OFF_LIMB`

INSUFFICIENT_COVERAGE = 4#

LIMB_TRUNCATED = 8#

OFF_LIMB = 16#

PARTIAL_COVERAGE = 1#

_all_bits_ = 31#

_flag_mask_ = 29#

_inverted_ = None#

_singles_mask_ = 29#

as_integer_ratio()#

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()#: Returns self, the complex conjugate of any int.

denominator#: the denominator of a rational number in lowest terms

classmethod from_bytes(bytes, byteorder='big', *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
signed: Indicates whether two’s complement is used to represent the integer.

imag#: the imaginary part of a complex number

is_integer()#: Returns True. Exists for duck type compatibility with float.is_integer.

numerator#: the numerator of a rational number in lowest terms

real#: the real part of a complex number

to_bytes(length=1, byteorder='big', *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.