# rle-stencils

> Stencils for use with rle library

Latest version **0.0.4** (published 2014-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install rle-stencils
pnpm add rle-stencils
yarn add rle-stencils
bun add rle-stencils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2014-05-27 |
| First published | 2013-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Mikola Lysenko |
| Maintainers | mikolalysenko |
| Keywords | stencil, narrowband, levelset |

## Links

- npm: https://www.npmjs.com/package/rle-stencils
- Repository: https://github.com/mikolalysenko/rle-stencils
- Issues: https://github.com/mikolalysenko/rle-stencils/issues
- npm.io page: https://npm.io/package/rle-stencils

## Recent versions

- 0.0.4 (latest) — 2014-05-27
- 0.0.2 — 2013-02-03
- 0.0.1 — 2013-01-14
- 0.0.0 — 2013-01-14

## README

rle-stencils
============
Code to generate stencils for the [rle level set processing libraries](https://github.com/mikolalysenko/rle-all).

Basic Usage
===========

To install the library, just do:

    npm install rle-stencils
    
Then in your code you can import the stencil generators using:

    var stencils = require('rle-stencils');

Example: Moore
--------------

Here is how to create a stencil for a [Moore neighborhood](http://en.wikipedia.org/wiki/Moore_neighborhood) with radius 2:

    var moore_neighborhood = stencils.moore(2);
    
Example: von Neumann
--------------------

And here is the same idea applied to a [von Neumann neighborhood](http://en.wikipedia.org/wiki/Von_Neumann_neighborhood)

    var von_eumann_neighborhood = stencils.vonNeumann(1);

Example: Sphere
---------------

    var ball_neighborhood = stencils.ball(5);

Example: L^p
------------

More generally, you can create a stencil for any [Lp ball](http://en.wikipedia.org/wiki/Lp_space), with p being some fixed power.  For example, here is how to make an L^3 ball with radius 6:

    var cubic_neighborhood = stencils.lp(3, 6);
    
In general, calls to `lp(p, r)` return the collection of all integer lattice points `x` satisfying the inequality:

    Math.pow(Math.abs(x[0]), p) + Math.pow(Math.abs(x[1]), p) + Math.pow(Math.abs(x[2]), p) <= Math.pow(r, p)

Acknowledgements
================
(c) 2013 Mikola Lysenko.  MIT License

---
_Source: https://npm.io/package/rle-stencils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._