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
|
from __future__ import annotations
import ctypes
import pickle
import sys
import tempfile
import unittest
from collections.abc import Iterator
import numpy as np
import pytest
import rtree
from rtree import core, index
from rtree.exceptions import RTreeError
from .common import skip_sidx_lt_210
class IndexTestCase(unittest.TestCase):
def setUp(self) -> None:
self.boxes15 = np.genfromtxt("boxes_15x15.data")
self.idx = index.Index()
for i, coords in enumerate(self.boxes15):
self.idx.add(i, coords)
def boxes15_stream(
self, interleaved: bool = True
) -> Iterator[tuple[int, tuple[float, float, float, float], int]]:
boxes15 = np.genfromtxt("boxes_15x15.data")
for i, (minx, miny, maxx, maxy) in enumerate(boxes15):
if interleaved:
yield (i, (minx, miny, maxx, maxy), 42)
else:
yield (i, (minx, maxx, miny, maxy), 42)
def stream_basic(self) -> None:
# some versions of libspatialindex screw up indexes on stream loading
# so do a very simple index check
rtree_test = rtree.index.Index(
[(1564, [0, 0, 0, 10, 10, 10], None)],
properties=rtree.index.Property(dimension=3),
)
assert next(rtree_test.intersection([1, 1, 1, 2, 2, 2])) == 1564
class IndexCount(unittest.TestCase):
def setUp(self) -> None:
self.boxes15 = np.genfromtxt("boxes_15x15.data")
self.idx = index.Index()
for i, coords in enumerate(self.boxes15):
self.idx.add(i, coords)
def test_len(self) -> None:
self.assertEqual(len(self.idx), len(self.boxes15))
def test_get_size(self) -> None:
with pytest.deprecated_call():
self.assertEqual(self.idx.get_size(), len(self.boxes15))
class IndexBounds(unittest.TestCase):
def test_invalid_specifications(self) -> None:
"""Invalid specifications of bounds properly throw"""
idx = index.Index()
self.assertRaises(RTreeError, idx.add, None, (0.0, 0.0, -1.0, 1.0))
self.assertRaises(RTreeError, idx.intersection, (0.0, 0.0, -1.0, 1.0))
self.assertRaises(ctypes.ArgumentError, idx.add, None, (1, 1))
class IndexProperties(IndexTestCase):
@pytest.mark.skipif(
not hasattr(core.rt, "Index_GetResultSetOffset"),
reason="Index_GetResultsSetOffset required in libspatialindex",
)
def test_result_offset(self) -> None:
idx = index.Rtree()
idx.set_result_offset(3)
self.assertEqual(idx.result_offset, 3)
@pytest.mark.skipif(
not hasattr(core.rt, "Index_GetResultSetLimit"),
reason="Index_GetResultsSetOffset required in libspatialindex",
)
def test_result_limit(self) -> None:
idx = index.Rtree()
idx.set_result_limit(44)
self.assertEqual(idx.result_limit, 44)
def test_invalid_properties(self) -> None:
"""Invalid values are guarded"""
p = index.Property()
self.assertRaises(RTreeError, p.set_buffering_capacity, -4321)
self.assertRaises(RTreeError, p.set_region_pool_capacity, -4321)
self.assertRaises(RTreeError, p.set_point_pool_capacity, -4321)
self.assertRaises(RTreeError, p.set_index_pool_capacity, -4321)
self.assertRaises(RTreeError, p.set_pagesize, -4321)
self.assertRaises(RTreeError, p.set_index_capacity, -4321)
self.assertRaises(RTreeError, p.set_storage, -4321)
self.assertRaises(RTreeError, p.set_variant, -4321)
self.assertRaises(RTreeError, p.set_dimension, -2)
self.assertRaises(RTreeError, p.set_index_type, 6)
self.assertRaises(RTreeError, p.get_index_id)
def test_index_properties(self) -> None:
"""Setting index properties returns expected values"""
idx = index.Rtree()
p = index.Property()
p.leaf_capacity = 100
p.fill_factor = 0.5
p.index_capacity = 10
p.near_minimum_overlap_factor = 7
p.buffering_capacity = 10
p.variant = 0
p.dimension = 3
p.storage = 0
p.pagesize = 4096
p.index_pool_capacity = 1500
p.point_pool_capacity = 1600
p.region_pool_capacity = 1700
p.tight_mbr = True
p.overwrite = True
p.writethrough = True
p.tpr_horizon = 20.0
p.reinsert_factor = 0.3
p.idx_extension = "index"
p.dat_extension = "data"
idx = index.Index(properties=p)
props = idx.properties
self.assertEqual(props.leaf_capacity, 100)
self.assertEqual(props.fill_factor, 0.5)
self.assertEqual(props.index_capacity, 10)
self.assertEqual(props.near_minimum_overlap_factor, 7)
self.assertEqual(props.buffering_capacity, 10)
self.assertEqual(props.variant, 0)
self.assertEqual(props.dimension, 3)
self.assertEqual(props.storage, 0)
self.assertEqual(props.pagesize, 4096)
self.assertEqual(props.index_pool_capacity, 1500)
self.assertEqual(props.point_pool_capacity, 1600)
self.assertEqual(props.region_pool_capacity, 1700)
self.assertEqual(props.tight_mbr, True)
self.assertEqual(props.overwrite, True)
self.assertEqual(props.writethrough, True)
self.assertEqual(props.tpr_horizon, 20.0)
self.assertEqual(props.reinsert_factor, 0.3)
self.assertEqual(props.idx_extension, "index")
self.assertEqual(props.dat_extension, "data")
class TestPickling(unittest.TestCase):
# https://github.com/Toblerity/rtree/issues/87
@pytest.mark.xfail
def test_index(self) -> None:
idx = rtree.index.Index()
idx.insert(0, [0, 1, 2, 3], 4)
unpickled = pickle.loads(pickle.dumps(idx))
self.assertNotEqual(idx.handle, unpickled.handle)
self.assertEqual(idx.properties.as_dict(), unpickled.properties.as_dict())
self.assertEqual(idx.interleaved, unpickled.interleaved)
self.assertEqual(len(idx), len(unpickled))
self.assertEqual(idx.bounds, unpickled.bounds)
a = next(idx.intersection(idx.bounds, objects=True))
b = next(unpickled.intersection(unpickled.bounds, objects=True))
self.assertEqual(a.id, b.id)
self.assertEqual(a.bounds, b.bounds)
self.assertEqual(a.object, b.object)
def test_property(self) -> None:
p = rtree.index.Property()
unpickled = pickle.loads(pickle.dumps(p))
self.assertNotEqual(p.handle, unpickled.handle)
self.assertEqual(p.as_dict(), unpickled.as_dict())
class IndexContainer(IndexTestCase):
def test_container(self) -> None:
"""rtree.index.RtreeContainer works as expected"""
container = rtree.index.RtreeContainer()
objects = list()
for coordinates in self.boxes15:
objects.append(object())
container.insert(objects[-1], coordinates)
self.assertEqual(len(container), len(self.boxes15))
assert all(obj in container for obj in objects)
for obj, coordinates in zip(objects, self.boxes15[:5]):
container.delete(obj, coordinates)
assert all(obj in container for obj in objects[5:])
assert all(obj not in container for obj in objects[:5])
assert len(container) == len(self.boxes15) - 5
with pytest.raises(IndexError):
container.delete(objects[0], self.boxes15[0])
# Insert duplicate object, at different location
container.insert(objects[5], self.boxes15[0])
assert objects[5] in container
# And then delete it, but check object still present
container.delete(objects[5], self.boxes15[0])
assert objects[5] in container
# Intersection
obj = objects[10]
results = container.intersection(self.boxes15[10])
assert obj in results
# Intersection with bbox
obj = objects[10]
results = container.intersection(self.boxes15[10], bbox=True)
result = [result for result in results if result.object is obj][0]
assert np.array_equal(result.bbox, self.boxes15[10])
# Nearest
obj = objects[8]
results = container.intersection(self.boxes15[8])
assert obj in results
# Nearest with bbox
obj = objects[8]
results = container.nearest(self.boxes15[8], bbox=True)
result = [result for result in results if result.object is obj][0]
assert np.array_equal(result.bbox, self.boxes15[8])
# Test iter method
assert objects[12] in set(container)
class IndexIntersection(IndexTestCase):
def test_intersection(self) -> None:
"""Test basic insertion and retrieval"""
self.assertTrue(0 in self.idx.intersection((0, 0, 60, 60)))
hits = list(self.idx.intersection((0, 0, 60, 60)))
self.assertEqual(len(hits), 10)
self.assertEqual(hits, [0, 4, 16, 27, 35, 40, 47, 50, 76, 80])
def test_objects(self) -> None:
"""Test insertion of objects"""
idx = index.Index()
for i, coords in enumerate(self.boxes15):
idx.add(i, coords)
idx.insert(
4321, (34.3776829412, 26.7375853734, 49.3776829412, 41.7375853734), obj=42
)
hits = idx.intersection((0, 0, 60, 60), objects=True)
hit = [h for h in hits if h.id == 4321][0]
self.assertEqual(hit.id, 4321)
self.assertEqual(hit.object, 42)
box = [f"{t:.10f}" for t in hit.bbox]
expected = ["34.3776829412", "26.7375853734", "49.3776829412", "41.7375853734"]
self.assertEqual(box, expected)
def test_double_insertion(self) -> None:
"""Inserting the same id twice does not overwrite data"""
idx = index.Index()
idx.add(1, (2, 2))
idx.add(1, (3, 3))
self.assertEqual([1, 1], list(idx.intersection((0, 0, 5, 5))))
@skip_sidx_lt_210
def test_intersection_v(self) -> None:
mins = np.array([[0, 1]] * 2).T
maxs = np.array([[60, 50]] * 2).T
ret = self.idx.intersection_v(mins, maxs)
assert type(ret) is tuple
ids, counts = ret
assert ids.dtype == np.int64
ids0 = [0, 4, 16, 27, 35, 40, 47, 50, 76, 80]
ids1 = [0, 16, 27, 35, 47, 76]
assert ids.tolist() == ids0 + ids1
assert counts.dtype == np.uint64
assert counts.tolist() == [len(ids0), len(ids1)]
# errors
with pytest.raises(ValueError, match="must have 2 dimensions"):
self.idx.intersection_v(np.ones((2, 3, 4)), 4)
with pytest.raises(ValueError, match="shapes not equal"):
self.idx.intersection_v([0], [10, 12])
class TestIndexIntersectionUnion:
@pytest.fixture(scope="class")
def index_a_interleaved(self) -> index.Index:
idx = index.Index(interleaved=True)
idx.insert(1, (3, 3, 5, 5), "a_1")
idx.insert(2, (4, 2, 6, 4), "a_2")
return idx
@pytest.fixture(scope="class")
def index_a_uninterleaved(self) -> index.Index:
idx = index.Index(interleaved=False)
idx.insert(1, (3, 5, 3, 5), "a_1")
idx.insert(2, (4, 6, 2, 4), "a_2")
return idx
@pytest.fixture(scope="class")
def index_b_interleaved(self) -> index.Index:
idx = index.Index(interleaved=True)
idx.insert(3, (2, 1, 7, 6), "b_3")
idx.insert(4, (8, 7, 9, 8), "b_4")
return idx
@pytest.fixture(scope="class")
def index_b_uninterleaved(self) -> index.Index:
idx = index.Index(interleaved=False)
idx.insert(3, (2, 7, 1, 6), "b_3")
idx.insert(4, (8, 9, 7, 8), "b_4")
return idx
def test_intersection_interleaved(
self, index_a_interleaved: index.Index, index_b_interleaved: index.Index
) -> None:
index_c_interleaved = index_a_interleaved & index_b_interleaved
assert index_c_interleaved.interleaved
assert len(index_c_interleaved) == 2
for hit in index_c_interleaved.intersection(
index_c_interleaved.bounds, objects=True
):
if hit.bbox == [3.0, 3.0, 5.0, 5.0]:
assert hit.object == ("a_1", "b_3")
elif hit.bbox == [4.0, 2.0, 6.0, 4.0]:
assert hit.object == ("a_2", "b_3")
else:
assert False
@skip_sidx_lt_210
def test_intersection_v_interleaved(
self, index_a_interleaved: index.Index, index_b_interleaved: index.Index
) -> None:
index_c_interleaved = index_a_interleaved & index_b_interleaved
mins = index_c_interleaved.bounds[0:2]
maxs = index_c_interleaved.bounds[2:4]
idxs, counts = index_c_interleaved.intersection_v(mins, maxs)
assert idxs.tolist() == [0, 1]
assert counts.tolist() == [2]
def test_intersection_uninterleaved(
self, index_a_uninterleaved: index.Index, index_b_uninterleaved: index.Index
) -> None:
index_c_uninterleaved = index_a_uninterleaved & index_b_uninterleaved
assert not index_c_uninterleaved.interleaved
assert len(index_c_uninterleaved) == 2
for hit in index_c_uninterleaved.intersection(
index_c_uninterleaved.bounds, objects=True
):
if hit.bounds == [3.0, 5.0, 3.0, 5.0]:
assert hit.object == ("a_1", "b_3")
elif hit.bounds == [4.0, 6.0, 2.0, 4.0]:
assert hit.object == ("a_2", "b_3")
else:
assert False
@skip_sidx_lt_210
def test_intersection_v_uninterleaved(
self, index_a_uninterleaved: index.Index, index_b_uninterleaved: index.Index
) -> None:
index_c_uninterleaved = index_a_uninterleaved & index_b_uninterleaved
mins = index_c_uninterleaved.bounds[0::2]
maxs = index_c_uninterleaved.bounds[1::2]
idxs, counts = index_c_uninterleaved.intersection_v(mins, maxs)
assert idxs.tolist() == [0, 1]
assert counts.tolist() == [2]
def test_intersection_mismatch(
self, index_a_interleaved: index.Index, index_b_uninterleaved: index.Index
) -> None:
with pytest.raises(AssertionError):
index_a_interleaved & index_b_uninterleaved
def test_union_interleaved(
self, index_a_interleaved: index.Index, index_b_interleaved: index.Index
) -> None:
index_c_interleaved = index_a_interleaved | index_b_interleaved
assert index_c_interleaved.interleaved
assert len(index_c_interleaved) == 4
for hit in index_c_interleaved.intersection(
index_c_interleaved.bounds, objects=True
):
if hit.bbox == [3.0, 3.0, 5.0, 5.0]:
assert hit.object == "a_1"
elif hit.bbox == [4.0, 2.0, 6.0, 4.0]:
assert hit.object == "a_2"
elif hit.bbox == [2.0, 1.0, 7.0, 6.0]:
assert hit.object == "b_3"
elif hit.bbox == [8.0, 7.0, 9.0, 8.0]:
assert hit.object == "b_4"
else:
assert False
def test_union_uninterleaved(
self, index_a_uninterleaved: index.Index, index_b_uninterleaved: index.Index
) -> None:
index_c_uninterleaved = index_a_uninterleaved | index_b_uninterleaved
assert not index_c_uninterleaved.interleaved
assert len(index_c_uninterleaved) == 4
for hit in index_c_uninterleaved.intersection(
index_c_uninterleaved.bounds, objects=True
):
if hit.bounds == [3.0, 5.0, 3.0, 5.0]:
assert hit.object == "a_1"
elif hit.bounds == [4.0, 6.0, 2.0, 4.0]:
assert hit.object == "a_2"
elif hit.bounds == [2.0, 7.0, 1.0, 6.0]:
assert hit.object == "b_3"
elif hit.bounds == [8.0, 9.0, 7.0, 8.0]:
assert hit.object == "b_4"
else:
assert False
def test_union_mismatch(
self, index_a_interleaved: index.Index, index_b_uninterleaved: index.Index
) -> None:
with pytest.raises(AssertionError):
index_a_interleaved | index_b_uninterleaved
class IndexSerialization(unittest.TestCase):
def setUp(self) -> None:
self.boxes15 = np.genfromtxt("boxes_15x15.data")
def boxes15_stream(
self, interleaved: bool = True
) -> Iterator[tuple[int, tuple[float, float, float, float], int]]:
for i, (minx, miny, maxx, maxy) in enumerate(self.boxes15):
if interleaved:
yield (i, (minx, miny, maxx, maxy), 42)
else:
yield (i, (minx, maxx, miny, maxy), 42)
def test_unicode_filenames(self) -> None:
"""Unicode filenames work as expected"""
tname = tempfile.mktemp()
filename = tname + "gilename\u4500abc"
idx = index.Index(filename)
idx.insert(
4321, (34.3776829412, 26.7375853734, 49.3776829412, 41.7375853734), obj=42
)
def test_pickling(self) -> None:
"""Pickling works as expected"""
idx = index.Index()
import json
some_data = {"a": 22, "b": [1, "ccc"]}
# https://github.com/python/mypy/issues/2427
idx.dumps = lambda obj: json.dumps(obj).encode( # type: ignore[assignment]
"utf-8"
)
idx.loads = lambda string: json.loads( # type: ignore[assignment]
string.decode("utf-8")
)
idx.add(0, (0, 0, 1, 1), some_data)
self.assertEqual(list(idx.nearest((0, 0), 1, objects="raw"))[0], some_data)
def test_custom_filenames(self) -> None:
"""Test using custom filenames for index serialization"""
p = index.Property()
p.dat_extension = "data"
p.idx_extension = "index"
tname = tempfile.mktemp()
idx = index.Index(tname, properties=p)
for i, coords in enumerate(self.boxes15):
idx.add(i, coords)
hits = list(idx.intersection((0, 0, 60, 60)))
self.assertEqual(len(hits), 10)
self.assertEqual(hits, [0, 4, 16, 27, 35, 40, 47, 50, 76, 80])
del idx
# Check we can reopen the index and get the same results
idx2 = index.Index(tname, properties=p)
hits = list(idx2.intersection((0, 0, 60, 60)))
self.assertEqual(len(hits), 10)
self.assertEqual(hits, [0, 4, 16, 27, 35, 40, 47, 50, 76, 80])
@pytest.mark.skipif(not sys.maxsize > 2**32, reason="Fails on 32bit systems")
def test_interleaving(self) -> None:
"""Streaming against a persisted index without interleaving"""
def data_gen(
interleaved: bool = True,
) -> Iterator[tuple[int, tuple[float, float, float, float], int]]:
for i, (minx, miny, maxx, maxy) in enumerate(self.boxes15):
if interleaved:
yield (i, (minx, miny, maxx, maxy), 42)
else:
yield (i, (minx, maxx, miny, maxy), 42)
p = index.Property()
tname = tempfile.mktemp()
idx = index.Index(
tname, data_gen(interleaved=False), properties=p, interleaved=False
)
hits1 = sorted(list(idx.intersection((0, 60, 0, 60))))
self.assertEqual(len(hits1), 10)
self.assertEqual(hits1, [0, 4, 16, 27, 35, 40, 47, 50, 76, 80])
leaves = idx.leaves()
expected = [
(
0,
[
2,
92,
51,
55,
26,
95,
7,
81,
38,
22,
58,
89,
91,
83,
98,
37,
70,
31,
49,
34,
11,
6,
13,
3,
23,
57,
9,
96,
84,
36,
5,
45,
77,
78,
44,
12,
42,
73,
93,
41,
71,
17,
39,
54,
88,
72,
97,
60,
62,
48,
19,
25,
76,
59,
66,
64,
79,
94,
40,
32,
46,
47,
15,
68,
10,
0,
80,
56,
50,
30,
],
[-186.673789279, -96.7177218184, 172.392784956, 45.4856075292],
),
(
2,
[
61,
74,
29,
99,
16,
43,
35,
33,
27,
63,
18,
90,
8,
53,
82,
21,
65,
24,
4,
1,
75,
67,
86,
52,
28,
85,
87,
14,
69,
20,
],
[-174.739939684, 32.6596016791, 184.761387556, 96.6043699778],
),
]
# go through the traversal and see if everything is close
assert all(
all(np.allclose(a, b) for a, b in zip(L, E)) # type: ignore
for L, E in zip(leaves, expected)
)
hits2 = sorted(list(idx.intersection((0, 60, 0, 60), objects=True)))
self.assertEqual(len(hits2), 10)
self.assertEqual(hits2[0].object, 42)
def test_overwrite(self) -> None:
"""Index overwrite works as expected"""
tname = tempfile.mktemp()
idx = index.Index(tname)
del idx
idx = index.Index(tname, overwrite=True)
assert isinstance(idx, index.Index)
class IndexNearest(IndexTestCase):
def test_nearest_basic(self) -> None:
"""Test nearest basic selection of records"""
hits = list(self.idx.nearest((0, 0, 10, 10), 3))
self.assertEqual(hits, [76, 48, 19])
idx = index.Index()
locs = [(2, 4), (6, 8), (10, 12), (11, 13), (15, 17), (13, 20)]
for i, (start, stop) in enumerate(locs):
idx.add(i, (start, 1, stop, 1))
hits = sorted(idx.nearest((13, 0, 20, 2), 3))
self.assertEqual(hits, [3, 4, 5])
@skip_sidx_lt_210
def test_nearest_v_basic(self) -> None:
mins = np.array([[0, 5]] * 2).T
maxs = np.array([[10, 15]] * 2).T
ret = self.idx.nearest_v(mins, maxs, num_results=3)
assert type(ret) is tuple
ids, counts = ret
assert ids.dtype == np.int64
ids0 = [76, 48, 19]
ids1 = [76, 47, 48]
assert ids.tolist() == ids0 + ids1
assert counts.dtype == np.uint64
assert counts.tolist() == [3, 3]
ret = self.idx.nearest_v(mins, maxs, num_results=3, return_max_dists=True)
assert type(ret) is tuple
ids, counts, max_dists = ret
assert ids.tolist() == ids0 + ids1
assert counts.tolist() == [3, 3]
assert max_dists.dtype == np.float64
np.testing.assert_allclose(max_dists, [7.54938045, 11.05686397])
ret = self.idx.nearest_v(
mins, maxs, num_results=3, max_dists=[10, 10], return_max_dists=True
)
ids, counts, max_dists = ret
assert ids.tolist() == ids0 + ids1[:2]
assert counts.tolist() == [3, 2]
np.testing.assert_allclose(max_dists, [7.54938045, 3.92672575])
# errors
with pytest.raises(ValueError, match="must have 2 dimensions"):
self.idx.nearest_v(np.ones((2, 3, 4)), 4)
with pytest.raises(ValueError, match="shapes not equal"):
self.idx.nearest_v([0], [10, 12])
with pytest.raises(ValueError, match="max_dists must have 1 dimension"):
self.idx.nearest_v(maxs, mins, max_dists=[[10]])
with pytest.raises(ValueError, match="max_dists must have length 2"):
self.idx.nearest_v(maxs, mins, max_dists=[10])
def test_nearest_equidistant(self) -> None:
"""Test that if records are equidistant, both are returned."""
point = (0, 0)
small_box = (-10, -10, 10, 10)
large_box = (-50, -50, 50, 50)
idx = index.Index()
idx.insert(0, small_box)
idx.insert(1, large_box)
self.assertEqual(list(idx.nearest(point, 2)), [0, 1])
self.assertEqual(list(idx.nearest(point, 1)), [0, 1])
idx.insert(2, (0, 0))
self.assertEqual(list(idx.nearest(point, 2)), [0, 1, 2])
self.assertEqual(list(idx.nearest(point, 1)), [0, 1, 2])
idx = index.Index()
idx.insert(0, small_box)
idx.insert(1, large_box)
idx.insert(2, (50, 50)) # point on top right vertex of large_box
point = (51, 51) # right outside of large_box
self.assertEqual(list(idx.nearest(point, 2)), [1, 2])
self.assertEqual(list(idx.nearest(point, 1)), [1, 2])
idx = index.Index()
idx.insert(0, small_box)
idx.insert(1, large_box)
# point right outside on top right vertex of large_box
idx.insert(2, (51, 51))
point = (51, 52) # shifted 1 unit up from the point above
self.assertEqual(list(idx.nearest(point, 2)), [2, 1])
self.assertEqual(list(idx.nearest(point, 1)), [2])
def test_nearest_object(self) -> None:
"""Test nearest object selection of records"""
idx = index.Index()
locs = [(14, 10, 14, 10), (16, 10, 16, 10)]
for i, (minx, miny, maxx, maxy) in enumerate(locs):
idx.add(i, (minx, miny, maxx, maxy), obj={"a": 42})
hits = sorted(
(i.id, i.object) for i in idx.nearest((15, 10, 15, 10), 1, objects=True)
)
self.assertEqual(hits, [(0, {"a": 42}), (1, {"a": 42})])
class IndexDelete(IndexTestCase):
def test_deletion(self) -> None:
"""Test we can delete data from the index"""
idx = index.Index()
for i, coords in enumerate(self.boxes15):
idx.add(i, coords)
for i, coords in enumerate(self.boxes15):
idx.delete(i, coords)
hits = list(idx.intersection((0, 0, 60, 60)))
self.assertEqual(hits, [])
class Index3d(IndexTestCase):
"""Test we make and query a 3D index"""
def setUp(self) -> None:
p = index.Property()
p.dimension = 3
self.idx = index.Index(properties=p, interleaved=False)
self.idx.insert(1, (0, 0, 60, 60, 22, 22.0))
self.coords = (-1, 1, 58, 62, 22, 24)
def test_intersection(self) -> None:
hits = self.idx.intersection(self.coords)
self.assertEqual(list(hits), [1])
@skip_sidx_lt_210
def test_intersection_v(self) -> None:
idxs, counts = self.idx.intersection_v(self.coords[0::2], self.coords[1::2])
assert idxs.tolist() == [1]
assert counts.tolist() == [1]
class Index4d(IndexTestCase):
"""Test we make and query a 4D index"""
def setUp(self) -> None:
p = index.Property()
p.dimension = 4
self.idx = index.Index(properties=p, interleaved=False)
self.idx.insert(1, (0, 0, 60, 60, 22, 22.0, 128, 142))
self.coords = (-1, 1, 58, 62, 22, 24, 120, 150)
def test_intersection(self) -> None:
hits = self.idx.intersection(self.coords)
self.assertEqual(list(hits), [1])
@skip_sidx_lt_210
def test_intersection_v(self) -> None:
idxs, counts = self.idx.intersection_v(self.coords[0::2], self.coords[1::2])
assert idxs.tolist() == [1]
assert counts.tolist() == [1]
class IndexStream(IndexTestCase):
def test_stream_input(self) -> None:
p = index.Property()
sindex = index.Index(self.boxes15_stream(), properties=p)
bounds = (0, 0, 60, 60)
hits = sindex.intersection(bounds)
self.assertEqual(sorted(hits), [0, 4, 16, 27, 35, 40, 47, 50, 76, 80])
objects = list(sindex.intersection((0, 0, 60, 60), objects=True))
self.assertEqual(len(objects), 10)
self.assertEqual(objects[0].object, 42)
def test_empty_stream(self) -> None:
"""Assert empty stream raises exception"""
self.assertRaises(RTreeError, index.Index, iter(()))
def test_exception_in_generator(self) -> None:
"""Assert exceptions raised in callbacks are raised in main thread"""
class TestException(Exception):
pass
def create_index() -> index.Index:
def gen() -> Iterator[tuple[int, tuple[int, int, int, int], None]]:
# insert at least 6 or so before the exception
for i in range(10):
yield (i, (1, 2, 3, 4), None)
raise TestException("raising here")
return index.Index(gen())
self.assertRaises(TestException, create_index)
def test_exception_at_beginning_of_generator(self) -> None:
"""
Assert exceptions raised in callbacks before generator
function are raised in main thread.
"""
class TestException(Exception):
pass
def create_index() -> index.Index:
def gen() -> None:
raise TestException("raising here")
return index.Index(gen()) # type: ignore[func-returns-value]
self.assertRaises(TestException, create_index)
class DictStorage(index.CustomStorage):
"""A simple storage which saves the pages in a python dictionary"""
def __init__(self) -> None:
index.CustomStorage.__init__(self)
self.clear()
def create(self, returnError):
"""Called when the storage is created on the C side"""
def destroy(self, returnError):
"""Called when the storage is destroyed on the C side"""
def clear(self) -> None:
"""Clear all our data"""
self.dict: dict = {}
def loadByteArray(self, page, returnError):
"""Returns the data for page or returns an error"""
try:
return self.dict[page]
except KeyError:
returnError.contents.value = self.InvalidPageError
def storeByteArray(self, page, data, returnError):
"""Stores the data for page"""
if page == self.NewPage:
newPageId = len(self.dict)
self.dict[newPageId] = data
return newPageId
else:
if page not in self.dict:
returnError.value = self.InvalidPageError
return 0
self.dict[page] = data
return page
def deleteByteArray(self, page, returnError):
"""Deletes a page"""
try:
del self.dict[page]
except KeyError:
returnError.contents.value = self.InvalidPageError
hasData = property(lambda self: bool(self.dict))
""" Returns true if we contains some data """
class IndexCustomStorage(unittest.TestCase):
def test_custom_storage(self) -> None:
"""Custom index storage works as expected"""
settings = index.Property()
settings.writethrough = True
settings.buffering_capacity = 1
# Notice that there is a small in-memory buffer by default.
# We effectively disable it here so our storage directly receives
# any load/store/delete calls.
# This is not necessary in general and can hamper performance;
# we just use it here for illustrative and testing purposes.
storage = DictStorage()
r = index.Index(storage, properties=settings)
# Interestingly enough, if we take a look at the contents of our
# storage now, we can see the Rtree has already written two pages
# to it. This is for header and index.
state1 = storage.dict.copy()
self.assertEqual(list(state1.keys()), [0, 1])
r.add(123, (0, 0, 1, 1))
state2 = storage.dict.copy()
self.assertNotEqual(state1, state2)
item = list(r.nearest((0, 0), 1, objects=True))[0]
self.assertEqual(item.id, 123)
self.assertTrue(r.valid())
self.assertTrue(isinstance(list(storage.dict.values())[0], bytes))
r.delete(123, (0, 0, 1, 1))
self.assertTrue(r.valid())
r.clearBuffer()
self.assertTrue(r.valid())
del r
storage.clear()
self.assertFalse(storage.hasData)
del storage
def test_custom_storage_reopening(self) -> None:
"""Reopening custom index storage works as expected"""
storage = DictStorage()
r1 = index.Index(storage, overwrite=True)
r1.add(555, (2, 2))
del r1
self.assertTrue(storage.hasData)
r2 = index.Index(storage, overwrite=False)
count = r2.count((0, 0, 10, 10))
self.assertEqual(count, 1)
|