resample_spatial.json

{
    "id": "resample_spatial",
    "summary": "Resample and warp the spatial dimensions",
    "description": "Resamples the spatial dimensions (x,y) of the data cube to a specified resolution and/or warps the data cube to the target projection. At least `resolution` or `projection` must be specified.\n\nUse ``filter_bbox()`` to set the target spatial extent.",
    "categories": [
        "cubes",
        "aggregate & resample"
    ],
    "parameter_order": ["data", "resolution", "projection", "method", "align"],
    "parameters": {
        "data": {
            "description": "A raster data cube.",
            "schema": {
                "type": "object",
                "format": "raster-cube"
            },
            "required": true
        },
        "resolution": {
            "description": "Resamples the data cube to the target resolution, which can be specified either as separate values for x and y or as a single value for both axes. Specified in the units of the target projection. Doesn't change the resolution by default (`0`).",
            "schema": {
                "anyOf": [
                    {
                        "description": "A single number used as resolution for both x and y.",
                        "type": "number",
                        "minimum": 0
                    },
                    {
                        "description": "A two-element array to specify separate resolutions for x (first element) and y (second element).",
                        "type": "array",
                        "minItems": 2,
                        "maxItems": 2,
                        "items": {
                            "type": "number",
                            "minimum": 0
                        }
                    }
                ],
                "default": 0
            }
        },
        "projection": {
            "description": "Warps the data cube to the target projection. Target projection specified as [EPSG](http://www.epsg.org) code or [PROJ](https://proj4.org) definition. Doesn't change the projection by default (`null`).",
            "schema": {
                "anyOf": [
                    {
                        "title": "EPSG Code",
                        "type": "integer",
                        "format": "epsg-code",
                        "examples": [7099]
                    },
                    {
                        "title": "PROJ definition",
                        "type": "string",
                        "format": "proj-definition",
                        "examples": ["+proj=moll +lon_0=0 +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs"]
                    },
                    {
                        "title": "Don't change projection",
                        "type": "null"
                    }
                ],
                "default": null
            }
        },
        "method": {
          "description": "Resampling method. Methods are inspired by GDAL, see [gdalwarp](https://www.gdal.org/gdalwarp.html) for more information.",
          "schema": {
            "type": "string",
            "default": "near",
            "enum": [
              "near",
              "bilinear",
              "cubic",
              "cubicspline",
              "lanczos",
              "average",
              "mode",
              "max",
              "min",
              "med",
              "q1",
              "q3"
            ]
          }
        },
        "align": {
            "description": "Specifies to which corner of the spatial extent the new resampled data is aligned to.",
            "schema": {
                "type": "string",
                "enum": [
                    "lower-left",
                    "upper-left",
                    "lower-right",
                    "upper-right"
                ],
                "default": "lower-left"
            }
        }
    },
    "returns": {
        "description": "A raster data cube with values warped onto the new projection.",
        "schema": {
            "type": "object",
            "format": "raster-cube"
        }
    },
    "links": [
        {
            "rel": "about",
            "href": "https://proj4.org/usage/projections.html",
            "title": "PROJ parameters for cartographic projections"
        },
        {
            "rel": "about",
            "href": "http://www.epsg-registry.org",
            "title": "Official EPSG code registry"
        },
        {
            "rel": "about",
            "href": "http://www.epsg.io",
            "title": "Unofficial EPSG code database"
        }
    ]
}