rle-sample
Methods for sampling narrowband level sets
npm install rle-sample
Want to see pretty graphs? Log in now!
11 | downloads in the last month |
Last Published By | |
---|---|
Version | 0.0.2 last updated a year ago |
License | BSD |
Keywords | rle, sample, dense, narrowband, marching, sampling, adaptive, solid, 3d, geometry, multiphase |
Repository | git://github.com/mikolalysenko/rle-marching.git (git) |
Dependencies | rle-core |
Dependents | mikolalysenko-hoarders |
rle-sample
Methods for sampling narrowband level sets. This is part of the rle
collection of libraries for narrowband level sets.
Usage
First, install the library using npm:
npm install rle-sample
Then, you can import the code as follows:
var sample = require("rle-sample");
The library gives you access to the following samplers:
Multiphase Samplers
sample.dense(lo, hi, phase_func, dist_func)
Samples a narrowband level set densely.
lo
- lower bound on region to sample, represented as length 3 array of integershi
- upper bound on region to sample, represented as length 3 array of integersphase_func
- Phase function for level setdist_func
- Distance to phase boundary
Returns a narrowband level set
sample.marching(lo, hi, seeds, phase_func, dist_func)
Samples a narrowband level set using a fast marching method. To do this, you need to specify some seed points, then the algorithm will march along the surface starting from these points filling in the missing values. This can be much faster than dense sampling, but it requires you to specify some starting points on each connected component of the surface.
lo
- lower bound on region to sample, represented as length 3 array of integershi
- upper bound on region to sample, represented as length 3 array of integersseeds
- a list of points on the boundary of the solidphase_func
- Phase function for level setdist_func
- Distance to phase boundary
Returns a narrowband level set
sample.adaptive(lo, hi, step, phase_func, dist_func)
Samples a narrowband level set using an adaptive step size. This basically scans the grid stepping at intervals of size step
, then when it finds a crossing it samples the surface densely using a marching method.
lo
- lower bound on region to sample, represented as length 3 array of integershi
- upper bound on region to sample, represented as length 3 array of integersstep
- the size to step along the volume byphase_func
- Phase function for level setdist_func
- Distance to phase boundary
Returns a narrowband level set
Signed Distance Samplers
These methods sample solid objects represented by signed distance fields. They work basically the same as the multiphase samplers, except instead of taking a pair of functions for the phase and distance, they use only a single function input which represents the signed distance to the boundary of a solid object.
sample.solid.dense(lo, hi, sdist_func)
Same as above for solids
sample.solid.marching(lo, hi, seeds, sdist_func)
Same as above for marching
sample.solid.adaptive(lo, hi, step, sdist_func)
Same as above for adaptive
Credits
(c) 2013 Mikola Lysenko. BSD