parquet/geospatial/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! This module provides functionality for working with geospatial data in Parquet file as defined in the [spec][parquet-geo-spec].
19//!
20//! * [`GeospatialStatistics`]: describes the geospatial statistics for a Parquet column.
21//! * [`BoundingBox`]: describes the bounding box values for a geospatial column.
22//!
23//! [`GeospatialStatistics`] describes the geospatial statistics for a Parquet column.
24//! * bbox: the [`BoundingBox`] for the geospatial data
25//! * geospatial_types: the geospatial types for the geospatial data as specified in [specification][geo-types].
26//!
27//! Geospatial bounding box describes the spatial extent of the geospatial data within a Parquet row group.
28//! * xmin, xmax: the minimum and maximum longitude values
29//! * ymin, ymax: the minimum and maximum latitude values
30//! * zmin, zmax: (optional) the minimum and maximum elevation values
31//! * mmin, mmax: (optional) the minimum and maximum linear reference values
32//!
33//! In 2D representation, where x are points:
34//! ```text
35//!  ymax +-----------------------+
36//!       |               x       |
37//!       |      x                |
38//!       |              x        |
39//!       |      x                |
40//!  ymin +-----------------------+
41//!       xmin                    xmax
42//! ```
43//!
44//! [`GeospatialStatistics`]: crate::geospatial::statistics::GeospatialStatistics
45//! [`BoundingBox`]: crate::geospatial::bounding_box::BoundingBox
46//! [parquet-geo-spec]: https://github.com/apache/parquet-format/blob/master/Geospatial.md
47//! [geo-types]: https://github.com/apache/parquet-format/blob/master/Geospatial.md#geospatial-types
48
49pub mod accumulator;
50pub mod bounding_box;
51pub mod statistics;