StacCollection Class

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md

Represents a STAC collection.

Constructor

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

Variables

Name	Description
created_on	datetime MSFT Created.
updated_on	datetime MSFT Updated.
short_description	str MSFT Short Description.
stac_extensions	list[str] URLs to STAC extensions implemented by this STAC resource.
id	str Unique identifier for the collection. Required.
description	str Detailed description of the collection. Required.
stac_version	str Stac Version.
links	list[StacLink] Links to related resources and endpoints. Required.
title	str Human-readable title for the collection.
type	str Type.
assets	dict[str, StacAsset] Assets.
item_assets	dict[str, StacItemAsset] Item Assets See the Item Assets Definition Extension Specification.
license	str License identifier for the collection data. Required.
extent	StacExtensionExtent Spatial and temporal extent of the collection. Required.
keywords	list[str] Keywords describing the collection.
providers	list[StacProvider] Organizations or individuals who provide the collection data.
summaries	dict[str, any] Summaries See the STAC Collection Spec.

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

assets

Assets.

assets: dict[str, '_models.StacAsset'] | None

created_on

MSFT Created.

created_on: datetime | None

description

Detailed description of the collection. Required.

description: str

extent

Spatial and temporal extent of the collection. Required.

extent: _models.StacExtensionExtent

id

Unique identifier for the collection. Required.

id: str

item_assets

Item Assets

See the Item Assets Definition Extension Specification.

item_assets: dict[str, '_models.StacItemAsset'] | None

keywords

Keywords describing the collection.

keywords: list[str] | None

license

License identifier for the collection data. Required.

license: str

links

Links to related resources and endpoints. Required.

links: list['_models.StacLink']

providers

Organizations or individuals who provide the collection data.

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

short_description

MSFT Short Description.

short_description: str | None

stac_extensions

URLs to STAC extensions implemented by this STAC resource.

stac_extensions: list[str] | None

stac_version

Stac Version.

stac_version: str | None

summaries

Summaries

See the STAC Collection Spec.

summaries: dict[str, Any] | None

title

Human-readable title for the collection.

title: str | None

type

Type.

type: str | None

updated_on

MSFT Updated.

updated_on: datetime | None

Feedback

Was this page helpful?