Commit 81bcc499 authored by kberry's avatar kberry
Browse files

Documentation updates

parent f3f02b07
Loading
Loading
Loading
Loading
+6 −6
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ from scipy.misc import imresize
# TODO: look into KeyPoint.size and perhaps use to determine an appropriately-sized search/template.
# TODO: do not allow even sizes

def subpixel_offset(template_kp, search_kp, template_img, search_img, template_size=9, search_size=27, upsampling=10):
    """
    Uses a pattern-matcher on subsets of two images determined from the passed-in keypoints and optional sizes to
    compute an x and y offset from the search keypoint to the template keypoint and an associated strength.
@@ -33,7 +34,6 @@ Parameters
      The returned tuple is of form: (x_offset, y_offset, strength). The offsets are from the search to the template
      keypoint.
    """
def subpixel_offset(template_kp, search_kp, template_img, search_img, template_size=9, search_size=27, upsampling=10):
    # Get the x,y coordinates
    temp_x, temp_y = map(int, template_kp.pt)
    search_x, search_y = map(int, search_kp.pt)
+3 −0
Original line number Diff line number Diff line
@@ -5,3 +5,6 @@

   feature_extractor
   matcher
   outlier_detector
   subpixel
   
+10 −0
Original line number Diff line number Diff line
:mod:`matcher.outlier_detector` --- Finding outliers in both the keypoints and the matches
====================================================================

The :mod:`matcher.outlier_detector` module

.. versionadded:: 0.1.0

.. automodule:: autocnet.matcher.outlier_detector
   :synopsis:
   :members:
+11 −0
Original line number Diff line number Diff line
:mod:`matcher.subpixel` --- Performing subpixel registration between images
====================================================================

The :mod:`matcher.subpixel` module

.. versionadded:: 0.1.0

.. automodule:: autocnet.matcher.subpixel
   :synopsis:
   :members: