blob: 750c76cc34700a6296d2a8baf1077fec42cdc90e [file] [log] [blame] [view]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# RS_Within
Introduction: Returns true if the geometry or raster on the left side is within the geometry or raster on the right side.
The convex hull of the raster is considered in the test.
The rules for testing spatial relationship is the same as `RS_Intersects`.
Format: `RS_Within(raster: Raster, geom: Geometry)`
Format: `RS_Within(geom: Geometry, raster: Raster)`
Format: `RS_Within(raster0: Raster, raster1: Raster)`
Return type: `Boolean`
Since: `v1.5.0`
SQL Example
```sql
SELECT RS_Within(RS_MakeEmptyRaster(1, 20, 20, 2, 22, 1), ST_GeomFromWKT('POLYGON ((0 0, 0 50, 100 50, 100 0, 0 0))')) rast_geom,
RS_Within(RS_MakeEmptyRaster(1, 20, 20, 2, 22, 1), RS_MakeEmptyRaster(1, 30, 30, 2, 22, 1)) rast_rast
```
Output:
```
+---------+---------+
|rast_geom|rast_rast|
+---------+---------+
| true| true|
+---------+---------+
```