package
0.0.0-20210907135800-e61c81d72473
Repository: https://github.com/ut-astria/spi.git
Documentation: pkg.go.dev

# README

A geospatial index

This code provides an index for object proximity. The index structure is based on S2 Geometry, and this code uses the github.com/golang/geo implementation.

The primary method is Update, which takes a publisher's opinion about the set of possible positions, each with an associated probability, for an object key in the publisher's namespace. Input also includes the identifier for data the publisher used to generate this input. Update returns the set of obsolete conjunction reports (if any) and a set of new conjunction reports (if any). This method also returns the id (if any) the publisher previously used for the object key.

This implementation is not safe for concurrent use.

# Functions

AtLess specifies the canonical order on At instances.
Diff returns (1) the set of Conjs in oldCs that are not in newCs and (2) the set of newCs that are not in oldCs.
No description provided by the author
No description provided by the author
No description provided by the author
NewIndex creates a new index based on cells with the given level and uses the given distance as the maximum distance for "conjunction" determination.
NewIndexWithFinder allows the caller to provide a CellFinder that can be used for multiple indexes.
NewLevel generates a Level with a Coverer with min and max levels both at given level.
No description provided by the author

# Structs

At represents an opinion about an object's position.
Cell represents a set of IdProbPos in an S2 cell.
CellFinder maps a position to a cell.
Conj represents an opinion about the proximity of two objects (at some unspecified time).
No description provided by the author
IdProbPoss is a set of IdProbPos for a given object.
Index receives object positions and returns "conjunctions".
IndexData represents some statistics about an Index.
Key is the key for storing positions in the index.
No description provided by the author
Pos is the object's state.
ProbPos represents one candidate Pos.

# Type aliases

CatalogNum is shared identity of the focal object.
No description provided by the author
Id represents the distinct report in its totality (as far as this package goes).
Prob represents uncertainty (without any index-imposed meaning).
Publisher is the id for the publisher of a position.