Core API#

The root import for geoarrow. This import is intended for those working with geoarrow at a low level; most users should use the pyarrow integration as import geoarrow.pyarrow as ga.

Examples#

>>> import geoarrow.c as ga

Constants#

class GeometryType#

Constants for geometry type. These values are the same as those used in well-known binary (i.e, 0-7).

Examples#

>>> import geoarrow.c as ga
>>> ga.GeometryType.MULTIPOINT
<GeoArrowGeometryType.GEOARROW_GEOMETRY_TYPE_MULTIPOINT: 4>
BOX = 990#

Box geometry type

GEOMETRY = 0#

Unknown or uninitialized geometry type

GEOMETRYCOLLECTION = 7#

Geometrycollection geometry type

LINESTRING = 2#

Linestring geometry type

MULTILINESTRING = 5#

Multilinestring geometry type

MULTIPOINT = 4#

Multipoint geometry type

MULTIPOLYGON = 6#

Multipolygon geometry type

POINT = 1#

Point geometry type

POLYGON = 3#

Polygon geometry type

class Dimensions#

Constants for dimensions.

Examples#

>>> import geoarrow.c as ga
>>> ga.Dimensions.XYZM
<GeoArrowDimensions.GEOARROW_DIMENSIONS_XYZM: 4>
UNKNOWN = 0#

Unknown or ininitialized dimensions

XY = 1#

XY dimensions

XYM = 3#

XYM dimensions

XYZ = 2#

XYZ dimensions

XYZM = 4#

XYZM dimensions

class CoordType#

Constants for coordinate type.

Examples#

>>> import geoarrow.c as ga
>>> ga.CoordType.INTERLEAVED
<GeoArrowCoordType.GEOARROW_COORD_TYPE_INTERLEAVED: 2>
INTERLEAVED = 2#

Coordinate type compose of a single array containing all dimensions (i.e., a fixed-size list)

SEPARATE = 1#

Coordinate type composed of separate arrays for each dimension (i.e., a struct)

UNKNOWN = 0#

Unknown or uninitialized coordinate type

class EdgeType#

Constants for edge type.

Examples#

>>> import geoarrow.c as ga
>>> ga.EdgeType.SPHERICAL
<GeoArrowEdgeType.GEOARROW_EDGE_TYPE_SPHERICAL: 1>
ANDOYER = 4#

Edges are geodesic on a spheroid according to the Andoyer algorithm

KARNEY = 5#

Edges are geodesic on a spheroid according to the Karney algorithm

PLANAR = 0#

Edges form a Cartesian line on a plane

SPHERICAL = 1#

Edges are geodesic on a sphere

THOMAS = 3#

Edges are geodesic on a spheroid according to the Thomas algorithm

VINCENTY = 2#

Edges are geodesic on a spheroid according to the Vincenty algorithm

class CrsType#

Constants for coordinate reference system type.

Examples#

>>> import geoarrow.c as ga
>>> ga.CrsType.PROJJSON
<GeoArrowCrsType.GEOARROW_CRS_TYPE_PROJJSON: 2>
AUTHORITY_CODE = 4#

The CRS value is a authority:code-encoded string

NONE = 0#

Explicit empty coordinate reference system

PROJJSON = 2#

The CRS value is a PROJJSON-encoded string

SRID = 5#

The CRS value is an opaque producer-defined identifier

UNKNOWN = 1#

The CRS value is a string of unspecified origin

WKT2_2019 = 3#

The CRS value is a WKT:2019-encoded string