Dataset#
- class datacube.model.Dataset(product, metadata_doc, uris=None, uri=None, sources=None, indexed_by=None, indexed_time=None, archived_time=None, source_tree=None, derived_tree=None)[source]#
A Dataset. A container of metadata, and refers typically to a multi-band raster on disk.
Most important parts are the metadata_doc and uri.
Dataset objects should be constructed by an index driver, or with the datacube.index.hl.Doc2Dataset
- Parameters
- Members
Attributes:
Optional
[BoundingBox
] :returns: bounding box of the dataset in the native crsmid-point of time range
Return CRS if available
valid extent of the dataset or None
UUID of a dataset
The User who indexed this dataset
Is this dataset active?
Is this dataset archived?
datetime.datetime
A path to this dataset on the local filesystem (if available).
Return the uri if it is local, or None.
The document describing the dataset as a dictionary.
The datasets that this dataset is derived from (if requested on load).
List of active locations, newest to oldest.
Methods:
legacy_uri
([schema])This is a 1.9-2.0 transitional method and will be removed in 2.0.
Return metadata document without nested lineage datasets
- property bounds: Optional[odc.geo.geom.BoundingBox]#
Optional
[BoundingBox
] :returns: bounding box of the dataset in the native crs- Type
rtype
- center_time#
mid-point of time range
- extent#
valid extent of the dataset or None
- Type
returns
- indexed_by#
The User who indexed this dataset
- property is_archived: bool#
Is this dataset archived?
(an archived dataset is one that is not intended to be used by users anymore: eg. it has been replaced by another dataset. It will not show up in search results, but still exists in the system via provenance chains or through id lookup.)
- Return type
- key_time#
datetime.datetime
- Type
rtype
- legacy_uri(schema=None)[source]#
This is a 1.9-2.0 transitional method and will be removed in 2.0.
If the dataset has only one location, it returns that uri, but if the dataset has multiple locations, it calls various deprecated methods to achieve the legacy behaviour. It is intended for internal core use only.
- property local_path: Optional[pathlib.Path]#
A path to this dataset on the local filesystem (if available).
- property local_uri: Optional[str]#
Return the uri if it is local, or None.
Legacy behaviour: The latest local file uri, if any.
- metadata_doc#
The document describing the dataset as a dictionary. It is often serialised as YAML on disk or inside a NetCDF file, and as JSON-B inside the database index.
- sources#
The datasets that this dataset is derived from (if requested on load).