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"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "A raster data cube.",
            "schema": {
                "type": "object",
                "subtype": "raster-cube"
            }
        },
        {
            "name": "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": [
                {
                    "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,
            "optional": true
        },
        {
            "name": "projection",
            "description": "Warps the data cube to the target projection, specified as as [EPSG code](http://www.epsg-registry.org/), [WKT2 (ISO 19162) string](http://docs.opengeospatial.org/is/18-010r7/18-010r7.html), [PROJ definition (deprecated)](https://proj.org/usage/quickstart.html). By default (`null`), the projection is not changed.",
            "schema": [
                {
                    "title": "EPSG Code",
                    "type": "integer",
                    "subtype": "epsg-code",
                    "minimum": 1000,
                    "examples": [
                        7099
                    ]
                },
                {
                    "title": "WKT2",
                    "type": "string",
                    "subtype": "wkt2-definition"
                },
                {
                    "title": "PROJ definition",
                    "type": "string",
                    "subtype": "proj-definition",
                    "deprecated": true
                },
                {
                    "title": "Don't change projection",
                    "type": "null"
                }
            ],
            "default": null,
            "optional": true
        },
        {
            "name": "method",
            "description": "Resampling method. Methods are inspired by GDAL, see [gdalwarp](https://www.gdal.org/gdalwarp.html) for more information.",
            "schema": {
                "type": "string",
                "enum": [
                    "near",
                    "bilinear",
                    "cubic",
                    "cubicspline",
                    "lanczos",
                    "average",
                    "mode",
                    "max",
                    "min",
                    "med",
                    "q1",
                    "q3"
                ]
            },
            "default": "near",
            "optional": true
        },
        {
            "name": "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": "upper-left",
            "optional": true
        }
    ],
    "returns": {
        "description": "A raster data cube with values warped onto the new projection.",
        "schema": {
            "type": "object",
            "subtype": "raster-cube"
        }
    },
    "links": [
        {
            "rel": "about",
            "href": "https://proj.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"
        }
    ]
}