vortex-geo 0.79.0

Geospatial encodings and layouts for Vortex files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::sync::Arc;

use vortex_array::aggregate_fn::session::AggregateFnSessionExt;
use vortex_array::dtype::session::DTypeSessionExt;
use vortex_array::scalar_fn::session::ScalarFnSessionExt;
use vortex_array::stats::session::StatsSessionExt;
use vortex_arrow::ArrowSessionExt;
use vortex_session::VortexSession;

use crate::aggregate_fn::GeometryAabb;
use crate::extension::LineString;
use crate::extension::MultiLineString;
use crate::extension::MultiPoint;
use crate::extension::MultiPolygon;
use crate::extension::Point;
use crate::extension::Polygon;
use crate::extension::Rect;
use crate::extension::WellKnownBinary;
use crate::prune::GeoDistancePrune;
use crate::prune::GeoIntersectsPrune;
use crate::scalar_fn::contains::GeoContains;
use crate::scalar_fn::distance::GeoDistance;
use crate::scalar_fn::intersects::GeoIntersects;

pub mod aggregate_fn;
pub mod extension;
pub mod prune;
pub mod scalar_fn;
#[cfg(test)]
mod test_harness;
#[cfg(test)]
mod tests;

/// Set up a session with support for geospatial extension types, encodings and layouts.
pub fn initialize(session: &VortexSession) {
    // Register the geospatial extension types.
    session.dtypes().register(WellKnownBinary);
    session.arrow().register_exporter(Arc::new(WellKnownBinary));
    session.arrow().register_importer(Arc::new(WellKnownBinary));
    session.dtypes().register(Point);
    session.arrow().register_exporter(Arc::new(Point));
    session.arrow().register_importer(Arc::new(Point));
    session.dtypes().register(LineString);
    session.arrow().register_exporter(Arc::new(LineString));
    session.arrow().register_importer(Arc::new(LineString));
    session.dtypes().register(MultiPoint);
    session.arrow().register_exporter(Arc::new(MultiPoint));
    session.arrow().register_importer(Arc::new(MultiPoint));
    session.dtypes().register(Polygon);
    session.arrow().register_exporter(Arc::new(Polygon));
    session.arrow().register_importer(Arc::new(Polygon));
    session.dtypes().register(MultiLineString);
    session.arrow().register_exporter(Arc::new(MultiLineString));
    session.arrow().register_importer(Arc::new(MultiLineString));
    session.dtypes().register(MultiPolygon);
    session.arrow().register_exporter(Arc::new(MultiPolygon));
    session.arrow().register_importer(Arc::new(MultiPolygon));
    session.dtypes().register(Rect);
    session.arrow().register_exporter(Arc::new(Rect));
    session.arrow().register_importer(Arc::new(Rect));

    // Register the geometry scalar functions.
    session.scalar_fns().register(GeoContains);
    session.scalar_fns().register(GeoDistance);
    session.scalar_fns().register(GeoIntersects);

    // The axis-aligned bounding-box (AABB) aggregate; self-declares as a per-chunk zone stat for
    // geometry columns.
    session.aggregate_fns().register(GeometryAabb);

    // Register the spatial pruning rules that use that AABB.
    session.stats().register_rewrite(GeoDistancePrune);
    session.stats().register_rewrite(GeoIntersectsPrune);
}