kaushiksrini commented on code in PR #8225: URL: https://github.com/apache/arrow-rs/pull/8225#discussion_r2357426144
########## parquet/src/geospatial/bounding_box.rs: ########## @@ -0,0 +1,359 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! Bounding box for GEOMETRY or GEOGRAPHY type in the representation of min/max +//! value pair of coordinates from each axis. +//! +//! Derived from the parquet format spec: https://github.com/apache/parquet-format/blob/master/Geospatial.md +//! +//! +use crate::format as parquet; + +/// A geospatial instance has at least two coordinate dimensions: X and Y for 2D coordinates of each point. +/// X represents longitude/easting and Y represents latitude/northing. A geospatial instance can optionally +/// have Z and/or M values associated with each point. +/// +/// The Z values introduce the third dimension coordinate, typically used to indicate height or elevation. +/// +/// M values allow tracking a value in a fourth dimension. These can represent: +/// - Linear reference values (e.g., highway milepost) +/// - Timestamps +/// - Other values defined by the CRS +/// +/// The bounding box is defined as min/max value pairs of coordinates from each axis. X and Y values are +/// always present, while Z and M are omitted for 2D geospatial instances. +/// +/// When calculating a bounding box: +/// - Null or NaN values in a coordinate dimension are skipped +/// - If a dimension has only null/NaN values, that dimension is omitted +/// - If either X or Y dimension is missing, no bounding box is produced +/// - Example: POINT (1 NaN) contributes to X but not to Y, Z, or M dimensions +/// +/// Special cases: +/// - For X values only, xmin may exceed xmax. In this case, a point matches if x >= xmin OR x <= xmax +/// - This wraparound can occur when the bounding box crosses the antimeridian line. +/// - In geographic terms: xmin=westernmost, xmax=easternmost, ymin=southernmost, ymax=northernmost +/// +/// For GEOGRAPHY types: +/// - X values must be within [-180, 180] (longitude) +/// - Y values must be within [-90, 90] (latitude) +/// +/// Derived from the parquet format [spec][bounding-box-spec] +/// +/// # Examples +/// +/// ``` +/// use parquet::geospatial::bounding_box::BoundingBox; +/// +/// // 2D bounding box +/// let bbox_2d = BoundingBox::new(0.0, 0.0, 100.0, 100.0); +/// +/// // 3D bounding box with elevation +/// let bbox_3d = BoundingBox::new(0.0, 0.0, 100.0, 100.0) +/// .with_zrange(0.0, 1000.0); +/// +/// // 3D bounding box with elevation and measured value +/// let bbox_3d_m = BoundingBox::new(0.0, 0.0, 100.0, 100.0) +/// .with_zrange(0.0, 1000.0) +/// .with_mrange(0.0, 1000.0); +/// ``` +/// +/// [bounding-box-spec]: https://github.com/apache/parquet-format/blob/master/Geospatial.md#bounding-box +#[derive(Clone, Debug, PartialEq)] +pub struct BoundingBox { Review Comment: Thanks @paleolimbot for the catch! That makes sense - I have removed it here -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
