org.apache.sedona.core.spatialPartitioning

Class IndexedGridPartitioner

java.lang.Object

org.apache.spark.Partitioner

org.apache.sedona.core.spatialPartitioning.SpatialPartitioner

org.apache.sedona.core.spatialPartitioning.FlatGridPartitioner

org.apache.sedona.core.spatialPartitioning.IndexedGridPartitioner

All Implemented Interfaces:

Serializable

public class IndexedGridPartitioner
extends FlatGridPartitioner

The IndexedGridPartitioner is used when there is already a set of grids which the data should be partitioned into. It leverages an STRTree to quickly find the grids to place a geometry into. If you have very few objects to place, it may make more sense to use the FlatGridPartitioner. If you do not have a strict requirement to use a specific set of grids, it may make more sense to use another partitioner that generates its own grids from space-partitioning tree, e.g. the KDBTreePartitioner or the QuadTreePartitioner.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.sedona.core.spatialPartitioning.FlatGridPartitioner

preserveUncontainedGeometries

Fields inherited from class org.apache.sedona.core.spatialPartitioning.SpatialPartitioner

grids, gridType

Constructor Summary

Constructors

Constructor and Description
IndexedGridPartitioner(GridType gridType, List<org.locationtech.jts.geom.Envelope> grids)
IndexedGridPartitioner(GridType gridType, List<org.locationtech.jts.geom.Envelope> grids, Boolean preserveUncontainedGeometries)
IndexedGridPartitioner(List<org.locationtech.jts.geom.Envelope> grids)
IndexedGridPartitioner(List<org.locationtech.jts.geom.Envelope> grids, Boolean preserveUncontainedGeometries)

Method Summary

Modifier and Type	Method and Description
STRtree	getIndex()
Iterator<scala.Tuple2<Integer,org.locationtech.jts.geom.Geometry>>	placeObject(org.locationtech.jts.geom.Geometry spatialObject) Given a geometry, returns a list of partitions it overlaps.

Methods inherited from class org.apache.sedona.core.spatialPartitioning.FlatGridPartitioner

equals, getDedupParams, numPartitions

Methods inherited from class org.apache.sedona.core.spatialPartitioning.SpatialPartitioner

getGrids, getGridType, getPartition

Methods inherited from class org.apache.spark.Partitioner

defaultPartitioner

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexedGridPartitioner

public IndexedGridPartitioner(GridType gridType,
                              List<org.locationtech.jts.geom.Envelope> grids,
                              Boolean preserveUncontainedGeometries)

IndexedGridPartitioner

public IndexedGridPartitioner(GridType gridType,
                              List<org.locationtech.jts.geom.Envelope> grids)

IndexedGridPartitioner

public IndexedGridPartitioner(List<org.locationtech.jts.geom.Envelope> grids,
                              Boolean preserveUncontainedGeometries)

IndexedGridPartitioner

public IndexedGridPartitioner(List<org.locationtech.jts.geom.Envelope> grids)

Method Detail

getIndex

public STRtree getIndex()

placeObject

public Iterator<scala.Tuple2<Integer,org.locationtech.jts.geom.Geometry>> placeObject(org.locationtech.jts.geom.Geometry spatialObject)
                                                                               throws Exception

Description copied from class: SpatialPartitioner

Given a geometry, returns a list of partitions it overlaps.

For points, returns exactly one partition as long as grid type is non-overlapping. For other geometry types or for overlapping grid types, may return multiple partitions.

Overrides:

placeObject in class FlatGridPartitioner

Throws:

Exception