libera_utils.constants.LiberaApid#

class libera_utils.constants.LiberaApid(value)#

Bases: IntEnum

APIDs for packets

The enum names here should be of the form <packet-source>_<system>_<contents>. e.g. for icie_rad_sample: packet_source is Libera “ICIE”, the system is the “Radiometers”, and the contents is radiometer “Samples”.

Notes

This is useful for identifying the data product type from the APID in an L0 filename.

The enum names (e.g. icie_seq_hk) for Libera packets here should be precisely the packet names used in FSW documents and packet definitions.

Attributes:

denominator: the denominator of a rational number in lowest terms
imag: the imaginary part of a complex number
numerator: the numerator of a rational number in lowest terms
real: the real part of a complex number

Methods

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

__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 integer ratio.

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
`data_product_id`	Get the DataProductIdentifier for L0 PDS files with this APID
`jpss_sc_pos`
`icie_sw_stat`
`icie_seq_hk`
`icie_fp_hk`
`icie_log_msg`
`icie_rad_full`
`icie_rad_sample`
`icie_axis_hk`
`icie_wfov_hk`
`icie_wfov_sci`
`icie_cal_full`
`icie_cal_sample`
`icie_axis_sample`
`icie_wfov_resp`
`icie_crit_hk`
`icie_nom_hk`
`icie_ana_hk`
`icie_temp_hk`

as_integer_ratio(/)#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with 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.

property data_product_id: DataProductIdentifier#

Get the DataProductIdentifier for L0 PDS files with this APID

This relies on the strict naming convention that the packet name is part of the L0 data product ID name

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

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.

libera_utils.constants.LiberaApid#

This Page