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.

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.

check_region(region)

Check that the given region is valid.

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.

Coordinate manipulation#

check_coordinates(coordinates)

Check that coordinate arrays all have the same shape.