Fri, 23 Oct 2020 18:00:53 -0500
Indirect dependency workarounds
35 | 1 | |
37 | 2 | # ImageTools |
35 | 3 | |
4 | Author: Tuomo Valkonen <tuomov@iki.fi> | |
5 | ||
6 | This repository contains some tools for doing mathematical imaging in Julia: | |
7 | ||
38 | 8 | * Effective visualisation based directly on `GR` instead of `Plots`. A sample visualisation main loop that calls |
9 | [AlgTools][]-style step routines. | |
35 | 10 | * Sub-pixelresolution image translation and sub-image extraction |
11 | * Calculation of discrete image gradients (2D, 3D 3D vector fields) | |
12 | * A very simple image filtering code that seems more efficient than the `ImageFiltering` | |
13 | package. | |
14 | ||
15 | The code is used, for example, by <http://dx.doi.org/10.5281/zenodo.3659180>. | |
36 | 16 | |
17 | ## Installation | |
18 | ||
38 | 19 | To install this package, first clone the repository and [AlgTools][] with [Mercurial](https://www.mercurial-scm.org/): |
36 | 20 | |
21 | ```console | |
22 | $ hg clone https://tuomov.iki.fi/repos/AlgTools/ | |
23 | $ hg clone https://tuomov.iki.fi/repos/ImageTools/ | |
24 | ``` | |
25 | ||
26 | (Canonical public repository URLs indicated here.) | |
27 | AlgTools has to be installed under the some location as ImageTools. | |
28 | Then add the repository to Julia with `Pkg.develop`: | |
29 | ||
30 | ```console | |
31 | julia>] develop LOCATION_OF/ImageTools/ | |
32 | ``` | |
33 | ||
41 | 34 | Here replace `LOCATION_OF/ImageTools` with path where you cloned ImageTools. (If you did not change directory after cloning, simply use `ImageTools`.) |
36 | 35 | Afterwards, you may use the package with: |
36 | ||
37 | ```console | |
38 | julia> using ImageTools | |
39 | ``` | |
40 | ||
38 | 41 | This package is not and is not planned to be available via `Pkg.add` as it is based on the worst and must unusable version control system ever invented: Git. |
42 | ||
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
43 | ## Testing |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
44 | |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
45 | To run a simple denoising test using FISTA, use |
38 | 46 | |
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
47 | ```console |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
48 | $ julia --project=DenoiseTest |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
49 | julia> using DenoiseTest |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
50 | julia> test_denoise() |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
51 | ``` |
38 | 52 | |
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
53 | [AlgTools]: https://tuomov.iki.fi/software/AlgTools/ |