Skip to content

Commit 13c4417

Browse files
committed
Adds ORB docs
1 parent 7550b37 commit 13c4417

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/orb.jl

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ type ORB <: DescriptorParams
88
sigma::Float64
99
end
1010

11+
"""
12+
```
13+
orb_params = ORB([num_keypoints = 500], [n_fast = 12], [threshold = 0.25], [harris_factor = 0.04], [downsample = 1.3], [levels = 8], [sigma = 1.2])
14+
```
15+
16+
| Argument | Type | Description |
17+
|----------|------|-------------|
18+
| `num_keypoints` | `Int` | Number of keypoints to extract and size of the descriptor calculated |
19+
| `n_fast` | `Int` | Number of consecutive pixels used for finding corners with FAST. See [`fastcorners`] |
20+
| `threshold` | `Float64` | Threshold used to find corners in FAST. See [`fastcorners`] |
21+
| `harris_factor` | `Float64` | Harris factor `k` used to rank keypoints by harris responses and extract the best ones |
22+
| `downsample` | `Float64` | Downsampling parameter used while building the gaussian pyramid. See [`gaussian_pyramid`] in Images.jl |
23+
| `levels` | `Int` | Number of levels in the gaussian pyramid. See [`gaussian_pyramid`] in Images.jl |
24+
| `sigma` | `Float64` | Used for gaussian smoothing in each level of the gaussian pyramid. See [`gaussian_pyramid`] in Images.jl |
25+
"""
1126
function ORB(; num_keypoints::Int = 500, n_fast::Int = 12, threshold::Float64 = 0.25, harris_factor::Float64 = 0.04, downsample::Real = 1.3, levels::Int = 8, sigma::Float64 = 1.2)
1227
ORB(num_keypoints, n_fast, threshold, harris_factor, downsample, levels, sigma)
1328
end

0 commit comments

Comments
 (0)