SarBandNames

class SarBandNames(value)

Bases: BandNames

SAR Band names

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 corresponding_despeckle(band: SarBandNames)

Corresponding despeckled band.

>>> SarBandNames.corresponding_despeckle(SarBandNames.VV)
<SarBandNames.VV_DSPK: 'VV_DSPK'>
>>> SarBandNames.corresponding_despeckle(SarBandNames.VV_DSPK)
<SarBandNames.VV_DSPK: 'VV_DSPK'>

Parameters:

band (SarBandNames) – Noisy (speckle) band

Returns:

Despeckled band

Return type:

SarBandNames

classmethod corresponding_speckle(band: SarBandNames)

Corresponding speckle (noisy) band.

>>> SarBandNames.corresponding_speckle(SarBandNames.VV)
<SarBandNames.VV: 'VV'>
>>> SarBandNames.corresponding_speckle(SarBandNames.VV_DSPK)
<SarBandNames.VV: 'VV'>

Parameters:

band (SarBandNames) – Noisy (speckle) band

Returns:

Despeckled band

Return type:

SarBandNames

classmethod from_list(name_list: list | str) → list

Get the band enums from list of band names

>>> SarBandNames.from_list("VV")
[<SarBandNames.VV: 'VV'>]

Parameters:

name_list (Union[list, str]) – List of names

Returns:

List of enums

Return type:

list

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 is_despeckle(band: SarBandNames)

Returns True if the band corresponds to a despeckled one.

>>> SarBandNames.is_despeckle(SarBandNames.VV)
False
>>> SarBandNames.is_despeckle(SarBandNames.VV_DSPK)
True

Parameters:

band (SarBandNames) – Band to test

Returns:

Despeckled band

Return type:

SarBandNames

classmethod is_speckle(band: SarBandNames)

Returns True if the band corresponds to a speckle one.

>>> SarBandNames.is_despeckle(SarBandNames.VV)
True
>>> SarBandNames.is_despeckle(SarBandNames.VV_DSPK)
False

Parameters:

band (SarBandNames) – Band to test

Returns:

Despeckled band

Return type:

SarBandNames

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"]

classmethod speckle_list()

classmethod to_value_list(name_list: list | None = None) → list

Get a list from the values of the bands

 >>> SarBandNames.to_name_list([SarBandNames.HV_DSPK, SarBandNames.VV])
['HV_DSPK', 'VV']
>>> SarBandNames.to_name_list()
['VV', 'VV_DSPK', 'HH', 'HH_DSPK', 'VH', 'VH_DSPK', 'HV', 'HV_DSPK']

Parameters:

name_list (list) – List of band names

Returns:

List of band values

Return type:

list

HH = 'HH'

Horizontal Transmit-Horizontal Receive Polarisation

HH_DSPK = 'HH_DSPK'

Horizontal Transmit-Horizontal Receive Polarisation (Despeckled)

HV = 'HV'

Horizontal Transmit-Vertical Receive Polarisation

HV_DSPK = 'HV_DSPK'

Horizontal Transmit-Vertical Receive Polarisation (Despeckled)

RH = 'RH'

right circular transmit, horizontal receive

Type:

Compact polarization

RH_DSPK = 'RH_DSPK'

right circular transmit, horizontal receive

Type:

Compact polarization

RV = 'RV'

right circular transmit, vertical receive (Despeckled)

Type:

Compact polarization

RV_DSPK = 'RV_DSPK'

right circular transmit, horizontal receive (Despeckled)

Type:

Compact polarization

VH = 'VH'

Vertical Transmit-Horizontal Receive Polarisation

VH_DSPK = 'VH_DSPK'

Vertical Transmit-Horizontal Receive Polarisation (Despeckled)

VV = 'VV'

Vertical Transmit-Vertical Receive Polarisation

VV_DSPK = 'VV_DSPK'

Vertical Transmit-Vertical Receive Polarisation (Despeckled)