fix feature type, multiple bugs

Author: mronian

src/brisk.jl

@@ -1,3 +1,12 @@
+"""
+```
+brisk_params = BRISK([pattern_scale = 1.0])
+```
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `pattern_scale` | `Float64` | Scaling factor for the sampling window | 
+"""
 type BRISK{S, T, O} <: Params
     threshold::Float64
     octaves::Int

src/core.jl

@@ -1,5 +1,25 @@
 abstract Params
 
+"""
+```
+keypoint = Keypoint(y, x)
+keypoint = Keypoint(feature)
+```
+
+A `Keypoint` may be created by passing the coordinates of the point or from a feature.
+"""
+typealias Keypoint CartesianIndex{2}
+
+"""
+```
+keypoints = Keypoints(boolean_img)
+keypoints = Keypoints(features)
+```
+
+Creates a `Vector{Keypoint}` of the `true` values in a boolean image or from a list of features.
+"""
+typealias Keypoints Vector{CartesianIndex{2}}
+
 """
 ```
 feature = Feature(keypoint, orientation = 0.0, scale = 0.0)
@@ -13,10 +33,6 @@ immutable Feature
     scale::Float64
 end
 
-Feature(k::Keypoint) = Feature(k, 0.0, 0.0)
-
-Feature(k::Keypoint, ori::Float64) = Feature(k, ori, 0.0)
-
 """
 ```
 features = Features(boolean_img)
@@ -28,29 +44,15 @@ list of keypoints.
 """
 typealias Features Vector{Feature}
 
-Features(keypoints::Keypoints) = map(k -> Feature(k), keypoints)
-
-Features(img::AbstractArray) = Features(Keypoints(img))
+Feature(k::Keypoint) = Feature(k, 0.0, 0.0)
 
-"""
-```
-keypoint = Keypoint(y, x)
-keypoint = Keypoint(feature)
-```
+Feature(k::Keypoint, ori::Number) = Feature(k, ori, 0.0)
 
-A `Keypoint` may be created by passing the coordinates of the point or from a feature.
-"""
-typealias Keypoint CartesianIndex{2}
+Features(keypoints::Keypoints) = map(k -> Feature(k), keypoints)
 
-"""
-```
-keypoints = Keypoints(boolean_img)
-keypoints = Keypoints(features)
-```
+Features(img::AbstractArray) = Features(Keypoints(img))
 
-Creates a `Vector{Keypoint}` of the `true` values in a boolean image or from a list of features.
-"""
-typealias Keypoints Vector{CartesianIndex{2}}
+Keypoint(feature::Feature) = feature.keypoint
 
 function Keypoints(img::AbstractArray)
     r, c, _ = findnz(img)
@@ -59,8 +61,6 @@ end
 
 Keypoints(features::Features) = map(f -> f.keypoint, features)        
 
-Keypoint(feature::Feature) = feature.keypoint
-
 """
 ```
 distance = hamming_distance(desc_1, desc_2)

test/brisk.jl

@@ -19,6 +19,7 @@ facts("BRISK") do
 
         desc_1, ret_features_1 = create_descriptor(img_array_1, features_1, brisk_params)
         desc_2, ret_features_2 = create_descriptor(img_array_2, features_2, brisk_params)
+        
         matches = match_keypoints(Keypoints(ret_features_1), Keypoints(ret_features_2), desc_1, desc_2, 0.1)
         reverse_keypoints_1 = [_reverserotate(m[1], pi / 4, (256, 384)) for m in matches]
         @fact all(isapprox(rk[1], m[2][1], atol = 4) && isapprox(rk[2], m[2][2], atol = 4) for (rk, m) in zip(reverse_keypoints_1, matches)) --> true

test/core.jl

@@ -9,6 +9,11 @@ facts("Core") do
         keypoints = Keypoints(img)
         @fact sort(keypoints) == sort(ids) --> true
         @fact Keypoint(1, 2) --> CartesianIndex{2}(1, 2)
+        
+        features = Features(img)
+        keypoints = Keypoints(features)
+        @fact sort(keypoints) == sort(ids) --> true
+
     end
 
     context("Keypoint Matching") do