API

The following pages provide a full API reference for the datacube python library.

Core Classes & Data Model

• Datacube Class
• Dataset
• Product
• Geometry Classes
• Measurement
• Metadata Type
• LineageTree
• Range
• Query

Querying & Loading Data

• Dataset & Product Discovery
• Dataset Querying
• Product Querying
• Data Loading
• Masking
• Bit Masking

Managing Data

• Dataset Writing
  • datacube.index.abstract.AbstractDatasetResource.add
    • AbstractDatasetResource.add()
  • datacube.index.abstract.AbstractDatasetResource.add_location
    • AbstractDatasetResource.add_location()
  • datacube.index.abstract.AbstractDatasetResource.archive
    • AbstractDatasetResource.archive()
  • datacube.index.abstract.AbstractDatasetResource.archive_location
    • AbstractDatasetResource.archive_location()
  • datacube.index.abstract.AbstractDatasetResource.remove_location
    • AbstractDatasetResource.remove_location()
  • datacube.index.abstract.AbstractDatasetResource.restore
    • AbstractDatasetResource.restore()
  • datacube.index.abstract.AbstractDatasetResource.restore_location
    • AbstractDatasetResource.restore_location()
  • datacube.index.abstract.AbstractDatasetResource.update
    • AbstractDatasetResource.update()
  • Doc2Dataset
• Product Writing
  • datacube.index.abstract.AbstractProductResource.from_doc
    • AbstractProductResource.from_doc()
  • datacube.index.abstract.AbstractProductResource.add
    • AbstractProductResource.add()
  • datacube.index.abstract.AbstractProductResource.update
    • AbstractProductResource.update()
  • datacube.index.abstract.AbstractProductResource.update_document
    • AbstractProductResource.update_document()
  • datacube.index.abstract.AbstractProductResource.add_document
    • AbstractProductResource.add_document()
