# dobbyscan

**Repository Path**: mirrors_mapbox/dobbyscan

## Basic Information

- **Project Name**: dobbyscan
- **Description**: A very fast density based clustering library for geographic points
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## dobbyscan [![Node](https://github.com/mapbox/dobbyscan/actions/workflows/node.yml/badge.svg)](https://github.com/mapbox/dobbyscan/actions/workflows/node.yml) [![Simply Awesome](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)

A very fast density based clustering JavaScript library for geographic points. Implements a variation of [DBSCAN](https://en.wikipedia.org/wiki/DBSCAN) with great circle distance metric.

### Example

```js
const clusters = dobbyscan(points, radius, p => p.lon, p => p.lat);
```

### API

#### dobbyscan(points, radius[, getLng, getLat])

Returns an array of clusters, where each cluster is an array of points (from the input array).

- `points`: an array of input points of an arbitrary format.
- `radius`: density clustering radius in kilometers.
- `getLng`: (optional) a function that returns longitude given an input point, `(p) => p[0]` by default.
- `getLat`: (optional) a function that returns latitude given an input point, `(p) => p[1]` by default.

### Performance

This library is incredibly fast — run `bench.js` to see it cluster 135k points in one second.

### Install

```
npm install dobbyscan
```