astrodendro.dendrogram.periodic_neighbours

astrodendro.dendrogram.periodic_neighbours(axes)

Utility for computing neighbours on datasets with periodic boundaries.

This can be passed to the neighbours keyword of Dendrogram.compute()

Parameters:

axes : integer, or list of integers

Which axes of the data are periodic

Examples

Build a dendrogram where the 0th axis wraps from top-to-bottom:

Dendrogram.compute(data, neighbours=periodic_neighbours(0))