StacItemAsset Class

https://github.com/stac-extensions/item-assets

Represents a STAC item asset, which describes the assets available under any item in the collection.

Constructor

StacItemAsset(*args: Any, **kwargs: Any)

Variables

Name	Description
platform	str Platform that acquired the data.
instruments	list[str] Instruments that acquired the data.
constellation	str Constellation of satellites that acquired the data.
mission	str Mission associated with the data.
providers	list[StacProvider] Organizations or individuals who provide the data.
gsd	float Ground sample distance in meters.
created	datetime Creation timestamp of the data.
updated	datetime Last update timestamp of the data.
title	str Human-readable title for the asset. Required.
description	str Detailed description of the asset.
href	str URL to the asset file.
type	str Media type of the asset. Required.
roles	list[str] Roles of the asset within the item.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

constellation

Constellation of satellites that acquired the data.

constellation: str | None

created

Creation timestamp of the data.

created: datetime | None

description

Detailed description of the asset.

description: str | None

gsd

Ground sample distance in meters.

gsd: float | None

href

URL to the asset file.

href: str | None

instruments

Instruments that acquired the data.

instruments: list[str] | None

mission

Mission associated with the data.

mission: str | None

platform

Platform that acquired the data.

platform: str | None

providers

Organizations or individuals who provide the data.

providers: list['_models.StacProvider'] | None

roles

Roles of the asset within the item.

roles: list[str] | None

title

Human-readable title for the asset. Required.

title: str

type

Media type of the asset. Required.

type: str

updated

Last update timestamp of the data.

updated: datetime | None

Feedback

Was this page helpful?