is_nodata.json

{
    "id": "is_nodata",
    "summary": "Value is a no-data value",
    "description": "Checks whether the specified data is no-data value, i.e. equals to any of the no-data values of the data cube (or `null`). The specific no-data values are usually provided through the collection or STAC metadata.\n\nThe special numerical value `NaN` (not a number) as defined by the [IEEE Standard 754](https://ieeexplore.ieee.org/document/4610935) is only considered as no-data value if explicitly specified as no-data value for the data cube.",
    "categories": [
        "comparison"
    ],
    "parameters": [
        {
            "name": "x",
            "description": "The data to check.",
            "schema": {
                "description": "Any data type is allowed."
            }
        }
    ],
    "returns": {
        "description": "`true` if the data is a no-data value, otherwise `false`.",
        "schema": {
            "type": "boolean"
        }
    },
    "examples": [
        {
            "arguments": {
                "x": 1
            },
            "returns": false
        },
        {
            "arguments": {
                "x": "Test"
            },
            "returns": false
        },
        {
            "arguments": {
                "x": null
            },
            "returns": true
        },
        {
            "arguments": {
                "x": [
                    null,
                    null
                ]
            },
            "returns": false
        }
    ]
}