Sentinel Hub · Schema

BatchCogParameters

Allows to specify COG creation parameters. When the output is a batch collection (that is, either *createCollection* is true or *collectionId* is provided), COG customization is limited: only the *resamplingAlgorithm* parameter can be specified in *cogParameters*, all others must **not** be provided.

Satellite ImageryGeospatialRemote SensingEarth ObservationNDVISentinelLandsatMODISOGCSTAC

Properties

Name Type Description
overviewLevels array Corresponds to the *levels* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html).
overviewMinSize integer Corresponds to the *minsize* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html). Default value minimum of blockxsize and blockysize
resamplingAlgorithm string Corresponds to the value of the *-r* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html).
blockxsize integer Corresponds to the *BLOCKXSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html).
blockysize integer Corresponds to the *BLOCKYSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html).
usePredictor boolean Whether predictor should be used for TIFF compression. If true, the predictor "2" will be passed to [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html) in case of integer output and
View JSON Schema on GitHub

JSON Schema

BatchCogParameters.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.sentinel-hub.com/schemas/BatchCogParameters",
  "title": "BatchCogParameters",
  "description": "Allows to specify COG creation parameters.\n\nWhen the output is a batch collection (that is, either *createCollection* is true or *collectionId* is provided),\nCOG customization is limited: only the *resamplingAlgorithm* parameter can be specified in *cogParameters*,\nall others must **not** be provided.\n",
  "type": "object",
  "properties": {
    "overviewLevels": {
      "description": "Corresponds to the *levels* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html).",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "overviewMinSize": {
      "description": "Corresponds to the *minsize* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html).\nDefault value minimum of blockxsize and blockysize\n",
      "type": "integer"
    },
    "resamplingAlgorithm": {
      "type": "string",
      "enum": [
        "nearest",
        "average",
        "gauss",
        "cubic",
        "cubicspline",
        "lanczos",
        "average_magphase",
        "mode"
      ],
      "description": "Corresponds to the value of the *-r* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html).",
      "default": "average"
    },
    "blockxsize": {
      "description": "Corresponds to the *BLOCKXSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html).",
      "type": "integer",
      "default": 1024
    },
    "blockysize": {
      "description": "Corresponds to the *BLOCKYSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html).",
      "type": "integer",
      "default": 1024
    },
    "usePredictor": {
      "description": "Whether predictor should be used for TIFF compression. If true, the predictor \"2\" will be passed to [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html) in case of integer output and \"3\" for FLOAT32 output. If false, the value \"1\" (no predictor) will be used.\n",
      "type": "boolean",
      "default": true
    }
  }
}