geodes

Implementation of geodesic distance transform algorithm.

Usage no npm install needed!

<script type="module">
  import geodes from 'https://cdn.skypack.dev/geodes';
</script>

README

Geodes

Geodes is an implementation of the Geodesic Distance Transform in javascript.

Examples

var gdt = require('gdt');

gdt()
  .size(1920, 1080)
  .origin([
    [12, 10],
    [20, 40]
  ])
  .weights(image)
  .run()

Installation

npm install geodes

Browser support via duo/babel will follow!

Documentation

For more detailed use check out the test cases.

Do not change the order of the function calls (see example) as there is no error management currently.

Requires support of ES6.

.size(width, height)

Required. Defines resolution of image/size of matrix.

.origin(coordinates)

Required. Defines coordinates where distance is zero.

.weight(weightarray)

Defaults to 1 can be an gray scale image of type Uint32Array.

.run()

Returns the calculated distance matrix of type Uint32Array.

License

Copyright 2014 Bodo Kaiser i@bodokaiser.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.