Source: https://gometry.monicz.dev/api/

# API reference

| Page | Contents |
| --- | --- |
| [Constructors & bulk factories](https://gometry.monicz.dev/api/toplevel/constructors-bulk-factories/) | Construct geometry values and packed coordinate columns. |
| [Predicates](https://gometry.monicz.dev/api/toplevel/predicates/) | Binary spatial relationships, coordinate probes, and DE-9IM predicates. |
| [Measurement](https://gometry.monicz.dev/api/toplevel/measurement/) | Area, length, distance, nearest points, and similarity measures. |
| [Overlay & dissolve](https://gometry.monicz.dev/api/toplevel/overlay-dissolve/) | Binary set operations and reductions over geometry collections. |
| [Constructive & validation](https://gometry.monicz.dev/api/toplevel/constructive-validation/) | Split, snap, polygonize, and validate geometry. |
| [Coverage (polygonal)](https://gometry.monicz.dev/api/toplevel/coverage-polygonal/) | Validate, clean, simplify, and union edge-sharing polygon coverages. |
| [Geodesy & navigation](https://gometry.monicz.dev/api/toplevel/geodesy-navigation/) | Bearings, destinations, route interpolation, and cross-track distance. |
| [Index & join](https://gometry.monicz.dev/api/toplevel/index-join/) | Spatial joins and nearest-neighbor queries over geometry columns. |
| [I/O & interop](https://gometry.monicz.dev/api/toplevel/io-interop/) | Parse external representations, export coordinates, and build GeoJSON feature records. |
| [Geometry](https://gometry.monicz.dev/api/geometry/geometry/) | Methods and properties shared by all geometry types. |
| [Geometry types](https://gometry.monicz.dev/api/geometry/geometry-types/) | The seven typed geometry classes and the members unique to each type. Shared operations live on Geometry. |
| [GeometryArray](https://gometry.monicz.dev/api/geometry/geometryarray/) | The immutable columnar geometry container, with NumPy-native results and the same operation names as Geometry. |
| [Coordinates, parts & groups](https://gometry.monicz.dev/api/geometry/coordinates/) | Coordinate views, multipart views, and grouped results. |
| [CRS](https://gometry.monicz.dev/api/crs/) | Coordinate reference systems, transformations, catalogs, and grid resources. |
| [Grids & cells](https://gometry.monicz.dev/api/grids/) | Grid-generic cells and the shared columnar CellArray container. |
| [H3](https://gometry.monicz.dev/api/h3/) | H3 hexagonal cells, area covers, neighbors, directed edges, and vertices. |
| [S2](https://gometry.monicz.dev/api/s2/) | S2 spherical cells, fixed-level and adaptive covers, and hierarchical cell sets. |
| [Geohash](https://gometry.monicz.dev/api/geohash/) | Geohash tokens, rectangular cells, neighbors, and area covers. |
| [XYZ tiles](https://gometry.monicz.dev/api/tiles/) | Web Mercator XYZ tiles, quadkeys, tile hierarchies, and area covers. |
| [Point codes](https://gometry.monicz.dev/api/geocode/) | Plus-code and OSM-shortlink codecs using explicit longitude/latitude order. |
| [Spatial index](https://gometry.monicz.dev/api/spatial-index/) | Bulk spatial indexing for repeated relationship queries. |
| [Result types](https://gometry.monicz.dev/api/results/) | Named result values and aligned feature records returned by multi-output operations. |
| [Errors](https://gometry.monicz.dev/api/errors/) | Warnings and exceptions for geometry, CRS, transformation, and parsing failures. |
| [Optional interoperability](https://gometry.monicz.dev/api/interop/) | Convert dataframe columns, read and write GeoParquet, and display maps. |
| [Public annotation forms](https://gometry.monicz.dev/api/types/) | Annotation meanings, named result records, and structured value shapes. |

## Route by result shape

| Need | Start here | Contract |
| --- | --- | --- |
| One scalar geometry or scalar fact | [Geometry](https://gometry.monicz.dev/api/geometry/geometry/) | A scalar input returns a scalar value or geometry. |
| Packed array and dense numeric result | [GeometryArray](https://gometry.monicz.dev/api/geometry/geometryarray/) | Array operations return row-aligned read-only NumPy arrays or a `GeometryArray`. |
| Missing rows | [Missing rows](https://gometry.monicz.dev/guide/arrays/#missing-rows) | Missing rows remain row-aligned; fixed-width columns use sentinels and `.is_missing` is authoritative. |
| Coordinate axes | [Coordinates & dimensions](https://gometry.monicz.dev/api/geometry/coordinates/) | Scalar `coordinate_axes` is one layout; array `coordinate_axes` is per row and `common_coordinate_axes` is shared-or-`None`. |
| Ragged matches or grouped output | [Groups](https://gometry.monicz.dev/api/geometry/coordinates/#gometry.Groups) · [Features](https://gometry.monicz.dev/api/results/#gometry.Features) | `Groups` stores row offsets; named result records keep related fields together. |
| Optional dataframe, storage, or map interop | [Optional interoperability](https://gometry.monicz.dev/api/interop/) | Optional adapters are explicit extras; each page states copy, CRS, epoch, missing-row, and loss behavior. |

## Route by operation

- [Measure or navigate](https://gometry.monicz.dev/api/toplevel/measurement/) returns scalar or array numeric values; geodesy and metric units are described in [CRS, units & measurement](https://gometry.monicz.dev/guide/crs/).
- [Build, transform, or edit geometry](https://gometry.monicz.dev/api/toplevel/constructors-bulk-factories/) starts with constructors and continues through [Geometry](https://gometry.monicz.dev/api/geometry/geometry/).
- [Relate geometries](https://gometry.monicz.dev/api/toplevel/predicates/) uses free predicates and strict scalar/array broadcasting.
- [Find candidates, refine, or join](https://gometry.monicz.dev/api/toplevel/index-join/) returns integer arrays or [`Groups`](https://gometry.monicz.dev/api/geometry/coordinates/#gometry.Groups); candidates are not exact matches.
- [Exchange data](https://gometry.monicz.dev/api/toplevel/io-interop/) covers text, binary, GeoJSON, and Arrow; [optional interop](https://gometry.monicz.dev/api/interop/) covers dataframe and map adapters.