README.md

Sat, 04 Dec 2021 09:12:46 +0200

author
Tuomo Valkonen <tuomov@iki.fi>
date
Sat, 04 Dec 2021 09:12:46 +0200
changeset 56
3f506eca7167
parent 54
471f9f64ff2d
permissions
-rw-r--r--

Update metadata to Julia 1.7 format

35
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
1
37
1b9066dbea57 Change README title
Tuomo Valkonen <tuomov@iki.fi>
parents: 36
diff changeset
2 # ImageTools
35
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
3
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
4 Author: Tuomo Valkonen <tuomov@iki.fi>
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
5
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
6 This repository contains some tools for doing mathematical imaging in Julia:
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
7
38
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
8 * Effective visualisation based directly on `GR` instead of `Plots`. A sample visualisation main loop that calls
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
9 [AlgTools][]-style step routines.
52
d2e28607c166 README typofix
Tuomo Valkonen <tuomov@iki.fi>
parents: 51
diff changeset
10 * Sub-pixel resolution image translation and sub-image extraction
35
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
11 * Calculation of discrete image gradients (2D, 3D 3D vector fields)
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
12 * A very simple image filtering code that seems more efficient than the `ImageFiltering`
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
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
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
15
3b9105fb72d5 Added a README.md
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
16 The code is used, for example, by <http://dx.doi.org/10.5281/zenodo.3659180>.
36
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
17
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
18 ## Installation
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
19
38
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
20 To install this package, first clone the repository and [AlgTools][] with [Mercurial](https://www.mercurial-scm.org/):
36
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
21
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
22 ```console
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
23 $ hg clone https://tuomov.iki.fi/repos/AlgTools/
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
24 $ hg clone https://tuomov.iki.fi/repos/ImageTools/
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
25 ```
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
26
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
27 (Canonical public repository URLs indicated here.)
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
28 AlgTools has to be installed under the some location as ImageTools.
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
29 Then add the repository to Julia with `Pkg.develop`:
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
30
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
31 ```console
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
32 julia>] develop LOCATION_OF/ImageTools/
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
33 ```
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
34
41
379c4fbd23ff README typofix
Tuomo Valkonen <tuomov@iki.fi>
parents: 38
diff changeset
35 Here replace `LOCATION_OF/ImageTools` with path where you cloned ImageTools. (If you did not change directory after cloning, simply use `ImageTools`.)
36
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
36 Afterwards, you may use the package with:
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
37
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
38 ```console
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
39 julia> using ImageTools
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
40 ```
7a3a963ff507 Installation instructions
Tuomo Valkonen <tuomov@iki.fi>
parents: 35
diff changeset
41
38
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
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.
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
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
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
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
ef9d33ea4460 Rename TestDenoise to Tests
Tuomo Valkonen <tuomov@iki.fi>
parents: 43
diff changeset
49 $ julia --project=Tests
ef9d33ea4460 Rename TestDenoise to Tests
Tuomo Valkonen <tuomov@iki.fi>
parents: 43
diff changeset
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
73ddbd4779c9 Link to AlgTools
Tuomo Valkonen <tuomov@iki.fi>
parents: 37
diff changeset
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/

mercurial