Sat, 04 Dec 2021 09:12:46 +0200
Update metadata to Julia 1.7 format
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. | |
52 | 10 | * Sub-pixel resolution image translation and sub-image extraction |
35 | 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. | |
54
471f9f64ff2d
Add ColourTools for colourmapped images
Tuomo Valkonen <tuomov@iki.fi>
parents:
52
diff
changeset
|
14 | * Tools to _apply_ colour maps to raw image data, that surprisingly seem to be missing from the standard libraries. |
35 | 15 | |
16 | The code is used, for example, by <http://dx.doi.org/10.5281/zenodo.3659180>. | |
36 | 17 | |
18 | ## Installation | |
19 | ||
38 | 20 | To install this package, first clone the repository and [AlgTools][] with [Mercurial](https://www.mercurial-scm.org/): |
36 | 21 | |
22 | ```console | |
23 | $ hg clone https://tuomov.iki.fi/repos/AlgTools/ | |
24 | $ hg clone https://tuomov.iki.fi/repos/ImageTools/ | |
25 | ``` | |
26 | ||
27 | (Canonical public repository URLs indicated here.) | |
28 | AlgTools has to be installed under the some location as ImageTools. | |
29 | Then add the repository to Julia with `Pkg.develop`: | |
30 | ||
31 | ```console | |
32 | julia>] develop LOCATION_OF/ImageTools/ | |
33 | ``` | |
34 | ||
41 | 35 | Here replace `LOCATION_OF/ImageTools` with path where you cloned ImageTools. (If you did not change directory after cloning, simply use `ImageTools`.) |
36 | 36 | Afterwards, you may use the package with: |
37 | ||
38 | ```console | |
39 | julia> using ImageTools | |
40 | ``` | |
41 | ||
38 | 42 | 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. |
43 | ||
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
44 | ## Testing |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
45 | |
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
46 | To run a simple denoising test using FISTA, use |
38 | 47 | |
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
48 | ```console |
50 | 49 | $ julia --project=Tests |
50 | julia> using Tests | |
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
51 | 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
|
52 | ``` |
38 | 53 | |
51
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
54 | To run a deblurring test using PDPS, continue with |
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
55 | |
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
56 | ```console |
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
57 | julia> test_deblur() |
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
58 | ``` |
370931a692a1
Add deblurring test using PDPS
Tuomo Valkonen <tuomov@iki.fi>
parents:
50
diff
changeset
|
59 | |
43
492a57594b88
Make denoise test script a proper project so it can be run easily.
Tuomo Valkonen <tuomov@iki.fi>
parents:
41
diff
changeset
|
60 | [AlgTools]: https://tuomov.iki.fi/software/AlgTools/ |