Alignment

class Alignment(value)

Bases: ListEnum

Available alignment methods for series.

CUSTOM = 'custom'

Align the series on a custom mosaic. Not yet implemented.

EXTERNAL = 'external'

Align the series on an external mosaic. Not yet implemented.

FIRST = 'first'

Align the series on the first mosaic.

LAST = 'last'

Align the series on the last mosaic.

MEAN = 'mean'

Align the series on an hypothetical mean mosaic. Not yet implemented.

classmethod convert_from(to_convert: list | str) → list

Convert from a list or a string to an enum instance

Parameters:

to_convert (Union[list, str]) – List or string to convert into an enum instance

Returns:

Converted list

Return type:

list

Example

>>> TsxPolarization.convert_from(["SINGLE", "S", TsxPolarization.QUAD])
[<TsxPolarization.SINGLE: 'S'>, <TsxPolarization.SINGLE: 'S'>, <TsxPolarization.QUAD: 'Q'>]

classmethod from_value(val: Any) → ListEnum

Get the enum class from its value:

Parameters:

val (Any) – Value of the Enum

Returns:

Enum with value

Return type:

ListEnum

Example

>>> TsxPolarization.from_value("Q")
<TsxPolarization.QUAD: 'Q'>

classmethod list_names() → list

Get the name list of this enum:

Example

>>> TsxPolarization.list_values()
["SINGLE", "DUAL", "QUAD", "TWIN"]

classmethod list_values() → list

Get the value list of this enum

Example

>>> TsxPolarization.list_values()
["S", "D", "Q", "T"]