CustomFields

class CustomFields(value)

Bases: ListEnum

Custom fields, self-explanatory

classmethod convert_from(to_convert: list | str) → list

Convert from a list or a string to an enum instance

Parameters:

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

BAND_MAP = 'band_map'

Custom band map. Mandatory.

CC = 'cloud_cover'

Custom cloud cover.

CONDENSED_NAME = 'condensed_name'

Custom condensed name. Overrides computed custom name.

CONSTELLATION = 'constellation'

Custom constellation.

DATETIME = 'datetime'

Custom datetime.

ID = 'id'

ID to be added at the end of the condensed name. Not used in case of a given condensed name.

INSTRUMENT = 'instrument'

Custom instrument.

NAME = 'name'

Custom name. Default is the filename.

ORBIT_DIR = 'orbit_direction'

Custom orbit direction.

PIX_SIZE = 'pixel_size'

Custom pixel size. Default is the pixel size of the stack.

PROD_TYPE = 'product_type'

Custom product type.

SENSOR_TYPE = 'sensor_type'

Custom sensor type.

SUN_AZ = 'sun_azimuth'

Custom sun zimuth.

SUN_ZEN = 'sun_zenith'

Custom sun_zenith.