Skip to content

Geospatial Expressions

Ibis supports the following geospatial expression APIs

GeoSpatialValue

Bases: NumericValue

Functions

area()

Compute the area of a geospatial value.

Returns:

Type Description
FloatingValue

The area of self

as_binary()

Get the geometry as well-known bytes (WKB) without the SRID data.

Returns:

Type Description
BinaryValue

Binary value

as_ewkb()

Get the geometry as well-known bytes (WKB) with the SRID data.

Returns:

Type Description
BinaryValue

WKB value

as_ewkt()

Get the geometry as well-known text (WKT) with the SRID data.

Returns:

Type Description
StringValue

String value

as_text()

Get the geometry as well-known text (WKT) without the SRID data.

Returns:

Type Description
StringValue

String value

azimuth(right)

Return the angle in radians from the horizontal of the vector defined by the inputs.

Angle is computed clockwise from down-to-up on the clock: 12=0; 3=PI/2; 6=PI; 9=3PI/2.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
FloatingValue

azimuth

buffer(radius)

Return all points whose distance from this geometry is less than or equal to radius.

Calculations are in the Spatial Reference System of this Geometry.

Parameters:

Name Type Description Default
radius float | ir.FloatingValue

Floating expression

 required

Returns:

Type Description
GeoSpatialValue

Geometry expression

centroid()

Returns the centroid of the geometry.

Returns:

Type Description
PointValue

The centroid

contains(right)

Check if the geometry contains the right.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self contains right

contains_properly(right)

Check if the first geometry contains the second one.

Excludes common border points.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self contains right excluding border points.

covered_by(right)

Check if the first geometry is covered by the second one.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self is covered by right

covers(right)

Check if the first geometry covers the second one.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self covers right

crosses(right)

Check if the geometries have at least one interior point in common.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self and right have at least one common interior point.

d_fully_within(right, distance)

Check if self is entirely within distance from right.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required
distance ir.FloatingValue

Distance to check

 required

Returns:

Type Description
BooleanValue

Whether self is within a specified distance from right.

d_within(right, distance)

Check if self is partially within distance from right.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required
distance ir.FloatingValue

Distance to check

 required

Returns:

Type Description
BooleanValue

Whether self is partially within distance from right.

difference(right)

Return the difference of two geometries.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
GeoSpatialValue

Difference of self and right

disjoint(right)

Check if the geometries have no points in common.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self and right are disjoint

distance(right)

Compute the distance between two geospatial expressions.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry or geography

 required

Returns:

Type Description
FloatingValue

Distance between self and right

end_point()

Return the last point of a LINESTRING geometry as a POINT.

Return NULL if the input parameter is not a LINESTRING

Returns:

Type Description
PointValue

End point

envelope()

Returns a geometry representing the bounding box of self.

Returns:

Type Description
PolygonValue

A polygon

geo_equals(right)

Check if the geometries are equal.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self equals right

geometry_n(n)

Get the 1-based Nth geometry of a multi geometry.

Parameters:

Name Type Description Default
n int | ir.IntegerValue

Nth geometry index

 required

Returns:

Type Description
GeoSpatialValue

Geometry value

geometry_type()

Get the type of a geometry.

Returns:

Type Description
StringValue

String representing the type of self.

intersection(right)

Return the intersection of two geometries.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
GeoSpatialValue

Intersection of self and right

intersects(right)

Check if the geometries share any points.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self intersects right

is_valid()

Check if the geometry is valid.

Returns:

Type Description
BooleanValue

Whether self is valid

length()

Compute the length of a geospatial expression.

Returns:

Type Description
FloatingValue

Length of self

line_locate_point(right)

Locate the distance a point falls along the length of a line.

Returns a float between zero and one representing the location of the closest point on the linestring to the given point, as a fraction of the total 2d line length.

Parameters:

Name Type Description Default
right PointValue

Point geometry

 required

Returns:

Type Description
FloatingValue

Fraction of the total line length

line_merge()

Merge a MultiLineString into a LineString.

Returns a (set of) LineString(s) formed by sewing together the constituent line work of a MultiLineString. If a geometry other than a LineString or MultiLineString is given, this will return an empty geometry collection.

Returns:

Type Description
GeoSpatialValue

Merged linestrings

