pytac.extensions.ext#

class pystac.extensions.ext.AssetExt(stac_object: Asset)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Add the given extension to the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

property classification: ClassificationExtension[U]#
property cube: DatacubeExtension[U]#
property eo: EOExtension[U]#
property file: FileExtension[Asset]#
has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool#

Whether the given extension is enabled on the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

property pc: PointcloudExtension[U]#
property proj: ProjectionExtension[U]#
property raster: RasterExtension[U]#
remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Remove the given extension from the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

property sar: SarExtension[U]#
property sat: SatExtension[U]#
stac_object: Asset#
property storage: StorageExtension[U]#
property table: TableExtension[U]#
property timestamps: TimestampsExtension[Asset]#
property version: BaseVersionExtension[U]#
property view: ViewExtension[U]#
property xarray: XarrayAssetsExtension[Asset]#
class pystac.extensions.ext.CatalogExt(stac_object: Catalog)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None[source]#

Add the given extension to this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool[source]#

Whether the given extension is enabled on this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None[source]#

Remove the given extension from this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

stac_object: Catalog#
property version: VersionExtension[Catalog]#
class pystac.extensions.ext.CollectionExt(stac_object: Collection)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Add the given extension to this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

property cube: DatacubeExtension[Collection]#
has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool#

Whether the given extension is enabled on this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

property item_assets: dict[str, ItemAssetDefinition]#
remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Remove the given extension from this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

property render: dict[str, Render]#
property sci: ScientificExtension[Collection]#
stac_object: Collection#
property table: TableExtension[Collection]#
property version: VersionExtension[Catalog]#
property xarray: XarrayAssetsExtension[Collection]#
class pystac.extensions.ext.ItemAssetExt(stac_object: ItemAssetDefinition)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Add the given extension to the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

property classification: ClassificationExtension[U]#
property cube: DatacubeExtension[U]#
property eo: EOExtension[U]#
has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool#

Whether the given extension is enabled on the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

property pc: PointcloudExtension[U]#
property proj: ProjectionExtension[U]#
property raster: RasterExtension[U]#
remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Remove the given extension from the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

property sar: SarExtension[U]#
property sat: SatExtension[U]#
stac_object: ItemAssetDefinition#
property storage: StorageExtension[U]#
property table: TableExtension[U]#
property version: BaseVersionExtension[U]#
property view: ViewExtension[U]#
class pystac.extensions.ext.ItemExt(stac_object: Item)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None[source]#

Add the given extension to this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

property classification: ClassificationExtension[Item]#
property cube: DatacubeExtension[Item]#
property eo: EOExtension[Item]#
property grid: GridExtension#
has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool[source]#

Whether the given extension is enabled on this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

property mgrs: MgrsExtension#
property pc: PointcloudExtension[Item]#
property proj: ProjectionExtension[Item]#
remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None[source]#

Remove the given extension from this STAC object

Parameters:

name – Extension identifier (eg: ‘eo’)

property render: RenderExtension[Item]#
property sar: SarExtension[Item]#
property sat: SatExtension[Item]#
property sci: ScientificExtension[Item]#
stac_object: Item#
property storage: StorageExtension[Item]#
property table: TableExtension[Item]#
property timestamps: TimestampsExtension[Item]#
property version: VersionExtension[Item]#
property view: ViewExtension[Item]#
property xarray: XarrayAssetsExtension[Item]#
class pystac.extensions.ext.LinkExt(stac_object: Link)[source]#

Supporting the ext accessor for interacting with extension classes

add(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Add the given extension to the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

property file: FileExtension[Link]#
has(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) bool#

Whether the given extension is enabled on the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

Returns:

True if extension is enabled, otherwise False

Return type:

bool

remove(name: Literal['classification', 'cube', 'eo', 'file', 'grid', 'item_assets', 'mgrs', 'pc', 'proj', 'raster', 'render', 'sar', 'sat', 'sci', 'storage', 'table', 'timestamps', 'version', 'view', 'xarray']) None#

Remove the given extension from the owner

Parameters:

name – Extension identifier (eg: ‘eo’)

stac_object: Link#
class pystac.extensions.ext.T#

Generalized version of Asset, ItemAssetDefinition, or Link

alias of TypeVar(‘T’, ~pystac.asset.Asset, ~pystac.item_assets.ItemAssetDefinition, ~pystac.link.Link)

class pystac.extensions.ext.U#

Generalized version of Asset or ItemAssetDefinition

alias of TypeVar(‘U’, ~pystac.asset.Asset, ~pystac.item_assets.ItemAssetDefinition)