GeoMeasure (GeoMeasure v1.8.0)

View Source

Calculates properties of Geo structs.

Summary

Types

geo_line()
geo_point()
geo_polygon()

Functions

area(geometry)

Calculates the area of a Geo struct.

bbox(geometry)

Calculates the bounding box of a Geo struct.

centroid(geometry)

Calculates the centroid of a Geo struct.

distance(coordinates_1, coordinates_2)

Calculates the distance between two coordinate pairs or points.

extent(geometry)

Calculates the extent coordinates of a Geo struct.

footprint_area(geometry)

Calculates the area of the footprint of a 3D Geo struct.

footprint_length(geometry)

Calculates the length of a 3D linear Geo struct.

footprint_perimeter(geometry)

Calculates the perimeter of a 3D polygonal Geo struct.

length(geometry)

Calculates the length of a linear Geo struct.

perimeter(geometry)

Calculates the perimeter of a polygonal Geo struct.

Types

geo_line()

@type geo_line() ::
  Geo.LineString.t()
  | Geo.LineStringM.t()
  | Geo.LineStringZ.t()
  | Geo.LineStringZM.t()

geo_point()

@type geo_point() :: Geo.Point.t() | Geo.PointM.t() | Geo.PointZ.t() | Geo.PointZM.t()

geo_polygon()

@type geo_polygon() :: Geo.Polygon.t() | Geo.PolygonZ.t()

Functions

area(geometry)

(since 0.0.1) 
@spec area(geo_polygon()) :: float()

Calculates the area of a Geo struct.

bbox(geometry)

(since 0.0.1) 
@spec bbox(Geo.geometry()) :: Geo.Point.t() | Geo.PointZ.t() | Geo.Polygon.t()

Calculates the bounding box of a Geo struct.

centroid(geometry)

(since 0.0.1) 
@spec centroid(Geo.geometry()) :: Geo.Point.t() | Geo.PointZ.t()

Calculates the centroid of a Geo struct.

distance(coordinates_1, coordinates_2)

(since 0.0.1) 
@spec distance({number(), number()}, {number(), number()}) :: float()
@spec distance(geo_point(), geo_point()) :: float()

Calculates the distance between two coordinate pairs or points.

extent(geometry)

(since 0.0.1) 
@spec extent(geo_line() | geo_polygon()) :: {number(), number(), number(), number()}

Calculates the extent coordinates of a Geo struct.

footprint_area(geometry)

(since 1.7.0) 
@spec footprint_area(Geo.PolygonZ.t()) :: float()

Calculates the area of the footprint of a 3D Geo struct.

footprint_length(geometry)

(since 1.7.0) 
@spec footprint_length(Geo.LineStringZ.t() | Geo.LineStringZM.t()) :: float()

Calculates the length of a 3D linear Geo struct.

footprint_perimeter(geometry)

(since 1.7.0) 
@spec footprint_perimeter(Geo.PolygonZ.t()) :: float()

Calculates the perimeter of a 3D polygonal Geo struct.

length(geometry)

(since 1.3.0) 
@spec length(geo_line()) :: float()

Calculates the length of a linear Geo struct.

perimeter(geometry)

(since 0.0.1) 
@spec perimeter(geo_polygon()) :: float()

Calculates the perimeter of a polygonal Geo struct.