clip.json

{
    "id": "clip",
    "summary": "Clip a value between a minimum and a maximum",
    "description": "Clips a number between specified minimum and maximum values. A value larger than the maximum value is set to the maximum value, a value lower than the minimum value is set to the minimum value.\n\nThe no-data value `null` is passed through and therefore gets propagated.",
    "categories": [
        "math"
    ],
    "parameters": [
        {
            "name": "x",
            "description": "A number.",
            "schema": {
                "type": [
                    "number",
                    "null"
                ]
            }
        },
        {
            "name": "min",
            "description": "Minimum value. If the value is lower than this value, the process will return the value of this parameter.",
            "schema": {
                "type": "number"
            }
        },
        {
            "name": "max",
            "description": "Maximum value. If the value is greater than this value, the process will return the value of this parameter.",
            "schema": {
                "type": "number"
            }
        }
    ],
    "returns": {
        "description": "The value clipped to the specified range.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "x": -5,
                "min": -1,
                "max": 1
            },
            "returns": -1
        },
        {
            "arguments": {
                "x": 10.001,
                "min": 1,
                "max": 10
            },
            "returns": 10
        },
        {
            "arguments": {
                "x": 0.000001,
                "min": 0,
                "max": 0.02
            },
            "returns": 0.000001
        },
        {
            "arguments": {
                "x": null,
                "min": 0,
                "max": 1
            },
            "returns": null
        }
    ],
    "process_graph": {
        "min": {
            "process_id": "min",
            "arguments": {
                "data": [
                    {
                        "from_parameter": "max"
                    },
                    {
                        "from_parameter": "x"
                    }
                ]
            }
        },
        "max": {
            "process_id": "max",
            "arguments": {
                "data": [
                    {
                        "from_parameter": "min"
                    },
                    {
                        "from_node": "min"
                    }
                ]
            },
            "result": true
        }
    }
}