sentinelhub.api

The part of the package that implements interface with Sentinel Hub services.

• sentinelhub.api.batch
  • sentinelhub.api.batch.base
    • BatchRequestStatus
      • BatchRequestStatus.CREATED
      • BatchRequestStatus.ANALYSING
      • BatchRequestStatus.ANALYSIS_DONE
      • BatchRequestStatus.PROCESSING
      • BatchRequestStatus.DONE
      • BatchRequestStatus.FAILED
      • BatchRequestStatus.STOPPED
    • BatchUserAction
      • BatchUserAction.START
      • BatchUserAction.ANALYSE
      • BatchUserAction.STOP
      • BatchUserAction.NONE
    • StoppedStatusReason
      • StoppedStatusReason.OUT_OF_PU
      • StoppedStatusReason.USER_ACTION
      • StoppedStatusReason.UNHEALTHY
    • BaseBatchClient
    • BaseBatchRequest
      • BaseBatchRequest.request_id
      • BaseBatchRequest.error
      • BaseBatchRequest.status
      • BaseBatchRequest.to_dict()
      • BaseBatchRequest.from_dict()
      • BaseBatchRequest.raise_for_status()
  • sentinelhub.api.batch.process
    • BatchProcessClient
      • BatchProcessClient.s3_specification()
      • BatchProcessClient.create()
      • BatchProcessClient.geopackage_input()
      • BatchProcessClient.tiling_grid_input()
      • BatchProcessClient.raster_output()
      • BatchProcessClient.zarr_output()
      • BatchProcessClient.iter_requests()
      • BatchProcessClient.get_request()
      • BatchProcessClient.update_request()
      • BatchProcessClient.start_analysis()
      • BatchProcessClient.start_job()
      • BatchProcessClient.stop_job()
      • BatchProcessClient.iter_tiling_grids()
      • BatchProcessClient.get_tiling_grid()
    • BatchProcessRequest
      • BatchProcessRequest.request_id
      • BatchProcessRequest.request
      • BatchProcessRequest.domain_account_id
      • BatchProcessRequest.status
      • BatchProcessRequest.error
      • BatchProcessRequest.user_action
      • BatchProcessRequest.user_action_updated
      • BatchProcessRequest.created
      • BatchProcessRequest.completion_percentage
      • BatchProcessRequest.last_updated
      • BatchProcessRequest.cost_PU
      • BatchProcessRequest.stopped_status_reason
      • BatchProcessRequest.other_data
      • BatchProcessRequest.dataclass_json_config
      • BatchProcessRequest.from_dict()
      • BatchProcessRequest.from_json()
      • BatchProcessRequest.schema()
      • BatchProcessRequest.to_dict()
      • BatchProcessRequest.to_json()
  • sentinelhub.api.batch.process_v2
  • sentinelhub.api.batch.statistical
    • SentinelHubBatchStatistical
      • SentinelHubBatchStatistical.s3_specification()
      • SentinelHubBatchStatistical.create()
      • SentinelHubBatchStatistical.create_from_request()
      • SentinelHubBatchStatistical.get_request()
      • SentinelHubBatchStatistical.get_status()
      • SentinelHubBatchStatistical.start_analysis()
      • SentinelHubBatchStatistical.start_job()
      • SentinelHubBatchStatistical.cancel_job()
      • SentinelHubBatchStatistical.stop_job()
    • BatchStatisticalRequest
      • BatchStatisticalRequest.request_id
      • BatchStatisticalRequest.completion_percentage
      • BatchStatisticalRequest.request
      • BatchStatisticalRequest.status
      • BatchStatisticalRequest.user_id
      • BatchStatisticalRequest.created
      • BatchStatisticalRequest.cost_pu
      • BatchStatisticalRequest.user_action
      • BatchStatisticalRequest.user_action_updated
      • BatchStatisticalRequest.error
      • BatchStatisticalRequest.other_data
      • BatchStatisticalRequest.dataclass_json_config
      • BatchStatisticalRequest.from_dict()
      • BatchStatisticalRequest.from_json()
      • BatchStatisticalRequest.schema()
      • BatchStatisticalRequest.to_dict()
      • BatchStatisticalRequest.to_json()
  • sentinelhub.api.batch.utils
    • monitor_batch_process_job()
    • monitor_batch_statistical_job()
    • monitor_batch_process_analysis()
    • monitor_batch_statistical_analysis()

• sentinelhub.api.base
  • SentinelHubService
  • SentinelHubFeatureIterator
  • BaseCollection
    • BaseCollection.name
    • BaseCollection.s3_bucket
    • BaseCollection.additional_data
    • BaseCollection.collection_id
    • BaseCollection.user_id
    • BaseCollection.created
    • BaseCollection.no_data
    • BaseCollection.other_data
    • BaseCollection.to_data_collection()
    • BaseCollection.dataclass_json_config
    • BaseCollection.from_dict()
    • BaseCollection.from_json()
    • BaseCollection.schema()
    • BaseCollection.to_dict()
    • BaseCollection.to_json()
• sentinelhub.api.base_request
  • SentinelHubBaseApiRequest
    • SentinelHubBaseApiRequest.payload
    • SentinelHubBaseApiRequest.mime_type
    • SentinelHubBaseApiRequest.create_request()
    • SentinelHubBaseApiRequest.input_data()
    • SentinelHubBaseApiRequest.bounds()
  • InputDataDict
