PlanetMaskBandNames#

class PlanetMaskBandNames(value)[source]#

Bases: MaskBandNames

Planet Mask 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 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 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 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

CLEAR = 'CLEAR'#: Planet mask - Usable Data Mask - First band - Clear map

CLOUD = 'CLOUD'#: Planet mask - Usable Data Mask - 6th band - Cloud map

CONFIDENCE = 'CONFIDENCE'#: Planet mask - Usable Data Mask - 7th band - Confidence map

HEAVY_HAZE = 'HEAVY_HAZE'#: Planet mask - Usable Data Mask - 5th band - Heavy haze map (not supported by UDM 2.1 onward)

LIGHT_HAZE = 'LIGHT_HAZE'#: Planet mask - Usable Data Mask - 4th band - Light haze map

SHADOW = 'SHADOW'#: Planet mask - Usable Data Mask - 3rd band - Shadow map

SNOW = 'SNOW'#: Planet mask - Usable Data Mask - 2nd band - Snow map

UDM = 'UDM'#: Planet mask - Unusable Data Mask (Legacy)

UNUSABLE = 'UNUSABLE'#: Planet mask - Usable Data Mask - 8th band - Unusable pixels (Equivalent to the UDM asset)

PlanetMaskBandNames

Contents

PlanetMaskBandNames#