List of functions and classes (API)#

These are the functions and classes that make up the Bordado API.

Coordinate generation#

line_coordinates(start, stop, *[, size, ...])

Generate evenly spaced points between two values.

random_coordinates(region, size, *[, ...])

Generate the coordinates for a uniformly random scatter of points.

grid_coordinates(region, *[, shape, ...])

Generate evenly spaced points on an n-dimensional grid.

profile_coordinates(beginning, end, *[, ...])

Generate evenly spaced coordinates along a straight line between points.

great_circle_coordinates(beginning, end, *)

Generate evenly spaced coordinates along a great circle between points.

Regions and bounding boxes#

inside(coordinates, region)

Determine which points fall inside a given region.

get_region(coordinates)

Get the bounding region of the given coordinates.

pad_region(region, pad)

Extend the borders of a region by the given amount.

Splitting points into blocks and windows#

block_split(coordinates, *[, region, ...])

Split a region into blocks and label points according to where they fall.

expanding_window(coordinates, center, sizes)

Select points on windows of expanding size around a center point.

rolling_window(coordinates, window_size, ...)

Split points into overlapping windows.

Other utilities#

neighbor_distance_statistics(coordinates, ...)

Calculate statistics of the distances to the k-nearest neighbors of points.

spacing_to_size(start, stop, spacing, *[, ...])

Convert a spacing to the number of points between start and stop.

shape_to_spacing(region, shape, *[, ...])

Calculate the spacing of a regular grid given a region and shape.