[WIP] #220 calibration

dummy

@@ -0,0 +1,44 @@
+dummy
+512 512 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 1.0 1.0 
+1.0 0.0 0.0 0.0 
+0.0 1.0 0.0 0.0 
+0.0 0.0 1.0 0.0 
+float64

openpiv/calibration/__init__.py

@@ -0,0 +1,60 @@
+"""
+==================
+Camera Calibration
+==================
+
+This submodule contains functions and routines to calibrate a camera
+system.
+
+DLT Model
+=========
+    camera - Create an instance of a DLT camera model
+    calibrate_dlt - Calibrate and return DLT coefficients and fitting error
+    line_intersect - Using two lines, locate where those lines intersect
+    multi_line_intersect - Using multiple lines, approximate their intersection
+
+Pinhole Model
+=============
+    calibrate_intrinsics - Calculate the intrinsic parameters using Zang's algorithm
+    camera - Create an instance of a Pinhole camera model
+    calibrate_dlt - Calibrate and return DLT coefficients and fitting error
+    line_intersect - Using two lines, locate where those lines intersect
+    multi_line_intersect - Using multiple lines, approximate their intersection
+
+Polynomial Model
+================
+    camera - Create an instance of a Soloff camera model
+    multi_line_intersect - Using multiple lines, approximate their intersection
+
+Marker Detection (Marker Grid)
+==============================
+    detect_markers_template - Detect markers via template correlation
+    detect_markers_blobs - Detect markers via labeling blobs
+    get_circular_template - Generate a circular template
+    get_cross_template - Generate a cross template
+    preprocess_image - Preprocess calibration image
+
+Calibration Grid
+================
+    get_asymmetric_grid - Create an asymmetric rectangular calibration grid
+    get_simple_grid - Create a simple rectangular calibration grid
+
+Match Calibration Points
+========================
+    find_corners - Locate 4 or 6 corners of a calibration grid
+    find_nearest_points - Find the closest point to a cursor
+    get_pairs_dlt - Match marker pairs using 4 corners and the DLT algorithm
+    get_pairs_proj - Match marker pairs using a rough projection estimate
+    reorder_image_points - Reorder image points in ascending order
+    show_calibration_image - Plot calibration image and markers
+
+Utils
+=====
+    homogenize - Homogenize array by appending ones to the last axis
+    get_image_mapping - Calculate the mappings to rectify a 2D image
+    get_los_error - Calculate the RMS error of a line of sight (LOS) at a z plane
+    get_reprojection_error - Calculate the root mean square (RMS) error
+    get_rmse - Calculate the root mean square error of the residuals
+    plot_epipolar_line - Plot a 3D representation of epipolar lines
+
+"""

openpiv/calibration/_cal_doc_utils.py

@@ -0,0 +1,69 @@
+from scipy._lib import doccer 
+
+
+__all__ = ['docfiller']
+
+
+# typing the same doc string multiple times gets annoying and error prone...
+_obj_coords = (
+"""object_points : 2D np.ndarray
+    Real world coordinates stored in a ndarray structured like [X, Y, Z]'.""")
+
+_img_coords = (
+"""image_points : 2D np.ndarray
+    Image coordinates stored in a ndarray structured like [x, y].""")
+
+_cam_struct = (
+"""cam_struct : dict
+    A dictionary structure of camera parameters.""")
+
+_project_points_func = (
+"""project_points_func : function
+    Projection function with the following signature:
+    res = func(cam_struct, object_points).""")
+
+_project_to_z_func = (
+"""project_to_z_func : function
+    Projection function with the following signiture:
+    res = func(cam_struct, image_points, Z).""")
+
+_x_lab_coord = (
+"""X : 1D np.ndarray
+        Projected world x-coordinates.""")
+
+_y_lab_coord = (
+"""Y : 1D np.ndarray
+        Projected world y-coordinates.""")
+
+_z_lab_coord = (
+"""Z : 1D np.ndarray
+        Projected world z-coordinates.""")
+
+_x_img_coord = (
+"""x : 1D np.ndarray
+        Projected image x-coordinates.""")
+
+_y_img_coord = (
+"""y : 1D np.ndarray
+        Projected image y-coordinates.""")
+
+_project_z = (
+"""z : float
+    A float specifying the Z (depth) value to project to.""")
+
+docdict = {
+    "object_points": _obj_coords,
+    "image_points": _img_coords,
+    "cam_struct": _cam_struct,
+    "project_points_func": _project_points_func,
+    "project_to_z_func": _project_to_z_func,
+    "x_lab_coord": _x_lab_coord,
+    "y_lab_coord": _y_lab_coord,
+    "z_lab_coord": _z_lab_coord,
+    "x_img_coord": _x_img_coord,
+    "y_img_coord": _y_img_coord,
+    "project_z": _project_z
+}
+
+# SciPy's nifty decorator (works better than my simple implementation)
+docfiller = doccer.filldoc(docdict)