contours.ts

Contours.ts

Extract shapes & contours in an image, for browsers and node.js.

Features

How to use

Use

import { ContourFinder } from 'contours.ts'

/*
if `imageData` is like `{
  data: number[] | Uint8ClampedArray
  width: number
  height: number
}`
*/

const contours = new ContourFinder(imageData).threshold().extract()

console.log(contours)

/*
- `contours` is collection of contours found in image
- each contour is collection of points.

e.g.
[
  [{x: 0, y: 0}, {x: 1, y: 0}], //contour
  [{x: 0, y: 1}, {x: 0, y: 0}, {x: 1, y: 0}, {x: 1, y: 1}] // another contour
]

*/

Install

Recommended way to install is by using package manager (npm, yarn etc):

npm i contours.ts

or use cdn:

<script src="//unpkg.com/contours.ts"></script>

or download manually:

contours.ts

Contributions

Contirbutions are welcome, entire code base is filled with comments and tests are defined using jest