line_substring(start, end)

Clip a substring from a LineString.

Returns a linestring that is a substring of the input one, starting and ending at the given fractions of the total 2d length. The second and third arguments are floating point values between zero and one. This only works with linestrings.

Parameters:

Name Type Description Default
start ir.FloatingValue

Start value

 required
end ir.FloatingValue

End value

 required

Returns:

Type Description
LineStringValue

Clipped linestring

max_distance(right)

Returns the 2-dimensional max distance between two geometries in projected units.

If self and right are the same geometry the function will return the distance between the two vertices most far from each other in that geometry.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
FloatingValue

Maximum distance

n_points()

Return the number of points in a geometry. Works for all geometries.

Returns:

Type Description
IntegerValue

Number of points

n_rings()

Return the number of rings for polygons and multipolygons.

Outer rings are counted as well.

Returns:

Type Description
IntegerValue

Number of rings

ordering_equals(right)

Check if two geometries are equal and have the same point ordering.

Returns true if the two geometries are equal and the coordinates are in the same order.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether points and orderings are equal.

overlaps(right)

Check if the geometries share space, have the same dimension, and are not completely contained by each other.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Overlaps indicator

perimeter()

Compute the perimeter of a geospatial expression.

Returns:

Type Description
FloatingValue

Perimeter of self

point_n(n)

Return the Nth point in a single linestring in the geometry.

Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL if there is no linestring in the geometry.

Parameters:

Name Type Description Default
n ir.IntegerValue

Nth point index

 required

Returns:

Type Description
PointValue

Nth point in self

set_srid(srid)

Set the spatial reference identifier for the ST_Geometry.

Parameters:

Name Type Description Default
srid ir.IntegerValue

SRID integer value

 required

Returns:

Type Description
GeoSpatialValue

self with SRID set to srid

simplify(tolerance, preserve_collapsed)

Simplify a given geometry.

Parameters:

Name Type Description Default
tolerance ir.FloatingValue

Tolerance

 required
preserve_collapsed ir.BooleanValue

Whether to preserve collapsed geometries

 required

Returns:

Type Description
GeoSpatialValue

Simplified geometry

srid()

Return the spatial reference identifier for the ST_Geometry.

Returns:

Type Description
IntegerValue

SRID

start_point()

Return the first point of a LINESTRING geometry as a POINT.

Return NULL if the input parameter is not a LINESTRING

Returns:

Type Description
PointValue

Start point

touches(right)

Check if the geometries have at least one point in common, but do not intersect.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self and right are touching

transform(srid)

Transform a geometry into a new SRID.

Parameters:

Name Type Description Default
srid ir.IntegerValue

Integer expression

 required

Returns:

Type Description
GeoSpatialValue

Transformed geometry

union(right)

Merge two geometries into a union geometry.

Returns the pointwise union of the two geometries. This corresponds to the non-aggregate version the PostGIS ST_Union.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
GeoSpatialValue

Union of geometries

within(right)

Check if the first geometry is completely inside of the second.

Parameters:

Name Type Description Default
right GeoSpatialValue

Right geometry

 required

Returns:

Type Description
BooleanValue

Whether self is in right.

x()

Return the X coordinate of self, or NULL if not available.

Input must be a point.

Returns:

Type Description
FloatingValue

X coordinate of self

x_max()

Return the X maxima of a geometry.

Returns:

Type Description
FloatingValue

X maxima

x_min()

Return the X minima of a geometry.

Returns:

Type Description
FloatingValue

X minima

y()

Return the Y coordinate of self, or NULL if not available.

Input must be a point.

Returns:

Type Description
FloatingValue

Y coordinate of self

y_max()

Return the Y maxima of a geometry.

Returns:

Type Description
FloatingValue

Y maxima

y_min()

Return the Y minima of a geometry.

Returns:

Type Description
FloatingValue

Y minima

GeoSpatialColumn

Bases: NumericColumn, GeoSpatialValue

Functions

unary_union()

Aggregate a set of geometries into a union.

This corresponds to the aggregate version of the PostGIS ST_Union. We give it a different name (following the corresponding method in GeoPandas) to avoid name conflicts with the non-aggregate version.

Returns:

Type Description
GeoSpatialScalar

Union of geometries
Last update: August 5, 2022