Skip to content

Commit 897d4e8

Browse files
authored
docs: upgrade dependencies and left align the table (#95)
1 parent 100e6ae commit 897d4e8

File tree

6 files changed

+12
-11
lines changed

6 files changed

+12
-11
lines changed

docs/Project.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
CoordinateTransformations = "150eb455-5306-5404-9cee-2592286d6298"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44
ImageDraw = "4381153b-2b60-58ae-a1ba-fd683676385f"
5+
ImageFeatures = "92ff4b2b-8094-53d3-b29d-97f740f06cef"
56
ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
67
Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
8+
Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
79
TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
810

911
[compat]
10-
Documenter = "0.24"
12+
Documenter = "0.26"

docs/src/tutorials/brief.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Now, let us create the two images we will match using BRIEF.
2424
```@example 1
2525
using ImageFeatures, TestImages, Images, ImageDraw, CoordinateTransformations
2626
27-
img = testimage("lena_gray_512");
28-
img1 = Gray.(img);
27+
img = testimage("lighthouse")
28+
img1 = Gray.(img)
2929
trans = Translation(-100, -200)
30-
img2 = warp(img1, trans, axes(img1));
30+
img2 = warp(img1, trans, axes(img1))
3131
nothing # hide
3232
```
3333

@@ -49,8 +49,8 @@ nothing # hide
4949
Now pass the image with the keypoints and the parameters to the [`create_descriptor`](@ref) function.
5050

5151
```@example 1
52-
desc_1, ret_keypoints_1 = create_descriptor(img1, keypoints_1, brief_params);
53-
desc_2, ret_keypoints_2 = create_descriptor(img2, keypoints_2, brief_params);
52+
desc_1, ret_keypoints_1 = create_descriptor(img1, keypoints_1, brief_params)
53+
desc_2, ret_keypoints_2 = create_descriptor(img2, keypoints_2, brief_params)
5454
nothing # hide
5555
```
5656

@@ -64,7 +64,6 @@ nothing # hide
6464
We can use the [ImageDraw.jl](https://github.com/JuliaImages/ImageDraw.jl) package to view the results.
6565

6666
```@example 1
67-
6867
grid = hcat(img1, img2)
6968
offset = CartesianIndex(0, size(img1, 2))
7069
map(m -> draw!(grid, LineSegment(m[1], m[2] + offset)), matches)

src/brief.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ brief_params = BRIEF([size = 128], [window = 9], [sigma = 2 ^ 0.5], [sampling_ty
44
```
55
66
| Argument | Type | Description |
7-
|----------|------|-------------|
7+
| :------- | :--- | :---------- |
88
| **size** | Int | Size of the descriptor |
99
| **window** | Int | Size of sampling window |
1010
| **sigma** | Float64 | Value of sigma used for inital gaussian smoothing of image |

src/brisk.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ brisk_params = BRISK([pattern_scale = 1.0])
44
```
55
66
| Argument | Type | Description |
7-
|----------|------|-------------|
7+
| :--------| :--- | :---------- |
88
| `pattern_scale` | `Float64` | Scaling factor for the sampling window |
99
"""
1010
mutable struct BRISK <: Params

src/freak.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ freak_params = FREAK([pattern_scale = 22.0])
44
```
55
66
| Argument | Type | Description |
7-
|----------|------|-------------|
7+
| :--------| :--- | :---------- |
88
| **pattern_scale** | Float64 | Scaling factor for the sampling window |
99
"""
1010
mutable struct FREAK <: Params

src/orb.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ orb_params = ORB([num_keypoints = 500], [n_fast = 12], [threshold = 0.25], [harr
44
```
55
66
| Argument | Type | Description |
7-
|----------|------|-------------|
7+
| :--------| :--- | :---------- |
88
| **num_keypoints** | Int | Number of keypoints to extract and size of the descriptor calculated |
99
| **n_fast** | Int | Number of consecutive pixels used for finding corners with FAST. See [`fastcorners`] |
1010
| **threshold** | Float64 | Threshold used to find corners in FAST. See [`fastcorners`] |

0 commit comments

Comments
 (0)