• Index API
  • datacube.index.abstract
    • AbstractDatasetResource
      • AbstractDatasetResource.add()
      • AbstractDatasetResource.add_location()
      • AbstractDatasetResource.archive()
      • AbstractDatasetResource.archive_less_mature()
      • AbstractDatasetResource.archive_location()
      • AbstractDatasetResource.bulk_add()
      • AbstractDatasetResource.bulk_get()
      • AbstractDatasetResource.bulk_has()
      • AbstractDatasetResource.can_update()
      • AbstractDatasetResource.count()
      • AbstractDatasetResource.count_by_product()
      • AbstractDatasetResource.count_by_product_through_time()
      • AbstractDatasetResource.count_product_through_time()
      • AbstractDatasetResource.find_less_mature()
      • AbstractDatasetResource.get()
      • AbstractDatasetResource.get_all_dataset_ids()
      • AbstractDatasetResource.get_all_docs()
      • AbstractDatasetResource.get_archived_location_times()
      • AbstractDatasetResource.get_archived_locations()
      • AbstractDatasetResource.get_datasets_for_location()
      • AbstractDatasetResource.get_derived()
      • AbstractDatasetResource.get_field_names()
      • AbstractDatasetResource.get_location()
      • AbstractDatasetResource.get_locations()
      • AbstractDatasetResource.get_product_time_bounds()
      • AbstractDatasetResource.get_unsafe()
      • AbstractDatasetResource.has()
      • AbstractDatasetResource.purge()
      • AbstractDatasetResource.remove_location()
      • AbstractDatasetResource.restore()
      • AbstractDatasetResource.restore_location()
      • AbstractDatasetResource.search()
      • AbstractDatasetResource.search_by_metadata()
      • AbstractDatasetResource.search_by_product()
      • AbstractDatasetResource.search_eager()
      • AbstractDatasetResource.search_product_duplicates()
      • AbstractDatasetResource.search_returning()
      • AbstractDatasetResource.search_returning_datasets_light()
      • AbstractDatasetResource.search_summaries()
      • AbstractDatasetResource.spatial_extent()
      • AbstractDatasetResource.temporal_extent()
      • AbstractDatasetResource.update()
    • AbstractIndex
      • AbstractIndex.clone()
      • AbstractIndex.close()
      • AbstractIndex.create_spatial_index()
      • AbstractIndex.datasets
      • AbstractIndex.drop_spatial_index()
      • AbstractIndex.environment
      • AbstractIndex.from_config()
      • AbstractIndex.get_dataset_fields()
      • AbstractIndex.index_id
      • AbstractIndex.init_db()
      • AbstractIndex.lineage
      • AbstractIndex.metadata_types
      • AbstractIndex.name
      • AbstractIndex.products
      • AbstractIndex.spatial_indexes()
      • AbstractIndex.thread_transaction()
      • AbstractIndex.transaction()
      • AbstractIndex.update_spatial_index()
      • AbstractIndex.url
      • AbstractIndex.users
    • AbstractIndexDriver
      • AbstractIndexDriver.get_config_option_handlers()
    • AbstractLineageResource
      • AbstractLineageResource.add()
      • AbstractLineageResource.bulk_add()
      • AbstractLineageResource.clear_home()
      • AbstractLineageResource.get_all_lineage()
      • AbstractLineageResource.get_derived_tree()
      • AbstractLineageResource.get_homes()
      • AbstractLineageResource.get_source_tree()
      • AbstractLineageResource.merge()
      • AbstractLineageResource.remove()
      • AbstractLineageResource.set_home()
    • AbstractMetadataTypeResource
      • AbstractMetadataTypeResource.add()
      • AbstractMetadataTypeResource.bulk_add()
      • AbstractMetadataTypeResource.can_update()
      • AbstractMetadataTypeResource.check_field_indexes()
      • AbstractMetadataTypeResource.from_doc()
      • AbstractMetadataTypeResource.get()
      • AbstractMetadataTypeResource.get_all()
      • AbstractMetadataTypeResource.get_all_docs()
      • AbstractMetadataTypeResource.get_by_name()
      • AbstractMetadataTypeResource.get_by_name_unsafe()
      • AbstractMetadataTypeResource.get_unsafe()
      • AbstractMetadataTypeResource.get_with_fields()
      • AbstractMetadataTypeResource.update()
      • AbstractMetadataTypeResource.update_document()
    • AbstractProductResource
      • AbstractProductResource.add()
      • AbstractProductResource.add_document()
      • AbstractProductResource.bulk_add()
      • AbstractProductResource.can_update()
      • AbstractProductResource.delete()
      • AbstractProductResource.from_doc()
      • AbstractProductResource.get()
      • AbstractProductResource.get_all()
      • AbstractProductResource.get_all_docs()
      • AbstractProductResource.get_by_name()
      • AbstractProductResource.get_by_name_unsafe()
      • AbstractProductResource.get_field_names()
      • AbstractProductResource.get_unsafe()
      • AbstractProductResource.get_with_fields()
      • AbstractProductResource.get_with_types()
      • AbstractProductResource.most_recent_change()
      • AbstractProductResource.search()
      • AbstractProductResource.search_by_metadata()
      • AbstractProductResource.search_robust()
      • AbstractProductResource.spatial_extent()
      • AbstractProductResource.temporal_extent()
      • AbstractProductResource.update()
      • AbstractProductResource.update_document()
    • AbstractTransaction
      • AbstractTransaction.active
      • AbstractTransaction.begin()
      • AbstractTransaction.commit()
      • AbstractTransaction.rollback()
    • AbstractUserResource
      • AbstractUserResource.create_user()
      • AbstractUserResource.delete_user()
      • AbstractUserResource.grant_role()
      • AbstractUserResource.list_users()
    • BatchStatus
      • BatchStatus.count()
      • BatchStatus.index()
    • DatasetTuple
      • DatasetTuple.count()
      • DatasetTuple.index()
    • NoLineageResource
      • NoLineageResource.add()
      • NoLineageResource.bulk_add()
      • NoLineageResource.clear_home()
      • NoLineageResource.get_all_lineage()
      • NoLineageResource.get_derived_tree()
      • NoLineageResource.get_homes()
      • NoLineageResource.get_source_tree()
      • NoLineageResource.merge()
      • NoLineageResource.remove()
      • NoLineageResource.set_home()
    • UnhandledTransaction
      • UnhandledTransaction.active
      • UnhandledTransaction.begin()
      • UnhandledTransaction.commit()
      • UnhandledTransaction.rollback()
    • default_metadata_type_docs()
    • dsid_to_uuid()

Configuration API

• Configuration API
  • Executive Summary
    • datacube.cfg.ODCConfig.get_environment
      • ODCConfig.get_environment()
  • Full API
    • ODCConfig
      • ODCConfig.allow_envvar_overrides
      • ODCConfig.raw_text
      • ODCConfig.raw_config
      • ODCConfig.known_environments
      • ODCConfig.canonical_names
      • ODCConfig.get_aliases()
      • ODCConfig.get_environment()
    • ConfigException
      • ConfigException.add_note()
      • ConfigException.with_traceback()
    • ODCEnvironment

Utilities

• Amazon Web Services (AWS)
  • datacube.utils.aws.s3_client
    • s3_client()
  • datacube.utils.aws.s3_open
    • s3_open()
  • datacube.utils.aws.s3_head_object
    • s3_head_object()
  • datacube.utils.aws.s3_fetch
    • s3_fetch()
  • datacube.utils.aws.s3_dump
    • s3_dump()
  • datacube.utils.aws.s3_url_parse
    • s3_url_parse()
  • datacube.utils.aws.auto_find_region
    • auto_find_region()
  • datacube.utils.aws.get_aws_settings
    • get_aws_settings()
  • datacube.utils.aws.get_creds_with_retry
    • get_creds_with_retry()
  • datacube.utils.aws.mk_boto_session
    • mk_boto_session()
  • datacube.utils.aws.ec2_current_region
    • ec2_current_region()
  • datacube.utils.aws.ec2_metadata
    • ec2_metadata()
  • datacube.utils.aws.configure_s3_access
    • configure_s3_access()
