Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 3.9 KB

README.md

File metadata and controls

59 lines (39 loc) · 3.9 KB
Raw
GeometryOps.jl

Lifecycle:Experimental Stable Dev Build Status

GeometryOps logo

Warning

This package is still under heavy development! Use with care.

GeometryOps.jl is a package for geometric calculations on (primarily 2D) geometries.

The driving idea behind this package is to unify all the disparate packages for geometric calculations in Julia, and make them GeoInterface.jl-compatible. We are focusing primarily on 2/2.5D geometries for now. All methods in this package will consume any geometry which is compatible with GeoInterface - see its integrations page for more info on that!

Most of the use cases are driven by GIS and similar Earth data workflows, so this might be a bit specialized towards that, but methods should always be general to any coordinate space.

We welcome contributions, either as pull requests or discussion on issues!

Methods

GeometryOps tries to offer most of the basic geometry operations you'd need, implemented in pure Julia and accepting any GeoInterface.jl compatible type.

  • General geometry methods (OGC methods): equals, extent, distance, crosses, contains, intersects, etc
  • Targeted function application over large nested geometries (apply) and reduction over geometries (applyreduce)
    • Both apply and applyreduce consume arbitrary tables as well, like DataFrames!
  • signed_area, centroid, distance, etc for valid geometries
  • Line and polygon simplification (simplify)
  • Polygon clipping, intersection, difference and union
  • Generalized barycentric coordinates in polygons (barycentric_coordinates)
  • Projection of geometries between coordinate reference systems using Proj.jl
  • Polygonization of raster images by contour detection (polygonize)
  • Segmentization/densification of geometry, both linearly and by geodesic paths (segmentize)

See the "API" page in the docs for a more complete list!

How to navigate the docs

GeometryOps' docs are divided into three main sections: tutorials, explanations and source code.
Documentation and examples for many functions can be found in the source code section, since we use literate programming in GeometryOps.

  • Tutorials are meant to teach the fundamental concepts behind GeometryOps, and how to perform certain operations.
  • Explanations usually contain little code, and explain in more detail how GeometryOps works.
  • Source code usually contains explanations and examples at the top of the page, followed by annotated source code from that file.

Performance comparison to other packages

From the wonderful vector-benchmark,

download-3

More benchmarks coming soon!

Planned additions

  • Buffering, hulls (convex and otherwise)
  • Checks for valid geometries (empty linestrings, null points, etc) (#14)
  • Operations on spherical (non-Euclidean) geometry (#17)