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 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
use crate::common::Crs;
use crate::quadkey::check_quadkey_support;
use crate::tile::{BoundingBox, Coords, Xyz};
use crate::tile_matrix_set::{ordered_axes_inverted, TileMatrix, TileMatrixSet};
use crate::tms_iterator::XyzIterator;
use crate::transform::{merc_tile_ul, Error::TransformationUnsupported, Transform, Transformer};
use crate::{BoundingBox2D, CornerOfOrigin, OrderedAxes, TitleDescriptionKeywords};
use std::convert::AsRef;
use std::f64::consts::PI;
use std::num::{NonZeroU16, NonZeroU64};
/// Tile Matrix Set API.
#[derive(Debug)]
pub struct Tms {
pub tms: TileMatrixSet,
pub is_quadtree: bool,
// CRS transformation attributes
data_crs: Crs,
geographic_crs: Crs, // default=WGS84_CRS
to_geographic: Option<Transformer>,
from_geographic: Option<Transformer>,
}
#[derive(thiserror::Error, Debug)]
pub enum TmsError {
#[error("Invalid tile zoom identifier: `{0}`")]
InvalidZoomId(String),
#[error("Invalid zoom level: `{0}`")]
InvalidZoom(u8),
#[error("Point ({0}, {1}) is outside bounds {2:?}")]
PointOutsideBounds(f64, f64, BoundingBox),
#[error(transparent)]
TransformationError(#[from] crate::transform::Error),
#[error("Zero width or height")]
NonZeroError,
// #[error("Raised when math errors occur beyond ~85 degrees N or S")]
// InvalidLatitudeError,
// #[error("TileMatrix not found for level: {0} - Unable to construct tileMatrix for TMS with variable scale")]
// InvalidZoomError(u8),
// #[error("Raised when errors occur in parsing a function's tile arg(s)")]
// TileArgParsingError,
// #[error("Raised when a custom TileMatrixSet doesn't support quadkeys")]
// NoQuadkeySupport,
// #[error("Raised when errors occur in computing or parsing quad keys")]
// QuadKeyError,
}
pub type Result<T> = std::result::Result<T, TmsError>;
impl Clone for Tms {
// Custom impl because `Clone` is not implemented for `Proj`
fn clone(&self) -> Tms {
Tms::init(&self.tms).expect("Repeating initialization")
}
}
pub enum Matrix<'a> {
Predefined(&'a TileMatrix),
Calculated(TileMatrix),
}
impl AsRef<TileMatrix> for Matrix<'_> {
fn as_ref(&self) -> &TileMatrix {
match self {
Matrix::Predefined(m) => *m,
Matrix::Calculated(m) => m,
}
}
}
pub enum ZoomLevelStrategy {
Lower,
Upper,
Auto,
}
impl Tms {
/// Prepare transformations and check if TileMatrixSet supports quadkeys.
pub(crate) fn init(data: &TileMatrixSet) -> Result<Self> {
let is_quadtree = check_quadkey_support(&data.tile_matrices);
let data_crs = data.crs.clone();
let geographic_crs = Crs::default(); // data.get("_geographic_crs", WGS84_CRS)
let to_geographic = Transformer::from_crs(&data_crs, &geographic_crs, true).ok();
let from_geographic = Transformer::from_crs(&geographic_crs, &data_crs, true).ok();
let mut tms = data.clone();
Self::sort_tile_matrices(&mut tms)?;
// Check bounding box CRS (TODO: should we store it?)
if let Some(bounding_box) = &tms.bounding_box {
if let Some(crs) = &bounding_box.crs {
if *crs != tms.crs {
let _transform = Transformer::from_crs(crs, &tms.crs, true)?;
}
}
}
Ok(Self {
tms,
is_quadtree,
data_crs,
geographic_crs,
to_geographic,
from_geographic,
})
}
/// Sort matrices by identifier
fn sort_tile_matrices(tms: &mut TileMatrixSet) -> Result<()> {
// Check zoom identifier format
for m in &tms.tile_matrices {
m.id.parse::<u8>()
.map_err(|_e| TmsError::InvalidZoomId(m.id.clone()))?;
}
tms.tile_matrices.sort_by(|a, b| {
a.id.parse::<u8>()
.unwrap()
.cmp(&b.id.parse::<u8>().unwrap())
});
Ok(())
}
/// Iterate over matrices
pub fn matrices(&self) -> &Vec<TileMatrix> {
&self.tms.tile_matrices
}
/// Fetch CRS from epsg
pub fn crs(&self) -> &Crs {
&self.tms.crs
}
/// TileMatrixSet minimum TileMatrix identifier
pub fn minzoom(&self) -> u8 {
self.tms.tile_matrices[0].id.parse::<u8>().unwrap()
}
/// TileMatrixSet maximum TileMatrix identifier
pub fn maxzoom(&self) -> u8 {
self.tms.tile_matrices[self.tms.tile_matrices.len() - 1]
.id
.parse::<u8>()
.unwrap()
}
/// Check if CRS has inverted AXIS (lat,lon) instead of (lon,lat).
fn invert_axis(&self) -> bool {
self.tms.crs_axis_inverted()
}
/// Construct a custom TileMatrixSet.
///
/// # Arguments
/// * `crs` - Tile Matrix Set coordinate reference system
/// * `extent` - Bounding box of the Tile Matrix Set, (left, bottom, right, top).
/// * `tile_width` - Width of each tile of this tile matrix in pixels (default is 256).
/// * `tile_height` - Height of each tile of this tile matrix in pixels (default is 256).
/// * `matrix_scale` - Tiling schema coalescence coefficient (default: [1, 1] for EPSG:3857).
/// Should be set to [2, 1] for EPSG:4326.
/// see: <http:///docs.opengeospatial.org/is/17-083r2/17-083r2.html#14>
/// * `extent_crs` - pyproj.CRS
/// Extent's coordinate reference system, as a pyproj CRS object.
/// (default: same as input crs)
/// * `minzoom` - Tile Matrix Set minimum zoom level (default is 0).
/// * `maxzoom` - Tile Matrix Set maximum zoom level (default is 24).
/// * `title` - Tile Matrix Set title (default is 'Custom TileMatrixSet')
/// * `id` - Tile Matrix Set identifier (default is 'Custom')
/// * `ordered_axes`
/// * `geographic_crs` - Geographic (lat,lon) coordinate reference system (default is EPSG:4326)
pub fn custom(
extent: Vec<f64>,
crs: &Crs,
tile_width: u16, // = 256,
tile_height: u16, // = 256,
matrix_scale: Option<Vec<u8>>, // = None,
extent_crs: Option<&Crs>, // = None,
minzoom: u8, // = 0,
maxzoom: u8, // = 24,
title: &str, // = "Custom TileMatrixSet",
id: &str, // = "Custom",
ordered_axes: Option<OrderedAxes>,
geographic_crs: &Crs, // = WGS84_CRS,
) -> Result<Self> {
let matrix_scale = matrix_scale.unwrap_or(vec![1, 1]);
let bbox = transformed_bbox(&extent, crs, extent_crs)?;
let width = (bbox.right - bbox.left).abs();
let height = (bbox.top - bbox.bottom).abs();
let resolutions: Vec<f64> = (minzoom..=maxzoom)
.map(|zoom| {
f64::max(
width
/ (tile_width as f64 * matrix_scale[0] as f64)
/ 2_u64.pow(zoom as u32) as f64,
height
/ (tile_height as f64 * matrix_scale[1] as f64)
/ 2_u64.pow(zoom as u32) as f64,
)
})
.collect();
Self::custom_resolutions(
extent,
crs,
tile_width,
tile_height,
extent_crs,
resolutions,
title,
id,
ordered_axes,
geographic_crs,
)
}
/// Construct a custom TileMatrixSet with given resolutions
pub fn custom_resolutions(
extent: Vec<f64>,
crs: &Crs,
tile_width: u16,
tile_height: u16,
extent_crs: Option<&Crs>,
resolutions: Vec<f64>,
title: &str,
id: &str,
ordered_axes: Option<OrderedAxes>,
geographic_crs: &Crs,
) -> Result<Self> {
let mut tms = TileMatrixSet {
title_description_keywords: TitleDescriptionKeywords {
title: Some(title.to_string()),
description: None,
keywords: None,
},
id: id.to_string(),
uri: None,
crs: crs.clone(),
ordered_axes: ordered_axes.clone(),
well_known_scale_set: None,
bounding_box: None,
tile_matrices: Vec::with_capacity(resolutions.len()),
};
let is_inverted = if let Some(ordered_axes) = &ordered_axes {
ordered_axes_inverted(ordered_axes)
} else {
tms.crs_axis_inverted()
};
tms.bounding_box = Some(if is_inverted {
BoundingBox2D {
crs: Some(extent_crs.unwrap_or(crs).clone()),
ordered_axes: ordered_axes.clone(),
lower_left: [extent[1], extent[0]],
upper_right: [extent[3], extent[2]],
}
} else {
BoundingBox2D {
crs: Some(extent_crs.unwrap_or(crs).clone()),
ordered_axes: ordered_axes.clone(),
lower_left: [extent[0], extent[1]],
upper_right: [extent[2], extent[3]],
}
});
let bbox = transformed_bbox(&extent, crs, extent_crs)?;
let x_origin = if !is_inverted { bbox.left } else { bbox.top };
let y_origin = if !is_inverted { bbox.top } else { bbox.left };
let corner_of_origin = if !is_inverted {
None
} else {
Some(CornerOfOrigin::BottomLeft)
};
let mpu = meters_per_unit(crs);
for (zoom, res) in resolutions.iter().enumerate() {
let unitheight = tile_height as f64 * res;
let unitwidth = tile_width as f64 * res;
let maxy = ((bbox.top - bbox.bottom - 0.01 * unitheight) / unitheight).ceil() as u64;
let maxx = ((bbox.right - bbox.left - 0.01 * unitwidth) / unitwidth).ceil() as u64;
tms.tile_matrices.push(TileMatrix {
title_description_keywords: TitleDescriptionKeywords {
title: None,
description: None,
keywords: None,
},
id: zoom.to_string(),
scale_denominator: res * mpu as f64 / 0.00028,
cell_size: *res,
corner_of_origin: corner_of_origin.clone(),
point_of_origin: [x_origin, y_origin],
tile_width: NonZeroU16::new(tile_width).ok_or(TmsError::NonZeroError)?,
tile_height: NonZeroU16::new(tile_height).ok_or(TmsError::NonZeroError)?,
matrix_width: NonZeroU64::new(maxx).ok_or(TmsError::NonZeroError)?,
matrix_height: NonZeroU64::new(maxy).ok_or(TmsError::NonZeroError)?,
variable_matrix_widths: None,
});
}
let mut tms = Tms::init(&tms)?;
tms.geographic_crs = geographic_crs.clone();
Ok(tms)
}
/// Return the TileMatrix for a specific zoom without automatic tile matrix extension.
pub fn matrix_z(&self, zoom: u8) -> Option<&TileMatrix> {
for m in &self.tms.tile_matrices {
if m.id == zoom.to_string() {
return Some(m);
}
}
None
}
/// Return the TileMatrix for a specific zoom.
pub fn matrix(&self, zoom: u8) -> Matrix<'_> {
if let Some(m) = self.matrix_z(zoom) {
return Matrix::Predefined(m);
}
let matrix_scale = (1..self.tms.tile_matrices.len())
.map(|idx| {
(self.tms.tile_matrices[idx].scale_denominator
/ self.tms.tile_matrices[idx - 1].scale_denominator)
.round() // FIXME: round ndigits=2
})
.collect::<Vec<_>>();
if matrix_scale.len() > 1 {
// TODO: always true, error in morecantile?
// panic!(
// "TileMatrix not found for level: {} - Unable to construct tileMatrix for TMS with variable scale",
// zoom
// );
}
let mut tile_matrix = self.tms.tile_matrices.last().unwrap().clone();
let factor = 1.0 / matrix_scale[0];
while tile_matrix.id != zoom.to_string() {
tile_matrix = TileMatrix {
title_description_keywords: TitleDescriptionKeywords {
title: None,
description: None,
keywords: None,
},
id: (tile_matrix.id.parse::<u8>().unwrap() + 1).to_string(),
scale_denominator: tile_matrix.scale_denominator / factor,
cell_size: tile_matrix.cell_size, // FIXME
corner_of_origin: tile_matrix.corner_of_origin,
point_of_origin: tile_matrix.point_of_origin,
tile_width: tile_matrix.tile_width,
tile_height: tile_matrix.tile_height,
matrix_width: NonZeroU64::new(
(u64::from(tile_matrix.matrix_width) as f64 * factor).round() as u64,
)
.unwrap(),
matrix_height: NonZeroU64::new(
(u64::from(tile_matrix.matrix_height) as f64 * factor).round() as u64,
)
.unwrap(),
variable_matrix_widths: None,
}
}
Matrix::Calculated(tile_matrix)
}
/// Tile resolution for a TileMatrix.
//
// From note g in <http://docs.opengeospatial.org/is/17-083r2/17-083r2.html#table_2>:
// The pixel size of the tile can be obtained from the scaleDenominator
// by multiplying the later by 0.28 10-3 / metersPerUnit.
fn resolution(&self, matrix: &TileMatrix) -> f64 {
matrix.scale_denominator * 0.28e-3 / meters_per_unit(self.crs()) as f64
}
/// Get TMS zoom level corresponding to a specific resolution.
///
/// # Arguments
/// * `res` - Resolution in TMS unit.
/// * `max_z` - Maximum zoom level (default is tms maxzoom).
/// * `zoom_level_strategy` - Strategy to determine zoom level (same as in GDAL 3.2).
/// LOWER will select the zoom level immediately below the theoretical computed non-integral zoom level.
/// On the contrary, UPPER will select the immediately above zoom level.
/// Defaults to AUTO which selects the closest zoom level.
/// ref: <https://gdal.org/drivers/raster/cog.html#raster-cog>
/// * `min_z` - Minimum zoom level (default is tms minzoom).
///
/// # Returns:
/// * TMS zoom for a given resolution.
pub fn zoom_for_res(
&self,
res: f64,
max_z: Option<u8>,
zoom_level_strategy: &ZoomLevelStrategy,
min_z: Option<u8>,
) -> Result<u8> {
let max_z = max_z.unwrap_or(self.maxzoom());
let min_z = min_z.unwrap_or(self.minzoom());
let mut zoom_level = min_z;
let mut matrix_res = 0.0;
for z in min_z..=max_z {
zoom_level = z;
matrix_res = self.resolution(self.matrix(zoom_level).as_ref());
if res > matrix_res || (res - matrix_res).abs() / matrix_res <= 1e-8 {
break;
}
}
if zoom_level > 0 && (res - matrix_res).abs() / matrix_res > 1e-8 {
match zoom_level_strategy {
ZoomLevelStrategy::Lower => {
zoom_level = u8::max(zoom_level - 1, min_z);
}
ZoomLevelStrategy::Upper => {
zoom_level = u8::min(zoom_level, max_z);
}
ZoomLevelStrategy::Auto => {
if (self.resolution(self.matrix(u8::max(zoom_level - 1, min_z)).as_ref()) / res)
< (res / matrix_res)
{
zoom_level = u8::max(zoom_level - 1, min_z);
}
}
}
}
Ok(zoom_level)
}
/// Transform point(x,y) to geographic longitude and latitude.
fn lnglat(&self, x: f64, y: f64, truncate: bool /* =False */) -> Result<Coords> {
let Some(transformer) = &self.to_geographic else {
return Err(self.transform_error_to_geographic())
};
point_in_bbox(Coords::new(x, y), self.xy_bbox(), DEFAULT_BBOX_PREC)?;
let (mut lng, mut lat) = transformer.transform(x, y)?;
if truncate {
(lng, lat) = self.truncate_lnglat(lng, lat)?;
}
Ok(Coords::new(lng, lat))
}
/// Transform geographic longitude and latitude coordinates to TMS CRS
pub fn xy(&self, lng: f64, lat: f64) -> Result<Coords> {
let Some(transformer) = &self.from_geographic else {
return Err(self.transform_error_from_geographic())
};
point_in_bbox(Coords::new(lng, lat), self.xy_bbox(), DEFAULT_BBOX_PREC)?;
let (x, y) = transformer.transform(lng, lat)?;
Ok(Coords::new(x, y))
}
/// Transform geographic longitude and latitude coordinates to TMS CRS. Truncate geographic coordinates to TMS geographic bbox.
pub fn xy_truncated(&self, lng: f64, lat: f64) -> Result<Coords> {
let (lng, lat) = self.truncate_lnglat(lng, lat)?;
self.xy(lng, lat)
}
/// Truncate geographic coordinates to TMS geographic bbox.
//
// Adapted from <https://github.com/mapbox/mercantile/blob/master/mercantile/__init__.py>
pub fn truncate_lnglat(&self, lng: f64, lat: f64) -> Result<(f64, f64)> {
let mut lng = lng;
let mut lat = lat;
let bbox = self.bbox()?;
if lng > bbox.right {
lng = bbox.right;
} else if lng < bbox.left {
lng = bbox.left;
}
if lat > bbox.top {
lat = bbox.top;
} else if lat < bbox.bottom {
lat = bbox.bottom;
}
Ok((lng, lat))
}
/// Get the tile containing a Point (in TMS CRS).
///
/// # Arguments
/// * `xcoord`, ycoord - A `X` and `Y` pair in TMS coordinate reference system.
/// * `zoom` - The zoom level.
pub fn xy_tile(&self, xcoord: f64, ycoord: f64, zoom: u8) -> Xyz {
let m = self.matrix(zoom);
let matrix = m.as_ref();
let res = self.resolution(matrix);
let origin_x: f64 = if self.invert_axis() {
matrix.point_of_origin[1]
} else {
matrix.point_of_origin[0]
};
let origin_y = if self.invert_axis() {
matrix.point_of_origin[0]
} else {
matrix.point_of_origin[1]
};
let xtile = if !xcoord.is_infinite() {
((xcoord - origin_x) / (res * u16::from(matrix.tile_width) as f64)).floor()
} else {
0.0
};
let ytile = if !ycoord.is_infinite() {
((origin_y - ycoord) / (res * u16::from(matrix.tile_height) as f64)).floor()
} else {
0.0
};
// avoid out-of-range tiles
let xtile = if xtile < 0.0 { 0 } else { xtile as u64 };
let ytile = if ytile < 0.0 { 0 } else { ytile as u64 };
let xtile = if xtile > matrix.matrix_width.into() {
matrix.matrix_width.into()
} else {
xtile
};
let ytile = if ytile > matrix.matrix_height.into() {
matrix.matrix_height.into()
} else {
ytile
};
Xyz::new(xtile, ytile, zoom)
}
/// Get the tile for a given geographic longitude and latitude pair.
///
/// # Arguments
/// * `lng`, `lat` : A longitude and latitude pair in geographic coordinate reference system.
/// * `zoom` : The zoom level.
pub fn tile(&self, lng: f64, lat: f64, zoom: u8) -> Result<Xyz> {
let xy = self.xy(lng, lat)?;
Ok(self.xy_tile(xy.x, xy.y, zoom))
}
/// Get the tile for a given geographic longitude and latitude pair. Truncate inputs to limits of TMS geographic bounds.
///
/// # Arguments
/// * `lng`, `lat` : A longitude and latitude pair in geographic coordinate reference system.
/// * `zoom` : The zoom level.
pub fn tile_truncated(&self, lng: f64, lat: f64, zoom: u8) -> Result<Xyz> {
let xy = self.xy_truncated(lng, lat)?;
Ok(self.xy_tile(xy.x, xy.y, zoom))
}
/// Return the upper left coordinate of the tile in TMS coordinate reference system.
///
/// # Arguments
/// * `tile`: (x, y, z) tile coordinates or a Tile object we want the upper left coordinates of.
pub fn xy_ul(&self, tile: &Xyz) -> Coords {
let m = self.matrix(tile.z);
let matrix = m.as_ref();
let res = self.resolution(matrix);
let origin_x = if self.invert_axis() {
matrix.point_of_origin[1]
} else {
matrix.point_of_origin[0]
};
let origin_y = if self.invert_axis() {
matrix.point_of_origin[0]
} else {
matrix.point_of_origin[1]
};
let xcoord = origin_x + tile.x as f64 * res * u16::from(matrix.tile_width) as f64;
let ycoord = origin_y - tile.y as f64 * res * u16::from(matrix.tile_height) as f64;
Coords::new(xcoord, ycoord)
}
/// Return the bounding box of the tile in TMS coordinate reference system.
///
/// # Arguments
/// * `tile`: Tile object we want the bounding box of.
pub fn xy_bounds(&self, tile: &Xyz) -> BoundingBox {
let top_left = self.xy_ul(tile);
let bottom_right = self.xy_ul(&Xyz::new(tile.x + 1, tile.y + 1, tile.z));
BoundingBox::new(top_left.x, bottom_right.y, bottom_right.x, top_left.y)
}
/// Return the upper left coordinates of the tile in geographic coordinate reference system.
///
/// # Arguments
/// * `tile` - (x, y, z) tile coordinates or a Tile object we want the upper left geographic coordinates of.
pub fn ul(&self, tile: &Xyz) -> Result<Coords> {
let coords = if self.data_crs.as_srid() == 3857 && self.geographic_crs.as_srid() == 4326 {
let (lon, lat) = merc_tile_ul(tile.x as u32, tile.y as u32, tile.z);
Coords::new(lon, lat)
} else {
let xy = self.xy_ul(tile);
self.lnglat(xy.x, xy.y, false)?
};
Ok(coords)
}
/// Return the bounding box of the tile in geographic coordinate reference system.
///
/// # Arguments
/// * `tile` - Tile object we want the bounding box of.
pub fn bounds(&self, tile: &Xyz) -> Result<BoundingBox> {
let top_left = self.ul(tile)?;
let bottom_right = self.ul(&Xyz::new(tile.x + 1, tile.y + 1, tile.z))?;
Ok(BoundingBox::new(
top_left.x,
bottom_right.y,
bottom_right.x,
top_left.y,
))
}
/// Return TMS bounding box in TileMatrixSet's CRS.
pub fn xy_bbox(&self) -> BoundingBox {
let (left, bottom, right, top) = if let Some(bounding_box) = &self.tms.bounding_box {
let (left, bottom) = if self.invert_axis() {
(&bounding_box.lower_left[1], &bounding_box.lower_left[0])
} else {
(&bounding_box.lower_left[0], &bounding_box.lower_left[1])
};
let (right, top) = if self.invert_axis() {
(&bounding_box.upper_right[1], &bounding_box.upper_right[0])
} else {
(&bounding_box.upper_right[0], &bounding_box.upper_right[1])
};
if let Some(crs) = &bounding_box.crs {
if crs != self.crs() {
// Verified in init function
let transform =
Transformer::from_crs(crs, &self.crs(), true).expect("Transformer");
let (left, bottom, right, top) = transform
.transform_bounds(*left, *bottom, *right, *top /* , Some(21) */)
.expect("Transformer");
(left, bottom, right, top)
} else {
(*left, *bottom, *right, *top)
}
} else {
(*left, *bottom, *right, *top)
}
} else {
let zoom = self.minzoom();
let m = self.matrix(zoom);
let matrix = m.as_ref();
let top_left = self.xy_ul(&Xyz::new(0, 0, zoom));
let bottom_right = self.xy_ul(&Xyz::new(
u64::from(matrix.matrix_width),
u64::from(matrix.matrix_height),
zoom,
));
(top_left.x, bottom_right.y, bottom_right.x, top_left.y)
};
BoundingBox {
left,
bottom,
right,
top,
}
}
/// Return TMS bounding box in geographic coordinate reference system.
pub fn bbox(&self) -> Result<BoundingBox> {
let Some(transformer) = &self.to_geographic else {
return Err(self.transform_error_to_geographic())
};
let xy_bbox = self.xy_bbox();
let bbox = transformer.transform_bounds(
xy_bbox.left,
xy_bbox.bottom,
xy_bbox.right,
xy_bbox.top,
)?;
Ok(BoundingBox::new(bbox.0, bbox.1, bbox.2, bbox.3))
}
/// Check if a bounds intersects with the TMS bounds.
pub fn intersect_tms(&self, bbox: &BoundingBox) -> bool {
let tms_bounds = self.xy_bbox();
bbox.left < tms_bounds.right
&& bbox.right > tms_bounds.left
&& bbox.top > tms_bounds.bottom
&& bbox.bottom < tms_bounds.top
}
/// Get the tiles overlapped by a geographic bounding box
//
// Original code from <https://github.com/mapbox/mercantile/blob/master/mercantile/__init__.py#L424>
///
/// # Arguments
/// * `west`, `south`, `east`, `north` - Bounding values in decimal degrees (geographic CRS).
/// * `zooms` - One or more zoom levels.
/// * `truncate` : Whether or not to truncate inputs to web mercator limits.
///
/// # Notes
/// A small epsilon is used on the south and east parameters so that this
/// function yields exactly one tile when given the bounds of that same tile.
pub fn tiles(
&self,
west: f64,
south: f64,
east: f64,
north: f64,
zooms: &[u8],
truncate: bool, /* = False */
) -> Result<impl Iterator<Item = Xyz>> {
let mut tiles: Vec<Xyz> = Vec::new();
let bbox = self.bbox()?;
let bboxes = if west > east {
vec![
(bbox.left, south, east, north),
(west, south, bbox.right, north),
]
} else {
vec![(west, south, east, north)]
};
let get_tile = if truncate {
Tms::tile_truncated
} else {
Tms::tile
};
for bb in bboxes {
let w = bb.0.max(bbox.left);
let s = bb.1.max(bbox.bottom);
let e = bb.2.min(bbox.right);
let n = bb.3.min(bbox.top);
for z in zooms {
let ul_tile = get_tile(self, w + LL_EPSILON, n - LL_EPSILON, *z)?;
let lr_tile = get_tile(self, e - LL_EPSILON, s + LL_EPSILON, *z)?;
for i in ul_tile.x..=lr_tile.x {
for j in ul_tile.y..=lr_tile.y {
tiles.push(Xyz::new(i, j, *z));
}
}
}
}
Ok(tiles.into_iter())
}
/// Get the tile limits overlapped by a geographic bounding box
fn extent_limits(
&self,
extend: &BoundingBox,
minzoom: u8,
maxzoom: u8,
truncate: bool, /* = False */
) -> Result<Vec<MinMax>> {
if extend.left > extend.right || minzoom > maxzoom {
return Ok(Vec::new()); // TODO: Handle extend over date line
}
let bbox = self.bbox()?;
let get_tile = if truncate {
Tms::tile_truncated
} else {
Tms::tile
};
let w = extend.left.max(bbox.left);
let s = extend.bottom.max(bbox.bottom);
let e = extend.right.min(bbox.right);
let n = extend.top.min(bbox.top);
let limits = (minzoom..=maxzoom)
.map(|z| {
let ul_tile = get_tile(self, w + LL_EPSILON, n - LL_EPSILON, z)?;
let lr_tile = get_tile(self, e - LL_EPSILON, s + LL_EPSILON, z)?;
Ok(MinMax {
x_min: ul_tile.x,
x_max: lr_tile.x,
y_min: ul_tile.y,
y_max: lr_tile.y,
})
})
.collect::<Result<Vec<MinMax>>>()?;
Ok(limits)
}
/// Get the tile limits overlapped by a bounding box in TMS CRS
fn extent_limits_xy(&self, extend: &BoundingBox, minzoom: u8, maxzoom: u8) -> Vec<MinMax> {
if extend.left > extend.right || minzoom > maxzoom {
return Vec::new(); // TODO: Handle extend over date line
}
let bbox = self.xy_bbox();
let w = extend.left.max(bbox.left);
let s = extend.bottom.max(bbox.bottom);
let e = extend.right.min(bbox.right);
let n = extend.top.min(bbox.top);
(minzoom..=maxzoom)
.map(|z| {
let res = self.resolution(self.matrix(z).as_ref()) / 10.0;
let ul_tile = self.xy_tile(w + res, n - res, z);
let lr_tile = self.xy_tile(e - res, s + res, z);
MinMax {
x_min: ul_tile.x,
x_max: lr_tile.x,
y_min: ul_tile.y,
y_max: lr_tile.y,
}
})
.collect()
}
/// Get iterator over all tiles overlapped by a geographic bounding box
pub fn xyz_iterator_geographic(
&self,
extend: &BoundingBox,
minzoom: u8,
maxzoom: u8,
) -> Result<XyzIterator> {
let limits = self.extent_limits(extend, minzoom, maxzoom, false)?;
Ok(XyzIterator::new(minzoom, maxzoom, limits))
}
/// Get iterator over all tiles overlapped by a bounding box in TMS CRS
pub fn xyz_iterator(&self, extend: &BoundingBox, minzoom: u8, maxzoom: u8) -> XyzIterator {
let limits = self.extent_limits_xy(extend, minzoom, maxzoom);
XyzIterator::new(minzoom, maxzoom, limits)
}
// def feature(
// self,
// tile: Tile,
// fid: Optional[str] = None,
// props: Optional[Dict] = None,
// buffer: Optional[NumType] = None,
// precision: Optional[int] = None,
// projected: bool = False,
// ) -> Dict:
// """
// Get the GeoJSON feature corresponding to a tile.
//
// Originally from <https://github.com/mapbox/mercantile/blob/master/mercantile/__init__.py>
//
// Parameters
// ----------
// tile : Tile or sequence of int
// May be be either an instance of Tile or 3 ints, X, Y, Z.
// fid : str, optional
// A feature id.
// props : dict, optional
// Optional extra feature properties.
// buffer : float, optional
// Optional buffer distance for the GeoJSON polygon.
// precision: float
// If >= 0, geometry coordinates will be rounded to this number of decimal,
// otherwise original coordinate values will be preserved (default).
// projected : bool, optional
// Return coordinates in TMS projection. Default is false.
//
// Returns
// -------
// dict
//
// """
// west, south, east, north = self.xy_bounds(tile)
//
// if not projected:
// west, south, east, north = self._to_geographic.transform_bounds(
// west, south, east, north, densify_pts=21
// )
//
// if buffer:
// west -= buffer
// south -= buffer
// east += buffer
// north += buffer
//
// if precision and precision >= 0:
// west, south, east, north = (
// round(v, precision) for v in (west, south, east, north)
// )
//
// bbox = [min(west, east), min(south, north), max(west, east), max(south, north)]
// geom = bbox_to_feature(west, south, east, north)
//
// xyz = str(tile)
// feat: Dict[str, Any] = {
// "type": "Feature",
// "bbox": bbox,
// "id": xyz,
// "geometry": geom,
// "properties": {
// "title": f"XYZ tile {xyz}",
// "grid_name": self.identifier,
// "grid_crs": self.crs.to_string(),
// },
// }
//
// if projected:
// warnings.warn(
// "CRS is no longer part of the GeoJSON specification."
// "Other projection than EPSG:4326 might not be supported.",
// UserWarning,
// )
// feat.update(
// {"crs": {"type": "EPSG", "properties": {"code": self.crs.to_epsg()}}}
// )
//
// if props:
// feat["properties"].update(props)
//
// if fid is not None:
// feat["id"] = fid
//
// return feat
/// Return TileMatrix Extrema.
///
/// # Arguments
/// * `zoom` - The zoom level.
fn minmax(&self, zoom: u8) -> MinMax {
let matrix = self.matrix(zoom);
let m = matrix.as_ref();
MinMax {
x_min: 0,
x_max: u64::from(m.matrix_width).saturating_sub(1),
y_min: 0,
y_max: u64::from(m.matrix_height).saturating_sub(1),
}
}
/// Check if a tile is valid.
pub fn is_valid(&self, tile: &Xyz) -> bool {
if tile.z < self.minzoom() {
return false;
}
let extrema = self.minmax(tile.z);
let validx = extrema.x_min <= tile.x && tile.x <= extrema.x_max;
let validy = extrema.y_min <= tile.y && tile.y <= extrema.y_max;
validx && validy
}
/// The neighbors of a tile
///
/// The neighbors function makes no guarantees regarding neighbor tile
/// ordering.
///
/// The neighbors function returns up to eight neighboring tiles, where
/// tiles will be omitted when they are not valid.
///
/// # Arguments
/// * `tile` - instance of Tile
pub fn neighbors(&self, tile: &Xyz) -> Vec<Xyz> {
let extrema = self.minmax(tile.z);
let mut tiles = Vec::new();
for x in tile.x.saturating_sub(1)..=tile.x.saturating_add(1) {
for y in tile.y.saturating_sub(1)..=tile.y.saturating_add(1) {
if x == tile.x && y == tile.y {
continue;
} else if x < extrema.x_min || y < extrema.y_min {
continue;
} else if x > extrema.x_max || y > extrema.y_max {
continue;
}
tiles.push(Xyz::new(x, y, tile.z));
}
}
tiles
}
/// Get the parent of a tile
///
/// The parent is the tile of one zoom level lower that contains the
/// given "child" tile.
///
/// # Arguments
/// * `tile` - instance of Tile
/// * `zoom` - Determines the *zoom* level of the returned parent tile.
/// This defaults to one lower than the tile (the immediate parent).
pub fn parent(&self, tile: &Xyz, zoom: Option<u8> /* = None */) -> Result<Vec<Xyz>> {
if tile.z == self.minzoom() {
return Ok(vec![]);
}
if let Some(zoom) = zoom {
if tile.z <= zoom {
// zoom must be less than that of the input tile
return Err(TmsError::InvalidZoom(zoom));
}
} else if tile.z == 0 {
return Err(TmsError::InvalidZoom(0));
}
let target_zoom = match zoom {
Some(zoom) => zoom,
None => tile.z - 1,
};
let res = self.resolution(self.matrix(tile.z).as_ref()) / 10.0;
let bbox = self.xy_bounds(tile);
let ul_tile = self.xy_tile(bbox.left + res, bbox.top - res, target_zoom);
let lr_tile = self.xy_tile(bbox.right - res, bbox.bottom + res, target_zoom);
let mut tiles = Vec::new();
for i in ul_tile.x..=lr_tile.x {
for j in ul_tile.y..=lr_tile.y {
tiles.push(Xyz::new(i, j, target_zoom));
}
}
Ok(tiles)
}
/// Get the children of a tile
///
/// The children are ordered: top-left, top-right, bottom-right, bottom-left.
///
/// # Arguments
/// * `tile` - instance of Tile
/// * `zoom` - Determines the *zoom* level of the returned parent tile.
/// This defaults to one lower than the tile (the immediate parent).
pub fn children(&self, tile: &Xyz, zoom: Option<u8>) -> Result<Vec<Xyz>> {
let mut tiles = Vec::new();
if let Some(zoom) = zoom {
if tile.z > zoom {
// zoom must be greater than that of the input tile
return Err(TmsError::InvalidZoom(zoom));
}
}
let target_zoom = match zoom {
Some(z) => z,
None => tile.z + 1,
};
let bbox = self.xy_bounds(tile);
let res = self.resolution(self.matrix(tile.z).as_ref()) / 10.0;
let ul_tile = self.xy_tile(bbox.left + res, bbox.top - res, target_zoom);
let lr_tile = self.xy_tile(bbox.right - res, bbox.bottom + res, target_zoom);
for i in ul_tile.x..=lr_tile.x {
for j in ul_tile.y..=lr_tile.y {
tiles.push(Xyz::new(i, j, target_zoom));
}
}
Ok(tiles)
}
fn transform_error_to_geographic(&self) -> TmsError {
TransformationUnsupported(self.data_crs.clone(), self.geographic_crs.clone()).into()
}
fn transform_error_from_geographic(&self) -> TmsError {
TransformationUnsupported(self.geographic_crs.clone(), self.data_crs.clone()).into()
}
}
#[derive(Debug)]
pub(crate) struct MinMax {
pub x_min: u64,
pub x_max: u64,
pub y_min: u64,
pub y_max: u64,
}
impl TileMatrixSet {
pub fn into_tms(&self) -> Result<Tms> {
Tms::init(&self)
}
}
fn transformed_bbox(extent: &Vec<f64>, crs: &Crs, extent_crs: Option<&Crs>) -> Result<BoundingBox> {
let (mut left, mut bottom, mut right, mut top) = (extent[0], extent[1], extent[2], extent[3]);
if let Some(extent_crs) = extent_crs {
if extent_crs != crs {
let transform = Transformer::from_crs(extent_crs, crs, true)?;
(left, bottom, right, top) =
transform.transform_bounds(left, bottom, right, top /* Some(21) */)?;
}
}
Ok(BoundingBox::new(left, bottom, right, top))
}
/// Coefficient to convert the coordinate reference system (CRS)
/// units into meters (metersPerUnit).
//
// See http://docs.ogc.org/is/17-083r4/17-083r4.html#6-1-1-1-%C2%A0-tile-matrix-in-a-two-dimensional-space
// From note g in <http://docs.opengeospatial.org/is/17-083r2/17-083r2.html#table_2>:
// If the CRS uses meters as units of measure for the horizontal dimensions,
// then metersPerUnit=1; if it has degrees, then metersPerUnit=2pa/360
// (a is the Earth maximum radius of the ellipsoid).
pub fn meters_per_unit(crs: &Crs) -> f64 {
const SEMI_MAJOR_METRE: f64 = 6378137.0; /* crs.ellipsoid.semi_major_metre */
let unit_name = if crs.as_srid() == 4326 {
"degree" // FIXME: crs.axis_info[0].unit_name;
} else {
"metre"
};
match unit_name {
"metre" => 1.0,
"degree" => 2.0 * PI * SEMI_MAJOR_METRE / 360.0,
"foot" => 0.3048,
"US survey foot" => 0.30480060960121924,
_ => panic!(
"CRS {crs:?} with Unit Name `{}` is not supported",
unit_name
),
}
}
const LL_EPSILON: f64 = 1e-11;
pub const DEFAULT_BBOX_PREC: u8 = 5;
/// Check if a point is in a bounding box.
pub fn point_in_bbox(point: Coords, bbox: BoundingBox, precision: u8 /* = 5 */) -> Result<()> {
fn round_to_prec(number: f64, precision: u8) -> f64 {
let factor = 10.0_f64.powi(precision as i32);
(number * factor).round() / factor
}
let inside = round_to_prec(point.x, precision) >= round_to_prec(bbox.left, precision)
&& round_to_prec(point.x, precision) <= round_to_prec(bbox.right, precision)
&& round_to_prec(point.y, precision) >= round_to_prec(bbox.bottom, precision)
&& round_to_prec(point.y, precision) <= round_to_prec(bbox.top, precision);
if inside {
Ok(())
} else {
Err(TmsError::PointOutsideBounds(point.x, point.y, bbox))
}
}