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