decorrelation 0.3.0

An InSAR postprocessing tool

decorrelation

Documentation

InSAR postprocessing tool

Install

Install cupy and dask_cuda first, then:

With conda:

conda install -c conda-forge decorrelation

With pip:

pip install decorrelation

In development mode:

git clone [e-mail]:kanglcn/decorrelation.git ./decorrelation
cd ./decorrelation
pip install -e '.[dev]'

How to use

import decorrelation as dc

This package provide functions for InSAR post-processing which refers as processing after SAR images co-registration and geocoding. The functions include PS/DS identification, coherence matrix estimation, phase linking etc.

Most of the python functions in this package provide 2 kind of API, the array-based API and the file-based API. The inputs of array-based functions generally are numpy or cupy arrays. The inputs of file-based functions are string of path to the array stored in disk. The file-based functions make use of dask package to decrease the memory usage and parallelize the job. However, their is performance cost for using dask, if no parallelization is needed and the memory fits the data, the array-based API is recommended.

CLI is also provided and is almost the same as the file-based API. The only difference between them is the CLI can not directly show the plot.

Please refer to the Documentation for detailed usage.

Warning!!! This package is under intensive development. API is subjected to change without any noticement.

Contact us

• Most discussion happens on GitHub. Feel free to open an issue or comment on any open issue or pull request.
• use github discussions to ask questions or leave comments.

Contribution

• Pull requests are welcomed! Before making a pull request, please open an issue to talk about it.
• We have notice many excellent open-source packages are rarely paid attention to due to lack of documentation. The package is developed with the nbdev, a notebook-driven development platform. Developers only need to simply write notebooks with lightweight markup and get high-quality documentation, tests, continuous integration, and packaging automatically.