Skip to content

Module pygeofilter_aeronet.aeronet_stac_extension

Variables

AERONET_PREFIX

AERONET_SCHEMA_URI

L10_PROP

L15_PROP

L20_PROP

LAND_USE_TYPE_PROP

MOON_L15_PROP

SITE_NAME_PROP

Classes

AeronetExtension

class AeronetExtension(
    item: 'pystac.Item'
)

A concrete implementation of the AERONET extension on a pystac.Item.

All AERONET properties are defined as required in the JSON Schema:

  • aeronet:site_name -> str
  • aeronet:land_use_type -> str
  • aeronet:L10 -> int
  • aeronet:L15 -> int
  • aeronet:L20 -> int
  • aeronet:moon_L15 -> int

Ancestors (in MRO)

  • pystac.extensions.base.PropertiesExtension
  • pystac.extensions.base.ExtensionManagementMixin
  • typing.Generic
  • abc.ABC

Class variables

additional_read_properties

name

Static methods

add_to

def add_to(
    obj: 'S'
) -> 'None'

Add the schema URI for this extension to the

ensure_has_extension

def ensure_has_extension(
    obj: 'S',
    add_if_missing: 'bool' = False
) -> 'None'

Given a :class:~pystac.STACObject, checks if the object has this

extension's schema URI in its :attr:~pystac.STACObject.stac_extensions list. If add_if_missing is True, the schema URI will be added to the object.

Parameters:

Name Type Description Default
obj None The object to validate. None
add_if_missing None Whether to add the schema URI to the object if it is
not already present. Defaults to False.		 None

ensure_owner_has_extension

def ensure_owner_has_extension(
    asset_or_link: 'pystac.Asset | pystac.ItemAssetDefinition | pystac.Link',
    add_if_missing: 'bool' = False
) -> 'None'

Given an :class:~pystac.Asset, checks if the asset's owner has this

extension's schema URI in its :attr:~pystac.STACObject.stac_extensions list. If add_if_missing is True, the schema URI will be added to the owner.

Parameters:

Name Type Description Default
asset None The asset whose owner should be validated. None
add_if_missing None Whether to add the schema URI to the owner if it is
not already present. Defaults to False.		 None

Raises:

Type Description
STACError If add_if_missing is True and asset.owner is
None.

ext

def ext(
    obj: 'pystac.Item',
    add_if_missing: 'bool' = False
) -> "'AeronetExtension'"

from_item

def from_item(
    item: 'pystac.Item',
    add_if_missing: 'bool' = False
) -> "'AeronetExtension'"

get_schema_uri

def get_schema_uri(

) -> 'str'

Gets the schema URI associated with this extension.

get_schema_uris

def get_schema_uris(

) -> 'list[str]'

Gets a list of schema URIs associated with this extension.

has_extension

def has_extension(
    obj: 'pystac.Item'
) -> 'bool'

Check if the given object implements this extension by checking

remove_from

def remove_from(
    obj: 'S'
) -> 'None'

Remove the schema URI for this extension from the

validate_has_extension

def validate_has_extension(
    obj: 'S',
    add_if_missing: 'bool' = False
) -> 'None'

DEPRECATED

.. deprecated:: 1.9 Use :meth:ensure_has_extension instead.

Given a :class:~pystac.STACObject, checks if the object has this extension's schema URI in its :attr:~pystac.STACObject.stac_extensions list. If add_if_missing is True, the schema URI will be added to the object.

Parameters:

Name Type Description Default
obj None The object to validate. None
add_if_missing None Whether to add the schema URI to the object if it is
not already present. Defaults to False.		 None

validate_owner_has_extension

def validate_owner_has_extension(
    asset: 'pystac.Asset | pystac.ItemAssetDefinition',
    add_if_missing: 'bool' = False
) -> 'None'

DEPRECATED

.. deprecated:: 1.9 Use :meth:ensure_owner_has_extension instead.

Given an :class:~pystac.Asset, checks if the asset's owner has this extension's schema URI in its :attr:~pystac.STACObject.stac_extensions list. If add_if_missing is True, the schema URI will be added to the owner.

Parameters:

Name Type Description Default
asset None The asset whose owner should be validated. None
add_if_missing None Whether to add the schema URI to the owner if it is
not already present. Defaults to False.		 None

Raises:

Type Description
STACError If add_if_missing is True and asset.owner is
None.

Instance variables

L10

L15

L20

land_use_type

moon_L15

site_name

Methods

apply

def apply(
    self,
    site_name: 'str',
    land_use_type: 'str',
    L10: 'int',
    L15: 'int',
    L20: 'int',
    moon_L15: 'int'
) -> 'None'