/usr/lib/python3/dist-packages/rtree/index.py is in python3-rtree 0.8.3+ds-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 | import os
import os.path
import pprint
from . import core
import ctypes
try:
import cPickle as pickle
except ImportError:
import pickle
import sys
if sys.version_info[0] == 2:
range = xrange
string_types = basestring
elif sys.version_info[0] == 3:
string_types = str
def string_output(s):
if sys.version_info[0] == 2:
return s
elif sys.version_info[0] == 3:
return s.decode('UTF-8')
RT_Memory = 0
RT_Disk = 1
RT_Custom = 2
RT_Linear = 0
RT_Quadratic = 1
RT_Star = 2
RT_RTree = 0
RT_MVRTree = 1
RT_TPRTree = 2
__c_api_version__ = core.rt.SIDX_Version()
major_version, minor_version, patch_version = [
int(t) for t in __c_api_version__.decode('utf-8').split('.')]
if (major_version < 2 and minor_version < 7):
raise Exception(
"This version of Rtree requires libspatialindex 1.7.0 or greater")
__all__ = ['Rtree', 'Index', 'Property']
def _get_bounds(handle, bounds_fn, interleaved):
pp_mins = ctypes.pointer(ctypes.c_double())
pp_maxs = ctypes.pointer(ctypes.c_double())
dimension = ctypes.c_uint32(0)
bounds_fn(
handle,
ctypes.byref(pp_mins),
ctypes.byref(pp_maxs),
ctypes.byref(dimension))
if (dimension.value == 0):
return None
mins = ctypes.cast(pp_mins, ctypes.POINTER(ctypes.c_double
* dimension.value))
maxs = ctypes.cast(pp_maxs, ctypes.POINTER(ctypes.c_double
* dimension.value))
results = [mins.contents[i] for i in range(dimension.value)]
results += [maxs.contents[i] for i in range(dimension.value)]
p_mins = ctypes.cast(mins, ctypes.POINTER(ctypes.c_double))
p_maxs = ctypes.cast(maxs, ctypes.POINTER(ctypes.c_double))
core.rt.Index_Free(ctypes.cast(p_mins, ctypes.POINTER(ctypes.c_void_p)))
core.rt.Index_Free(ctypes.cast(p_maxs, ctypes.POINTER(ctypes.c_void_p)))
if interleaved: # they want bbox order.
return results
return Index.deinterleave(results)
def _get_data(handle):
length = ctypes.c_uint64(0)
d = ctypes.pointer(ctypes.c_uint8(0))
core.rt.IndexItem_GetData(handle, ctypes.byref(d), ctypes.byref(length))
c = ctypes.cast(d, ctypes.POINTER(ctypes.c_void_p))
if length.value == 0:
core.rt.Index_Free(c)
return None
s = ctypes.string_at(d, length.value)
core.rt.Index_Free(c)
return s
class Index(object):
"""An R-Tree, MVR-Tree, or TPR-Tree indexing object"""
def __init__(self, *args, **kwargs):
"""Creates a new index
:param filename:
The first argument in the constructor is assumed to be a filename
determining that a file-based storage for the index should be used.
If the first argument is not of type basestring, it is then assumed
to be an instance of ICustomStorage or derived class.
If the first argument is neither of type basestring nor an instance
of ICustomStorage, it is then assumed to be an input index item
stream.
:param stream:
If the first argument in the constructor is not of type basestring,
it is assumed to be an iterable stream of data that will raise a
StopIteration. It must be in the form defined by the
:attr:`interleaved` attribute of the index. The following example
would assume :attr:`interleaved` is False::
(id, (minx, maxx, miny, maxy, minz, maxz, ..., ..., mink, maxk),
object)
The object can be None, but you must put a place holder of
``None`` there.
:param storage:
If the first argument in the constructor is an instance of
ICustomStorage then the given custom storage is used.
:param interleaved: True or False, defaults to True.
This parameter determines the coordinate order for all methods that
take in coordinates.
:param properties: An :class:`index.Property` object
This object sets both the creation and instantiation properties
for the object and they are passed down into libspatialindex.
A few properties are curried from instantiation parameters
for you like ``pagesize`` and ``overwrite``
to ensure compatibility with previous versions of the library. All
other properties must be set on the object.
.. warning::
The coordinate ordering for all functions are sensitive the
index's :attr:`interleaved` data member. If :attr:`interleaved`
is False, the coordinates must be in the form
[xmin, xmax, ymin, ymax, ..., ..., kmin, kmax]. If
:attr:`interleaved` is True, the coordinates must be in the form
[xmin, ymin, ..., kmin, xmax, ymax, ..., kmax].
A basic example
::
>>> from rtree import index
>>> p = index.Property()
>>> idx = index.Index(properties=p)
>>> idx # doctest: +ELLIPSIS
<rtree.index.Index object at 0x...>
Insert an item into the index::
>>> idx.insert(4321, (34.3776829412, 26.7375853734, 49.3776829412,
41.7375853734), obj=42)
Query::
>>> hits = idx.intersection((0, 0, 60, 60), objects=True)
>>> for i in hits:
... if i.id == 4321:
... i.object
... i.bbox
42
[34.3776829412, 26.737585373400002, 49.3776829412,
41.737585373400002]
Using custom serializers::
>>> import simplejson
>>> class JSONIndex(index.Index):
... dumps = staticmethod(simplejson.dumps)
... loads = staticmethod(simplejson.loads)
>>> json_idx = JSONIndex()
>>> json_idx.insert(1, (0, 1, 0, 1), {"nums": [23, 45],
"letters": "abcd"})
>>> list(json_idx.nearest((0, 0), 1, objects="raw"))
[{'letters': 'abcd', 'nums': [23, 45]}]
"""
self.properties = kwargs.get('properties', Property())
# interleaved True gives 'bbox' order.
self.interleaved = bool(kwargs.get('interleaved', True))
stream = None
basename = None
storage = None
if args:
if isinstance(args[0], string_types) or isinstance(args[0], bytes):
# they sent in a filename
basename = args[0]
# they sent in a filename, stream
if len(args) > 1:
stream = args[1]
elif isinstance(args[0], ICustomStorage):
storage = args[0]
# they sent in a storage, stream
if len(args) > 1:
stream = args[1]
else:
stream = args[0]
if basename:
self.properties.storage = RT_Disk
self.properties.filename = basename
# check we can read the file
f = basename + "." + self.properties.idx_extension
p = os.path.abspath(f)
# assume if the file exists, we're not going to overwrite it
# unless the user explicitly set the property to do so
if os.path.exists(p):
self.properties.overwrite = \
bool(kwargs.get('overwrite', False))
# assume we're fetching the first index_id. If the user
# set it, we'll fetch that one.
if not self.properties.overwrite:
try:
self.properties.index_id
except core.RTreeError:
self.properties.index_id = 1
d = os.path.dirname(p)
if not os.access(d, os.W_OK):
message = "Unable to open file '%s' for index storage" % f
raise OSError(message)
elif storage:
if (major_version < 2 and minor_version < 8):
raise core.RTreeError(
"libspatialindex {0} does not support custom storage"
.format(__c_api_version__))
self.properties.storage = RT_Custom
if storage.hasData:
self.properties.overwrite = \
bool(kwargs.get('overwrite', False))
if not self.properties.overwrite:
try:
self.properties.index_id
except core.RTreeError:
self.properties.index_id = 1
else:
storage.clear()
self.customstorage = storage
storage.registerCallbacks(self.properties)
else:
self.properties.storage = RT_Memory
ps = kwargs.get('pagesize', None)
if ps:
self.properties.pagesize = int(ps)
if stream:
self.handle = self._create_idx_from_stream(stream)
else:
self.handle = IndexHandle(self.properties.handle)
def __getstate__(self):
state = self.__dict__.copy()
del state["handle"]
return state
def __setstate__(self, state):
self.__dict__.update(state)
self.handle = IndexHandle(self.properties.handle)
def dumps(self, obj):
return pickle.dumps(obj)
def loads(self, string):
return pickle.loads(string)
def close(self):
"""Force a flush of the index to storage. Renders index
inaccessible."""
if self.handle:
self.handle.destroy()
self.handle = None
else:
raise IOError("Unclosable index")
def get_coordinate_pointers(self, coordinates):
try:
iter(coordinates)
except TypeError:
raise TypeError('Bounds must be a sequence')
dimension = self.properties.dimension
mins = ctypes.c_double * dimension
maxs = ctypes.c_double * dimension
if not self.interleaved:
coordinates = Index.interleave(coordinates)
# it's a point make it into a bbox. [x, y] => [x, y, x, y]
if len(coordinates) == dimension:
coordinates += coordinates
if len(coordinates) != dimension * 2:
raise core.RTreeError(
"Coordinates must be in the form "
"(minx, miny, maxx, maxy) or (x, y) for 2D indexes")
# so here all coords are in the form:
# [xmin, ymin, zmin, xmax, ymax, zmax]
for i in range(dimension):
if not coordinates[i] <= coordinates[i + dimension]:
raise core.RTreeError(
"Coordinates must not have minimums more than maximums")
p_mins = mins(
*[ctypes.c_double(coordinates[i]) for i in range(dimension)])
p_maxs = maxs(
*[ctypes.c_double(coordinates[i + dimension])
for i in range(dimension)])
return (p_mins, p_maxs)
def _serialize(self, obj):
serialized = self.dumps(obj)
size = len(serialized)
d = ctypes.create_string_buffer(serialized)
# d.value = serialized
p = ctypes.pointer(d)
# return serialized to keep it alive for the pointer.
return size, ctypes.cast(p, ctypes.POINTER(ctypes.c_uint8)), serialized
def insert(self, id, coordinates, obj=None):
"""Inserts an item into the index with the given coordinates.
:param id: long integer
A long integer that is the identifier for this index entry. IDs
need not be unique to be inserted into the index, and it is up
to the user to ensure they are unique if this is a requirement.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
:param obj: a pickleable object. If not None, this object will be
stored in the index with the :attr:`id`.
The following example inserts an entry into the index with id `4321`,
and the object it stores with that id is the number `42`. The
coordinate ordering in this instance is the default (interleaved=True)
ordering::
>>> from rtree import index
>>> idx = index.Index()
>>> idx.insert(4321, (34.3776829412, 26.7375853734, 49.3776829412,
41.7375853734), obj=42)
"""
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
data = ctypes.c_ubyte(0)
size = 0
pyserialized = None
if obj is not None:
size, data, pyserialized = self._serialize(obj)
core.rt.Index_InsertData(self.handle, id, p_mins, p_maxs,
self.properties.dimension, data, size)
add = insert
def count(self, coordinates):
"""Return number of objects that intersect the given coordinates.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
The following example queries the index for any objects any objects
that were stored in the index intersect the bounds given in the
coordinates::
>>> from rtree import index
>>> idx = index.Index()
>>> idx.insert(4321, (34.3776829412, 26.7375853734, 49.3776829412,
41.7375853734), obj=42)
>>> idx.count((0, 0, 60, 60))
1
"""
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
p_num_results = ctypes.c_uint64(0)
core.rt.Index_Intersects_count(self.handle,
p_mins,
p_maxs,
self.properties.dimension,
ctypes.byref(p_num_results))
return p_num_results.value
def intersection(self, coordinates, objects=False):
"""Return ids or objects in the index that intersect the given
coordinates.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
:param objects: True or False or 'raw'
If True, the intersection method will return index objects that
were pickled when they were stored with each index entry, as well
as the id and bounds of the index entries. If 'raw', the objects
will be returned without the :class:`rtree.index.Item` wrapper.
The following example queries the index for any objects any objects
that were stored in the index intersect the bounds given in the
coordinates::
>>> from rtree import index
>>> idx = index.Index()
>>> idx.insert(4321, (34.3776829412, 26.7375853734, 49.3776829412,
41.7375853734), obj=42)
>>> hits = list(idx.intersection((0, 0, 60, 60), objects=True))
>>> [(item.object, item.bbox) for item in hits if item.id == 4321]
[(42, [34.3776829412, 26.737585373400002, 49.3776829412,
41.737585373400002])]
If the :class:`rtree.index.Item` wrapper is not used, it is faster to
request the 'raw' objects::
>>> list(idx.intersection((0, 0, 60, 60), objects="raw"))
[42]
"""
if objects:
return self._intersection_obj(coordinates, objects)
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
p_num_results = ctypes.c_uint64(0)
it = ctypes.pointer(ctypes.c_int64())
core.rt.Index_Intersects_id(self.handle,
p_mins,
p_maxs,
self.properties.dimension,
ctypes.byref(it),
ctypes.byref(p_num_results))
return self._get_ids(it, p_num_results.value)
def _intersection_obj(self, coordinates, objects):
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
p_num_results = ctypes.c_uint64(0)
it = ctypes.pointer(ctypes.c_void_p())
core.rt.Index_Intersects_obj(self.handle,
p_mins,
p_maxs,
self.properties.dimension,
ctypes.byref(it),
ctypes.byref(p_num_results))
return self._get_objects(it, p_num_results.value, objects)
def _get_objects(self, it, num_results, objects):
# take the pointer, yield the result objects and free
items = ctypes.cast(
it, ctypes.POINTER(ctypes.POINTER(ctypes.c_void_p * num_results)))
its = ctypes.cast(
items, ctypes.POINTER(ctypes.POINTER(ctypes.c_void_p)))
try:
if objects != 'raw':
for i in range(num_results):
yield Item(self.loads, items[i])
else:
for i in range(num_results):
data = _get_data(items[i])
if data is None:
yield data
else:
yield self.loads(data)
core.rt.Index_DestroyObjResults(its, num_results)
except: # need to catch all exceptions, not just rtree.
core.rt.Index_DestroyObjResults(its, num_results)
raise
def _get_ids(self, it, num_results):
# take the pointer, yield the results and free
items = ctypes.cast(it, ctypes.POINTER(ctypes.c_int64 * num_results))
its = ctypes.cast(items, ctypes.POINTER(ctypes.c_void_p))
try:
for i in range(num_results):
yield items.contents[i]
core.rt.Index_Free(its)
except:
core.rt.Index_Free(its)
raise
def _nearest_obj(self, coordinates, num_results, objects):
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
p_num_results = ctypes.pointer(ctypes.c_uint64(num_results))
it = ctypes.pointer(ctypes.c_void_p())
core.rt.Index_NearestNeighbors_obj(self.handle,
p_mins,
p_maxs,
self.properties.dimension,
ctypes.byref(it),
p_num_results)
return self._get_objects(it, p_num_results.contents.value, objects)
def nearest(self, coordinates, num_results=1, objects=False):
"""Returns the ``k``-nearest objects to the given coordinates.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
:param num_results: integer
The number of results to return nearest to the given coordinates.
If two index entries are equidistant, *both* are returned.
This property means that :attr:`num_results` may return more
items than specified
:param objects: True / False / 'raw'
If True, the nearest method will return index objects that
were pickled when they were stored with each index entry, as
well as the id and bounds of the index entries.
If 'raw', it will return the object as entered into the database
without the :class:`rtree.index.Item` wrapper.
Example of finding the three items nearest to this one::
>>> from rtree import index
>>> idx = index.Index()
>>> idx.insert(4321, (34.37, 26.73, 49.37, 41.73), obj=42)
>>> hits = idx.nearest((0, 0, 10, 10), 3, objects=True)
"""
if objects:
return self._nearest_obj(coordinates, num_results, objects)
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
p_num_results = ctypes.pointer(ctypes.c_uint64(num_results))
it = ctypes.pointer(ctypes.c_int64())
core.rt.Index_NearestNeighbors_id(self.handle,
p_mins,
p_maxs,
self.properties.dimension,
ctypes.byref(it),
p_num_results)
return self._get_ids(it, p_num_results.contents.value)
def get_bounds(self, coordinate_interleaved=None):
"""Returns the bounds of the index
:param coordinate_interleaved: If True, the coordinates are turned
in the form [xmin, ymin, ..., kmin, xmax, ymax, ..., kmax],
otherwise they are returned as
[xmin, xmax, ymin, ymax, ..., ..., kmin, kmax]. If not specified,
the :attr:`interleaved` member of the index is used, which
defaults to True.
"""
if coordinate_interleaved is None:
coordinate_interleaved = self.interleaved
return _get_bounds(
self.handle, core.rt.Index_GetBounds, coordinate_interleaved)
bounds = property(get_bounds)
def delete(self, id, coordinates):
"""Deletes items from the index with the given ``'id'`` within the
specified coordinates.
:param id: long integer
A long integer that is the identifier for this index entry. IDs
need not be unique to be inserted into the index, and it is up
to the user to ensure they are unique if this is a requirement.
:param coordinates: sequence or array
Dimension * 2 coordinate pairs, representing the min
and max coordinates in each dimension of the item to be
deleted from the index. Their ordering will depend on the
index's :attr:`interleaved` data member.
These are not the coordinates of a space containing the
item, but those of the item itself. Together with the
id parameter, they determine which item will be deleted.
This may be an object that satisfies the numpy array protocol.
Example::
>>> from rtree import index
>>> idx = index.Index()
>>> idx.delete(4321, (34.3776829412, 26.7375853734, 49.3776829412,
41.7375853734))
"""
p_mins, p_maxs = self.get_coordinate_pointers(coordinates)
core.rt.Index_DeleteData(
self.handle, id, p_mins, p_maxs, self.properties.dimension)
def valid(self):
return bool(core.rt.Index_IsValid(self.handle))
def clearBuffer(self):
return core.rt.Index_ClearBuffer(self.handle)
@classmethod
def deinterleave(self, interleaved):
"""
[xmin, ymin, xmax, ymax] => [xmin, xmax, ymin, ymax]
>>> Index.deinterleave([0, 10, 1, 11])
[0, 1, 10, 11]
>>> Index.deinterleave([0, 1, 2, 10, 11, 12])
[0, 10, 1, 11, 2, 12]
"""
assert len(interleaved) % 2 == 0, ("must be a pairwise list")
dimension = len(interleaved) // 2
di = []
for i in range(dimension):
di.extend([interleaved[i], interleaved[i + dimension]])
return di
@classmethod
def interleave(self, deinterleaved):
"""
[xmin, xmax, ymin, ymax, zmin, zmax]
=> [xmin, ymin, zmin, xmax, ymax, zmax]
>>> Index.interleave([0, 1, 10, 11])
[0, 10, 1, 11]
>>> Index.interleave([0, 10, 1, 11, 2, 12])
[0, 1, 2, 10, 11, 12]
>>> Index.interleave((-1, 1, 58, 62, 22, 24))
[-1, 58, 22, 1, 62, 24]
"""
assert len(deinterleaved) % 2 == 0, ("must be a pairwise list")
# dimension = len(deinterleaved) / 2
interleaved = []
for i in range(2):
interleaved.extend([deinterleaved[i + j]
for j in range(0, len(deinterleaved), 2)])
return interleaved
def _create_idx_from_stream(self, stream):
"""This function is used to instantiate the index given an
iterable stream of data."""
stream_iter = iter(stream)
dimension = self.properties.dimension
darray = ctypes.c_double * dimension
mins = darray()
maxs = darray()
no_data = ctypes.cast(ctypes.pointer(ctypes.c_ubyte(0)),
ctypes.POINTER(ctypes.c_ubyte))
def py_next_item(p_id, p_mins, p_maxs, p_dimension, p_data, p_length):
"""This function must fill pointers to individual entries that will
be added to the index. The C API will actually call this function
to fill out the pointers. If this function returns anything other
than 0, it is assumed that the stream of data is done."""
try:
p_id[0], coordinates, obj = next(stream_iter)
except StopIteration:
# we're done
return -1
if self.interleaved:
coordinates = Index.deinterleave(coordinates)
# this code assumes the coords are not interleaved.
# xmin, xmax, ymin, ymax, zmin, zmax
for i in range(dimension):
mins[i] = coordinates[i*2]
maxs[i] = coordinates[(i*2)+1]
p_mins[0] = ctypes.cast(mins, ctypes.POINTER(ctypes.c_double))
p_maxs[0] = ctypes.cast(maxs, ctypes.POINTER(ctypes.c_double))
# set the dimension
p_dimension[0] = dimension
if obj is None:
p_data[0] = no_data
p_length[0] = 0
else:
p_length[0], data, _ = self._serialize(obj)
p_data[0] = ctypes.cast(data, ctypes.POINTER(ctypes.c_ubyte))
return 0
stream = core.NEXTFUNC(py_next_item)
return IndexStreamHandle(self.properties.handle, stream)
def leaves(self):
leaf_node_count = ctypes.c_uint32()
p_leafsizes = ctypes.pointer(ctypes.c_uint32())
p_leafids = ctypes.pointer(ctypes.c_int64())
pp_childids = ctypes.pointer(ctypes.pointer(ctypes.c_int64()))
pp_mins = ctypes.pointer(ctypes.pointer(ctypes.c_double()))
pp_maxs = ctypes.pointer(ctypes.pointer(ctypes.c_double()))
dimension = ctypes.c_uint32(0)
core.rt.Index_GetLeaves(self.handle,
ctypes.byref(leaf_node_count),
ctypes.byref(p_leafsizes),
ctypes.byref(p_leafids),
ctypes.byref(pp_childids),
ctypes.byref(pp_mins),
ctypes.byref(pp_maxs),
ctypes.byref(dimension)
)
output = []
count = leaf_node_count.value
sizes = ctypes.cast(
p_leafsizes, ctypes.POINTER(ctypes.c_uint32 * count))
ids = ctypes.cast(p_leafids, ctypes.POINTER(ctypes.c_int64 * count))
child = ctypes.cast(
pp_childids,
ctypes.POINTER(ctypes.POINTER(ctypes.c_int64) * count))
mins = ctypes.cast(
pp_mins,
ctypes.POINTER(ctypes.POINTER(ctypes.c_double) * count))
maxs = ctypes.cast(
pp_maxs,
ctypes.POINTER(ctypes.POINTER(ctypes.c_double) * count))
for i in range(count):
p_child_ids = child.contents[i]
id = ids.contents[i]
size = sizes.contents[i]
child_ids_array = ctypes.cast(
p_child_ids, ctypes.POINTER(ctypes.c_int64 * size))
child_ids = []
for j in range(size):
child_ids.append(child_ids_array.contents[j])
# free the child ids list
core.rt.Index_Free(
ctypes.cast(p_child_ids, ctypes.POINTER(ctypes.c_void_p)))
p_mins = mins.contents[i]
p_maxs = maxs.contents[i]
p_mins = ctypes.cast(
p_mins, ctypes.POINTER(ctypes.c_double * dimension.value))
p_maxs = ctypes.cast(
p_maxs, ctypes.POINTER(ctypes.c_double * dimension.value))
bounds = []
bounds = [p_mins.contents[i] for i in range(dimension.value)]
bounds += [p_maxs.contents[i] for i in range(dimension.value)]
# free the bounds
p_mins = ctypes.cast(p_mins, ctypes.POINTER(ctypes.c_double))
p_maxs = ctypes.cast(p_maxs, ctypes.POINTER(ctypes.c_double))
core.rt.Index_Free(
ctypes.cast(p_mins, ctypes.POINTER(ctypes.c_void_p)))
core.rt.Index_Free(
ctypes.cast(p_maxs, ctypes.POINTER(ctypes.c_void_p)))
output.append((id, child_ids, bounds))
return output
# An alias to preserve backward compatibility
Rtree = Index
class Item(object):
"""A container for index entries"""
__slots__ = ('handle', 'owned', 'id', 'object', 'bounds')
def __init__(self, loads, handle, owned=False):
"""There should be no reason to instantiate these yourself. Items are
created automatically when you call
:meth:`rtree.index.Index.intersection` (or other index querying
methods) with objects=True given the parameters of the function."""
if handle:
self.handle = handle
self.owned = owned
self.id = core.rt.IndexItem_GetID(self.handle)
self.object = None
self.object = self.get_object(loads)
self.bounds = _get_bounds(
self.handle, core.rt.IndexItem_GetBounds, False)
@property
def bbox(self):
"""Returns the bounding box of the index entry"""
return Index.interleave(self.bounds)
def get_object(self, loads):
# short circuit this so we only do it at construction time
if self.object is not None:
return self.object
data = _get_data(self.handle)
if data is None:
return None
return loads(data)
class InvalidHandleException(Exception):
"""Handle has been destroyed and can no longer be used"""
class Handle(object):
def __init__(self, *args, **kwargs):
self._ptr = self._create(*args, **kwargs)
def _create(self, *args, **kwargs):
raise NotImplementedError
def _destroy(self, ptr):
raise NotImplementedError
def destroy(self):
if self._ptr is not None:
self._destroy(self._ptr)
self._ptr = None
@property
def _as_parameter_(self):
if self._ptr is None:
raise InvalidHandleException
return self._ptr
def __del__(self):
try:
self.destroy()
except NameError:
# The core.py model doesn't have
# core.rt available anymore and it was tore
# down. We don't want to try to do anything
# in that instance
return
class IndexHandle(Handle):
_create = core.rt.Index_Create
_destroy = core.rt.Index_Destroy
class IndexStreamHandle(IndexHandle):
_create = core.rt.Index_CreateWithStream
class PropertyHandle(Handle):
_create = core.rt.IndexProperty_Create
_destroy = core.rt.IndexProperty_Destroy
class Property(object):
"""An index property object is a container that contains a number of
settable index properties. Many of these properties must be set at
index creation times, while others can be used to adjust performance
or behavior."""
pkeys = (
'buffering_capacity', 'custom_storage_callbacks',
'custom_storage_callbacks_size', 'dat_extension', 'dimension',
'filename', 'fill_factor', 'idx_extension', 'index_capacity',
'index_id', 'leaf_capacity', 'near_minimum_overlap_factor',
'overwrite', 'pagesize', 'point_pool_capacity',
'region_pool_capacity', 'reinsert_factor',
'split_distribution_factor', 'storage', 'tight_mbr', 'tpr_horizon',
'type', 'variant', 'writethrough')
def __init__(self, handle=None, owned=True, **kwargs):
if handle is None:
handle = PropertyHandle()
self.handle = handle
self.initialize_from_dict(kwargs)
def initialize_from_dict(self, state):
for k, v in state.items():
if v is not None:
setattr(self, k, v)
def __getstate__(self):
return self.as_dict()
def __setstate__(self, state):
self.handle = PropertyHandle()
self.initialize_from_dict(state)
def as_dict(self):
d = {}
for k in self.pkeys:
try:
v = getattr(self, k)
except core.RTreeError:
v = None
d[k] = v
return d
def __repr__(self):
return repr(self.as_dict())
def __str__(self):
return pprint.pformat(self.as_dict())
def get_index_type(self):
return core.rt.IndexProperty_GetIndexType(self.handle)
def set_index_type(self, value):
return core.rt.IndexProperty_SetIndexType(self.handle, value)
type = property(get_index_type, set_index_type)
"""Index type. Valid index type values are
:data:`RT_RTree`, :data:`RT_MVTree`, or :data:`RT_TPRTree`. Only
RT_RTree (the default) is practically supported at this time."""
def get_variant(self):
return core.rt.IndexProperty_GetIndexVariant(self.handle)
def set_variant(self, value):
return core.rt.IndexProperty_SetIndexVariant(self.handle, value)
variant = property(get_variant, set_variant)
"""Index variant. Valid index variant values are
:data:`RT_Linear`, :data:`RT_Quadratic`, and :data:`RT_Star`"""
def get_dimension(self):
return core.rt.IndexProperty_GetDimension(self.handle)
def set_dimension(self, value):
if (value <= 0):
raise core.RTreeError(
"Negative or 0 dimensional indexes are not allowed")
return core.rt.IndexProperty_SetDimension(self.handle, value)
dimension = property(get_dimension, set_dimension)
"""Index dimension. Must be greater than 0, though a dimension of 1 might
have undefined behavior."""
def get_storage(self):
return core.rt.IndexProperty_GetIndexStorage(self.handle)
def set_storage(self, value):
return core.rt.IndexProperty_SetIndexStorage(self.handle, value)
storage = property(get_storage, set_storage)
"""Index storage.
One of :data:`RT_Disk`, :data:`RT_Memory` or :data:`RT_Custom`.
If a filename is passed as the first parameter to :class:index.Index,
:data:`RT_Disk` is assumed. If a CustomStorage instance is passed,
:data:`RT_Custom` is assumed. Otherwise, :data:`RT_Memory` is the default.
"""
def get_pagesize(self):
return core.rt.IndexProperty_GetPagesize(self.handle)
def set_pagesize(self, value):
if (value <= 0):
raise core.RTreeError("Pagesize must be > 0")
return core.rt.IndexProperty_SetPagesize(self.handle, value)
pagesize = property(get_pagesize, set_pagesize)
"""The pagesize when disk storage is used. It is ideal to ensure that your
index entries fit within a single page for best performance."""
def get_index_capacity(self):
return core.rt.IndexProperty_GetIndexCapacity(self.handle)
def set_index_capacity(self, value):
if (value <= 0):
raise core.RTreeError("index_capacity must be > 0")
return core.rt.IndexProperty_SetIndexCapacity(self.handle, value)
index_capacity = property(get_index_capacity, set_index_capacity)
"""Index capacity"""
def get_leaf_capacity(self):
return core.rt.IndexProperty_GetLeafCapacity(self.handle)
def set_leaf_capacity(self, value):
if (value <= 0):
raise core.RTreeError("leaf_capacity must be > 0")
return core.rt.IndexProperty_SetLeafCapacity(self.handle, value)
leaf_capacity = property(get_leaf_capacity, set_leaf_capacity)
"""Leaf capacity"""
def get_index_pool_capacity(self):
return core.rt.IndexProperty_GetIndexPoolCapacity(self.handle)
def set_index_pool_capacity(self, value):
if (value <= 0):
raise core.RTreeError("index_pool_capacity must be > 0")
return core.rt.IndexProperty_SetIndexPoolCapacity(self.handle, value)
index_pool_capacity = property(
get_index_pool_capacity, set_index_pool_capacity)
"""Index pool capacity"""
def get_point_pool_capacity(self):
return core.rt.IndexProperty_GetPointPoolCapacity(self.handle)
def set_point_pool_capacity(self, value):
if (value <= 0):
raise core.RTreeError("point_pool_capacity must be > 0")
return core.rt.IndexProperty_SetPointPoolCapacity(self.handle, value)
point_pool_capacity = property(
get_point_pool_capacity, set_point_pool_capacity)
"""Point pool capacity"""
def get_region_pool_capacity(self):
return core.rt.IndexProperty_GetRegionPoolCapacity(self.handle)
def set_region_pool_capacity(self, value):
if (value <= 0):
raise core.RTreeError("region_pool_capacity must be > 0")
return core.rt.IndexProperty_SetRegionPoolCapacity(self.handle, value)
region_pool_capacity = property(
get_region_pool_capacity, set_region_pool_capacity)
"""Region pool capacity"""
def get_buffering_capacity(self):
return core.rt.IndexProperty_GetBufferingCapacity(self.handle)
def set_buffering_capacity(self, value):
if (value <= 0):
raise core.RTreeError("buffering_capacity must be > 0")
return core.rt.IndexProperty_SetBufferingCapacity(self.handle, value)
buffering_capacity = property(
get_buffering_capacity, set_buffering_capacity)
"""Buffering capacity"""
def get_tight_mbr(self):
return bool(core.rt.IndexProperty_GetEnsureTightMBRs(self.handle))
def set_tight_mbr(self, value):
value = bool(value)
return bool(
core.rt.IndexProperty_SetEnsureTightMBRs(self.handle, value))
tight_mbr = property(get_tight_mbr, set_tight_mbr)
"""Uses tight bounding rectangles"""
def get_overwrite(self):
return bool(core.rt.IndexProperty_GetOverwrite(self.handle))
def set_overwrite(self, value):
value = bool(value)
return bool(core.rt.IndexProperty_SetOverwrite(self.handle, value))
overwrite = property(get_overwrite, set_overwrite)
"""Overwrite existing index files"""
def get_near_minimum_overlap_factor(self):
return core.rt.IndexProperty_GetNearMinimumOverlapFactor(self.handle)
def set_near_minimum_overlap_factor(self, value):
if (value <= 0):
raise core.RTreeError("near_minimum_overlap_factor must be > 0")
return core.rt.IndexProperty_SetNearMinimumOverlapFactor(
self.handle, value)
near_minimum_overlap_factor = property(
get_near_minimum_overlap_factor, set_near_minimum_overlap_factor)
"""Overlap factor for MVRTrees"""
def get_writethrough(self):
return bool(core.rt.IndexProperty_GetWriteThrough(self.handle))
def set_writethrough(self, value):
value = bool(value)
return bool(core.rt.IndexProperty_SetWriteThrough(self.handle, value))
writethrough = property(get_writethrough, set_writethrough)
"""Write through caching"""
def get_fill_factor(self):
return core.rt.IndexProperty_GetFillFactor(self.handle)
def set_fill_factor(self, value):
return core.rt.IndexProperty_SetFillFactor(self.handle, value)
fill_factor = property(get_fill_factor, set_fill_factor)
"""Index node fill factor before branching"""
def get_split_distribution_factor(self):
return core.rt.IndexProperty_GetSplitDistributionFactor(self.handle)
def set_split_distribution_factor(self, value):
return core.rt.IndexProperty_SetSplitDistributionFactor(
self.handle, value)
split_distribution_factor = property(
get_split_distribution_factor, set_split_distribution_factor)
"""Split distribution factor"""
def get_tpr_horizon(self):
return core.rt.IndexProperty_GetTPRHorizon(self.handle)
def set_tpr_horizon(self, value):
return core.rt.IndexProperty_SetTPRHorizon(self.handle, value)
tpr_horizon = property(get_tpr_horizon, set_tpr_horizon)
"""TPR horizon"""
def get_reinsert_factor(self):
return core.rt.IndexProperty_GetReinsertFactor(self.handle)
def set_reinsert_factor(self, value):
return core.rt.IndexProperty_SetReinsertFactor(self.handle, value)
reinsert_factor = property(get_reinsert_factor, set_reinsert_factor)
"""Reinsert factor"""
def get_filename(self):
s = core.rt.IndexProperty_GetFileName(self.handle)
return string_output(s)
def set_filename(self, value):
if isinstance(value, string_types):
value = value.encode('utf-8')
return core.rt.IndexProperty_SetFileName(self.handle, value)
filename = property(get_filename, set_filename)
"""Index filename for disk storage"""
def get_dat_extension(self):
s = core.rt.IndexProperty_GetFileNameExtensionDat(self.handle)
return string_output(s)
def set_dat_extension(self, value):
if isinstance(value, string_types):
value = value.encode('utf-8')
return core.rt.IndexProperty_SetFileNameExtensionDat(
self.handle, value)
dat_extension = property(get_dat_extension, set_dat_extension)
"""Extension for .dat file"""
def get_idx_extension(self):
s = core.rt.IndexProperty_GetFileNameExtensionIdx(self.handle)
return string_output(s)
def set_idx_extension(self, value):
if isinstance(value, string_types):
value = value.encode('utf-8')
return core.rt.IndexProperty_SetFileNameExtensionIdx(
self.handle, value)
idx_extension = property(get_idx_extension, set_idx_extension)
"""Extension for .idx file"""
def get_custom_storage_callbacks_size(self):
return core.rt.IndexProperty_GetCustomStorageCallbacksSize(self.handle)
def set_custom_storage_callbacks_size(self, value):
return core.rt.IndexProperty_SetCustomStorageCallbacksSize(
self.handle, value)
custom_storage_callbacks_size = property(
get_custom_storage_callbacks_size, set_custom_storage_callbacks_size)
"""Size of callbacks for custom storage"""
def get_custom_storage_callbacks(self):
return core.rt.IndexProperty_GetCustomStorageCallbacks(self.handle)
def set_custom_storage_callbacks(self, value):
return core.rt.IndexProperty_SetCustomStorageCallbacks(
self.handle, value)
custom_storage_callbacks = property(
get_custom_storage_callbacks, set_custom_storage_callbacks)
"""Callbacks for custom storage"""
def get_index_id(self):
return core.rt.IndexProperty_GetIndexID(self.handle)
def set_index_id(self, value):
return core.rt.IndexProperty_SetIndexID(self.handle, value)
index_id = property(get_index_id, set_index_id)
"""First node index id"""
# custom storage implementation
id_type = ctypes.c_int64
class CustomStorageCallbacks(ctypes.Structure):
# callback types
createCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, ctypes.POINTER(ctypes.c_int))
destroyCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, ctypes.POINTER(ctypes.c_int))
flushCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, ctypes.POINTER(ctypes.c_int))
loadCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, id_type, ctypes.POINTER(ctypes.c_uint32),
ctypes.POINTER(ctypes.POINTER(ctypes.c_uint8)),
ctypes.POINTER(ctypes.c_int))
storeCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, ctypes.POINTER(id_type), ctypes.c_uint32,
ctypes.POINTER(ctypes.c_uint8), ctypes.POINTER(ctypes.c_int))
deleteCallbackType = ctypes.CFUNCTYPE(
None, ctypes.c_void_p, id_type, ctypes.POINTER(ctypes.c_int))
_fields_ = [('context', ctypes.c_void_p),
('createCallback', createCallbackType),
('destroyCallback', destroyCallbackType),
('flushCallback', flushCallbackType),
('loadCallback', loadCallbackType),
('storeCallback', storeCallbackType),
('deleteCallback', deleteCallbackType),
]
def __init__(self, context, createCallback, destroyCallback,
flushCallback, loadCallback, storeCallback, deleteCallback):
ctypes.Structure.__init__(self,
ctypes.c_void_p(context),
self.createCallbackType(createCallback),
self.destroyCallbackType(destroyCallback),
self.flushCallbackType(flushCallback),
self.loadCallbackType(loadCallback),
self.storeCallbackType(storeCallback),
self.deleteCallbackType(deleteCallback),
)
class ICustomStorage(object):
# error codes
NoError = 0
InvalidPageError = 1
IllegalStateError = 2
# special pages
EmptyPage = -0x1
NewPage = -0x1
def allocateBuffer(self, length):
return core.rt.SIDX_NewBuffer(length)
def registerCallbacks(self, properties):
raise NotImplementedError()
def clear(self):
raise NotImplementedError()
hasData = property(lambda self: False)
'''Override this property to allow for reloadable storages'''
class CustomStorageBase(ICustomStorage):
"""Derive from this class to create your own storage manager with access
to the raw C buffers."""
def registerCallbacks(self, properties):
callbacks = CustomStorageCallbacks(
ctypes.c_void_p(), self.create, self.destroy, self.flush,
self.loadByteArray, self.storeByteArray, self.deleteByteArray)
properties.custom_storage_callbacks_size = ctypes.sizeof(callbacks)
self.callbacks = callbacks
properties.custom_storage_callbacks = \
ctypes.cast(ctypes.pointer(callbacks), ctypes.c_void_p)
# the user must override these callback functions
def create(self, context, returnError):
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def destroy(self, context, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def loadByteArray(self, context, page, resultLen, resultData, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def storeByteArray(self, context, page, len, data, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def deleteByteArray(self, context, page, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def flush(self, context, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
class CustomStorage(ICustomStorage):
"""Provides a useful default custom storage implementation which marshals
the buffers on the C side from/to python strings.
Derive from this class and override the necessary methods to provide
your own custom storage manager."""
def registerCallbacks(self, properties):
callbacks = CustomStorageCallbacks(
0, self._create, self._destroy, self._flush, self._loadByteArray,
self._storeByteArray, self._deleteByteArray)
properties.custom_storage_callbacks_size = ctypes.sizeof(callbacks)
self.callbacks = callbacks
properties.custom_storage_callbacks = \
ctypes.cast(ctypes.pointer(callbacks), ctypes.c_void_p)
# these functions handle the C callbacks and massage the data, then
# delegate to the function without underscore below
def _create(self, context, returnError):
self.create(returnError)
def _destroy(self, context, returnError):
self.destroy(returnError)
def _flush(self, context, returnError):
self.flush(returnError)
def _loadByteArray(self, context, page, resultLen,
resultData, returnError):
resultString = self.loadByteArray(page, returnError)
if returnError.contents.value != self.NoError:
return
# Copy python string over into a buffer allocated on the C side.
# The buffer will later be freed by the C side. This prevents
# possible heap corruption issues as buffers allocated by ctypes
# and the c library might be allocated on different heaps.
# Freeing a buffer allocated on another heap might make the application
# crash.
count = len(resultString)
resultLen.contents.value = count
buffer = self.allocateBuffer(count)
ctypes.memmove(buffer, ctypes.c_char_p(resultString), count)
resultData[0] = ctypes.cast(buffer, ctypes.POINTER(ctypes.c_uint8))
def _storeByteArray(self, context, page, len, data, returnError):
str = ctypes.string_at(data, len)
newPageId = self.storeByteArray(page.contents.value, str, returnError)
page.contents.value = newPageId
def _deleteByteArray(self, context, page, returnError):
self.deleteByteArray(page, returnError)
# the user must override these callback functions
def create(self, returnError):
"""Must be overridden. No return value."""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def destroy(self, returnError):
"""Must be overridden. No return value."""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def flush(self, returnError):
"""Must be overridden. No return value."""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
def loadByteArray(self, page, returnError):
"""Must be overridden. Must return a string with the loaded data."""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
return ''
def storeByteArray(self, page, data, returnError):
"""Must be overridden. Must return the new 64-bit page ID of the stored
data if a new page had to be created (i.e. page is not NewPage)."""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
return 0
def deleteByteArray(self, page, returnError):
"""please override"""
returnError.contents.value = self.IllegalStateError
raise NotImplementedError("You must override this method.")
class RtreeContainer(Rtree):
"""An R-Tree, MVR-Tree, or TPR-Tree indexed container for python objects"""
def __init__(self, *args, **kwargs):
"""Creates a new index
:param stream:
If the first argument in the constructor is not of type basestring,
it is assumed to be an iterable stream of data that will raise a
StopIteration. It must be in the form defined by the
:attr:`interleaved` attribute of the index. The following example
would assume :attr:`interleaved` is False::
(obj, (minx, maxx, miny, maxy, minz, maxz, ..., ..., mink, maxk))
:param interleaved: True or False, defaults to True.
This parameter determines the coordinate order for all methods that
take in coordinates.
:param properties: An :class:`index.Property` object
This object sets both the creation and instantiation properties
for the object and they are passed down into libspatialindex.
A few properties are curried from instantiation parameters
for you like ``pagesize`` to ensure compatibility with previous
versions of the library. All other properties must be set on the
object.
.. warning::
The coordinate ordering for all functions are sensitive the
index's :attr:`interleaved` data member. If :attr:`interleaved`
is False, the coordinates must be in the form
[xmin, xmax, ymin, ymax, ..., ..., kmin, kmax]. If
:attr:`interleaved` is True, the coordinates must be in the form
[xmin, ymin, ..., kmin, xmax, ymax, ..., kmax].
A basic example
::
>>> from rtree import index
>>> p = index.Property()
>>> idx = index.RtreeContainer(properties=p)
>>> idx # doctest: +ELLIPSIS
<rtree.index.Rtree object at 0x...>
Insert an item into the index::
>>> idx.insert(object(), (34.3776829412, 26.7375853734,
49.3776829412, 41.7375853734))
Query::
>>> hits = idx.intersection((0, 0, 60, 60))
>>> for obj in hits:
... i.object
... i.bbox # doctest: +ELLIPSIS
<object object at 0x...>
[34.3776829412, 26.737585373400002, 49.3776829412,
41.737585373400002]
"""
if args:
if isinstance(args[0], rtree.index.string_types) \
or isinstance(args[0], bytes) \
or isinstance(args[0], rtree.index.ICustomStorage):
raise ValueError('%s supports only in-memory indexes'
% self.__class__)
self._objects = {}
return super(RtreeContainer, self).__init__(*args, **kwargs)
def insert(self, obj, coordinates):
"""Inserts an item into the index with the given coordinates.
:param obj: object
Any object.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
The following example inserts a simple object into the container.
The coordinate ordering in this instance is the default
(interleaved=True) ordering::
>>> from rtree import index
>>> idx = index.RTreeContainer()
>>> idx.insert(object(), (34.3776829412, 26.7375853734,
49.3776829412, 41.7375853734))
"""
try:
count = self._objects[id(obj)] + 1
except KeyError:
count = 1
self._objects[id(obj)] = (count, obj)
return super(RtreeContainer, self).insert(id(obj), coordinates, None)
add = insert
def intersection(self, coordinates, bbox=False):
"""Return ids or objects in the index that intersect the given
coordinates.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
:param bbox: True or False
If True, the intersection method will return the stored objects,
as well as the bounds of the entry.
The following example queries the container for any stored objects that
intersect the bounds given in the coordinates::
>>> from rtree import index
>>> idx = index.RtreeContainer()
>>> idx.insert(object(), (34.3776829412, 26.7375853734,
49.3776829412, 41.7375853734))
>>> hits = list(idx.intersection((0, 0, 60, 60), bbox=True))
>>> [(item.object, item.bbox)
... for item in hits] # doctest: +ELLIPSIS
[(<object object at 0x...>, [34.3776829412, 26.7375853734,
49.3776829412, 41.7375853734])]
If the :class:`rtree.index.Item` wrapper is not used, it is faster to
request only the stored objects::
>>> list(idx.intersection((0, 0, 60, 60))) # doctest: +ELLIPSIS
[<object object at 0x...>]
"""
if bbox == False:
for id in super(RtreeContainer,
self).intersection(coordinates, bbox):
yield self._objects[id][1]
elif bbox == True:
for value in super(RtreeContainer,
self).intersection(coordinates, bbox):
value.object = self._objects[value.id][1]
value.id = None
yield value
else:
raise ValueError(
"valid values for the bbox argument are True and False")
def nearest(self, coordinates, num_results = 1, bbox=False):
"""Returns the ``k``-nearest objects to the given coordinates.
:param coordinates: sequence or array
This may be an object that satisfies the numpy array
protocol, providing the index's dimension * 2 coordinate
pairs representing the `mink` and `maxk` coordinates in
each dimension defining the bounds of the query window.
:param num_results: integer
The number of results to return nearest to the given coordinates.
If two entries are equidistant, *both* are returned.
This property means that :attr:`num_results` may return more
items than specified.
:param bbox: True or False
If True, the nearest method will return the stored objects, as
well as the bounds of the entry.
Example of finding the three items nearest to this one::
>>> from rtree import index
>>> idx = index.RtreeContainer()
>>> idx.insert(object(), (34.37, 26.73, 49.37, 41.73))
>>> hits = idx.nearest((0, 0, 10, 10), 3, bbox=True)
"""
if bbox == False:
for id in super(RtreeContainer,
self).nearest(coordinates, num_results, bbox):
yield self._objects[id][1]
elif bbox == True:
for value in super(RtreeContainer,
self).nearest(coordinates, num_results, bbox):
value.object = self._objects[value.id][1]
value.id = None
yield value
else:
raise ValueError(
"valid values for the bbox argument are True and False")
def delete(self, obj, coordinates):
"""Deletes the item from the container within the specified
coordinates.
:param obj: object
Any object.
:param coordinates: sequence or array
Dimension * 2 coordinate pairs, representing the min
and max coordinates in each dimension of the item to be
deleted from the index. Their ordering will depend on the
index's :attr:`interleaved` data member.
These are not the coordinates of a space containing the
item, but those of the item itself. Together with the
id parameter, they determine which item will be deleted.
This may be an object that satisfies the numpy array protocol.
Example::
>>> from rtree import index
>>> idx = index.RtreeContainer()
>>> idx.delete(object(), (34.3776829412, 26.7375853734,
49.3776829412, 41.7375853734))
"""
try:
count = self._objects[id(obj)] - 1
except KeyError:
raise IndexError('object is not in the index')
if count == 0:
del self._objects[obj]
else:
self._objects[id(obj)] = (count, obj)
return super(RtreeContainer, self).delete(id, coordinates)
def leaves(self):
return [(self._objects[id][1], [self._objects[child_id][1]
for child_id in child_ids], bounds)
for id, child_ids, bounds
in super(RtreeContainer, self).leaves()]
|