Skip to main content

An extension module implimenting the fast marching method

Project description

scikit-fmm is an extension module which implements the fast marching method.

The fast marching method is used to model the evolution of boundaries and interfaces in a variety of application areas.

scikit-fmm is a simple module which provides two functions: distance(phi, dx=1.0) and travel_time(phi, speed, dx=1.0).

The functions calculate the signed distance and travel time to an interface described by the zero contour of the input array phi.

>>> import skfmm
>>> phi = [-1,-1,-1,1,1,1]
>>> skfmm.distance(phi)
array([-2.5, -1.5, -0.5,  0.5,  1.5,  2.5])
>>> skfmm.travel_time(phi, [2,2,2,2,2,2])
array([ 1.25,  0.75,  0.25,  0.25,  0.75,  1.25])

The input array can be of 1, 2, 3 or higher dimensions and can be a masked array.



Source Code:

Requirements: Numpy and a C/C++ compiler (gcc/MinGW)


$ python install

Testing (requires nose):

$ python tests/

Building documentation (require sphinx):

$ make html

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scikit-fmm-0.0.1.tar.gz (9.7 kB view hashes)

Uploaded Source

Built Distribution

scikit-fmm-0.0.1.win32-py2.7.exe (225.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page