• sentinelhub.api.byoc
  • ByocCollectionBand
    • ByocCollectionBand.source
    • ByocCollectionBand.band_index
    • ByocCollectionBand.bit_depth
    • ByocCollectionBand.sample_format
    • ByocCollectionBand.no_data
    • ByocCollectionBand.other_data
    • ByocCollectionBand.dataclass_json_config
    • ByocCollectionBand.from_dict()
    • ByocCollectionBand.from_json()
    • ByocCollectionBand.schema()
    • ByocCollectionBand.to_dict()
    • ByocCollectionBand.to_json()
  • ByocCollectionAdditionalData
    • ByocCollectionAdditionalData.bands
    • ByocCollectionAdditionalData.max_meters_per_pixel
    • ByocCollectionAdditionalData.max_meters_per_pixel_override
    • ByocCollectionAdditionalData.other_data
    • ByocCollectionAdditionalData.dataclass_json_config
    • ByocCollectionAdditionalData.from_dict()
    • ByocCollectionAdditionalData.from_json()
    • ByocCollectionAdditionalData.schema()
    • ByocCollectionAdditionalData.to_dict()
    • ByocCollectionAdditionalData.to_json()
  • ByocCollection
    • ByocCollection.additional_data
    • ByocCollection.dataclass_json_config
    • ByocCollection.from_dict()
    • ByocCollection.from_json()
    • ByocCollection.schema()
    • ByocCollection.to_dict()
    • ByocCollection.to_json()
  • ByocTile
    • ByocTile.path
    • ByocTile.status
    • ByocTile.tile_id
    • ByocTile.tile_geometry
    • ByocTile.cover_geometry
    • ByocTile.created
    • ByocTile.sensing_time
    • ByocTile.ingestion_start
    • ByocTile.additional_data
    • ByocTile.other_data
    • ByocTile.dataclass_json_config
    • ByocTile.from_dict()
    • ByocTile.from_json()
    • ByocTile.schema()
    • ByocTile.to_dict()
    • ByocTile.to_json()
  • SentinelHubBYOC
    • SentinelHubBYOC.iter_collections()
    • SentinelHubBYOC.get_collection()
    • SentinelHubBYOC.create_collection()
    • SentinelHubBYOC.update_collection()
    • SentinelHubBYOC.delete_collection()
    • SentinelHubBYOC.copy_tiles()
    • SentinelHubBYOC.iter_tiles()
    • SentinelHubBYOC.get_tile()
    • SentinelHubBYOC.create_tile()
    • SentinelHubBYOC.update_tile()
    • SentinelHubBYOC.delete_tile()
    • SentinelHubBYOC.reingest_tile()
• sentinelhub.api.catalog
  • SentinelHubCatalog
    • SentinelHubCatalog.get_info()
    • SentinelHubCatalog.get_conformance()
    • SentinelHubCatalog.get_collections()
    • SentinelHubCatalog.get_collection()
    • SentinelHubCatalog.get_feature()
    • SentinelHubCatalog.search()
  • CatalogSearchIterator
    • CatalogSearchIterator.get_timestamps()
    • CatalogSearchIterator.get_geometries()
    • CatalogSearchIterator.get_ids()
  • get_available_timestamps()
• sentinelhub.api.ogc
  • CustomUrlParam
    • CustomUrlParam.SHOWLOGO
    • CustomUrlParam.EVALSCRIPT
    • CustomUrlParam.EVALSCRIPTURL
    • CustomUrlParam.PREVIEW
    • CustomUrlParam.QUALITY
    • CustomUrlParam.UPSAMPLING
    • CustomUrlParam.DOWNSAMPLING
    • CustomUrlParam.GEOMETRY
    • CustomUrlParam.MINQA
    • CustomUrlParam.has_value()
    • CustomUrlParam.get_string()
  • OgcRequest
    • OgcRequest.create_request()
    • OgcRequest.get_dates()
    • OgcRequest.get_tiles()
  • WmsRequest
  • WcsRequest
  • OgcImageService
    • OgcImageService.get_request()
    • OgcImageService.get_url()
    • OgcImageService.get_base_url()
    • OgcImageService.get_dates()
    • OgcImageService.get_image_dimensions()
    • OgcImageService.get_wfs_iterator()
• sentinelhub.api.opensearch
  • TileMissingException
  • get_tile_info_id()
  • get_tile_info()
  • get_area_info()
  • get_area_dates()
  • reduce_by_maxcc()
  • search_iter()
• sentinelhub.api.process
  • SentinelHubRequest
    • SentinelHubRequest.mime_type
    • SentinelHubRequest.body()
    • SentinelHubRequest.output_response()
    • SentinelHubRequest.output()
  • AsyncProcessRequest
    • AsyncProcessRequest.s3_specification()
    • AsyncProcessRequest.mime_type
    • AsyncProcessRequest.body()
    • AsyncProcessRequest.output_response()
    • AsyncProcessRequest.output()
  • get_async_running_status()
• sentinelhub.api.statistical
  • SentinelHubStatistical
    • SentinelHubStatistical.mime_type
    • SentinelHubStatistical.body()
    • SentinelHubStatistical.aggregation()
• sentinelhub.api.utils
  • enum_config()
  • remove_undefined()
  • AccessSpecification
    • AccessSpecification.s3
  • s3_specification()
• sentinelhub.api.wfs
  • WebFeatureService
    • WebFeatureService.get_dates()
    • WebFeatureService.get_geometries()
    • WebFeatureService.get_tiles()