@dainst/idai-shape-descriptors

Shape descriptors for iDai.shapes

Usage no npm install needed!

<script type="module">
  import dainstIdaiShapeDescriptors from 'https://cdn.skypack.dev/@dainst/idai-shape-descriptors';
</script>

README

idai-shape-descriptors

JS implementation of image processing and shape descriptor functionalities used in iDAI.shapes. Currently the following descriptors are available:

  1. Normalized Fourier Descriptors

Code documentation

You can find the code documentation here

Getting started

Clone this repository and run

npm install
npm run build

Please use TensorFlow.JS for the implementation of mathamical code.

Testing

Please write sufficiently many tests for your code. Tests are located in test directory. Run tests with

npm test

Github Actions

The code is tested on each push using Github Actions. The config can be found in .github/workflows

Create Docs

Docs are generated with typedoc. You can update the docs with the following command.

npm run doc