snaphu-rs 0.1.0

Rust implementation of the SNAPHU C library
Documentation
  • Coverage
  • 0%
    0 out of 2 items documented0 out of 1 items with examples
  • Size
  • Source code size: 1.35 MB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 4.38 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 24s Average build duration of successful builds.
  • all releases: 24s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • vini-fda

snaphu-rs

This is a Rust-based implementation of the SNAPHU library, a C implementation of a statistical-cost, network-flow algorithm for two-dimensional phase unwrapping.

This library is still heavily work-in-progress. The plan is to have a library that closely matches the original C implementation, but using safe and idiomatic Rust idioms, with proper documentation, and an easy-to-use API.

The emphasis is first on correctness, then performance. So tests comparing both implementations should be implemented soon.

License

This project includes code derived from SNAPHU and the cs2 minimum-cost flow solver.

The cs2 component is licensed for non-commercial / evaluation use only. As a result, this crate may not be used for commercial purposes.

See the original SNAPHU and cs2 documentation for full terms.

References

This library is based on the phase unwrapping algorithms developed by Curtis W. Chen and Howard A. Zebker, as described in the following publications:

  1. C. W. Chen and H. A. Zebker,Network approaches to two-dimensional phase unwrapping: intractability and two new algorithms,Journal of the Optical Society of America A, Vol. 17, pp. 401–414 (2000).
  2. C. W. Chen and H. A. Zebker,Two-dimensional phase unwrapping with use of statistical models for cost functions in nonlinear optimization,Journal of the Optical Society of America A, Vol. 18, pp. 338–351 (2001).
  3. C. W. Chen and H. A. Zebker,Phase unwrapping for large SAR interferograms: Statistical segmentation and generalized network models,IEEE Transactions on Geoscience and Remote Sensing, Vol. 40, pp. 1709–1719 (2002).