• Writing GeoTIFFs
  • datacube.utils.cog.write_cog
    • write_cog()
  • datacube.utils.cog.to_cog
    • to_cog()
• Dask
  • datacube.utils.dask.start_local_dask
    • start_local_dask()
  • datacube.utils.dask.partition_map
    • partition_map()
  • datacube.utils.dask.pmap
    • pmap()
  • datacube.utils.dask.compute_tasks
    • compute_tasks()
  • datacube.utils.dask.save_blob_to_file
    • save_blob_to_file()
  • datacube.utils.dask.save_blob_to_s3
    • save_blob_to_s3()
• Geometry
  • Creating Geometries
    • datacube.utils.geometry.point
      • point()
    • datacube.utils.geometry.multipoint
      • multipoint()
    • datacube.utils.geometry.line
      • line()
    • datacube.utils.geometry.multiline
      • multiline()
    • datacube.utils.geometry.polygon
      • polygon()
    • datacube.utils.geometry.multipolygon
      • multipolygon()
    • datacube.utils.geometry.multigeom
      • multigeom()
    • datacube.utils.geometry.box
      • box()
    • datacube.utils.geometry.sides
      • sides()
    • datacube.utils.geometry.polygon_from_transform
      • polygon_from_transform()
  • Spatial Operations
    • datacube.utils.geometry.unary_union
      • unary_union()
    • datacube.utils.geometry.unary_intersection
      • unary_intersection()
    • datacube.utils.geometry.bbox_union
      • bbox_union()
    • datacube.utils.geometry.bbox_intersection
      • bbox_intersection()
    • datacube.utils.geometry.lonlat_bounds
      • lonlat_bounds()
    • datacube.utils.geometry.projected_lon
      • projected_lon()
    • datacube.utils.geometry.clip_lon180
      • clip_lon180()
    • datacube.utils.geometry.chop_along_antimeridian
      • chop_along_antimeridian()
  • Utilities
    • datacube.utils.geometry.assign_crs
      • assign_crs()
    • datacube.utils.geometry.crs_units_per_degree
      • crs_units_per_degree()
    • datacube.utils.geometry.geobox_union_conservative
      • geobox_union_conservative()
    • datacube.utils.geometry.geobox_intersection_conservative
      • geobox_intersection_conservative()
    • datacube.utils.geometry.scaled_down_geobox
      • scaled_down_geobox()
    • datacube.utils.geometry.intersects
      • intersects()
    • datacube.utils.geometry.common_crs
      • common_crs()
    • datacube.utils.geometry.is_affine_st
      • is_affine_st()
    • datacube.utils.geometry.apply_affine
      • apply_affine()
    • datacube.utils.geometry.roi_boundary
      • roi_boundary()
    • datacube.utils.geometry.roi_is_empty
      • roi_is_empty()
    • datacube.utils.geometry.roi_is_full
      • roi_is_full()
    • datacube.utils.geometry.roi_intersect
      • roi_intersect()
    • datacube.utils.geometry.roi_shape
      • roi_shape()
    • datacube.utils.geometry.roi_normalise
      • roi_normalise()
    • datacube.utils.geometry.roi_from_points
      • roi_from_points()
    • datacube.utils.geometry.roi_center
      • roi_center()
    • datacube.utils.geometry.roi_pad
      • roi_pad()
    • datacube.utils.geometry.scaled_down_shape
      • scaled_down_shape()
    • datacube.utils.geometry.scaled_down_roi
      • scaled_down_roi()
    • datacube.utils.geometry.scaled_up_roi
      • scaled_up_roi()
    • datacube.utils.geometry.decompose_rws
      • decompose_rws()
    • datacube.utils.geometry.affine_from_pts
      • affine_from_pts()
    • datacube.utils.geometry.get_scale_at_point
      • get_scale_at_point()
    • datacube.utils.geometry.native_pix_transform
      • native_pix_transform()
    • datacube.utils.geometry.compute_reproject_roi
      • compute_reproject_roi()
    • datacube.utils.geometry.split_translation
      • split_translation()
    • datacube.utils.geometry.compute_axis_overlap
      • compute_axis_overlap()
    • datacube.utils.geometry.w_
      • w_
    • datacube.utils.geometry.warp_affine
      • warp_affine()
    • datacube.utils.geometry.rio_reproject
      • rio_reproject()