Update documentation

Author: nghia-vo

discorpy/losa/loadersaver.py

@@ -28,7 +28,7 @@
 - Save a 2D array as a tif/png/jpg image or a 2D, 3D array to a hdf file.
 - Save a plot of data points to an image.
 - Save/load metadata to/from a text/json file.
-- Save/load python list
+- Save/load python list.
 
 """
 

discorpy/prep/preprocessing.py

@@ -27,11 +27,13 @@
 -   Determine the median dot-size, median distance between two nearest dots,
     and the slopes of grid-lines of a dot-pattern image.
 -   Remove non-dot objects or misplaced dots.
--   Group dot-centroids into horizontal lines and vertical lines.
+-   Group points into horizontal lines and vertical lines.
 -   Calculate a threshold value for binarizing.
 -   Create a 2D mask with parabolic boundary.
 -   Remove points outside a parabolic mask in a 2D space.
 -   Extract dot-centroids of a dot-pattern from a binary or grayscale image.
+-   Group points on strongly curved lines into horizontal lines and vertical
+    lines based on polynomial fit.
 """
 
 import numpy as np

discorpy/proc/processing.py

@@ -27,13 +27,15 @@
 """
 Module of processing methods:
 
-- Fit lines of points to parabolas, find the center of distortion.
-- Calculate undistorted intercepts of gridlines.
-- Calculate distortion coefficients of the backward model, the forward model,
-  and the backward-from-forward model.
-- Correct perspective distortion affecting curve lines.
-- Generate non-perspective points or lines from perspective points or lines.
-- Calculate perspective coefficients.
+-   Fit lines of points to parabolas, find the center of distortion.
+-   Calculate undistorted intercepts of gridlines.
+-   Calculate distortion coefficients of the backward model, the forward model,
+    and the backward-from-forward model.
+-   Correct perspective distortion affecting curve lines.
+-   Generate non-perspective points or lines from perspective points or lines.
+-   Calculate perspective coefficients.
+-   Correct perspective effect.
+-   Find center of distortion based on using vanishing points.
 
 """
 import numpy as np

docs/source/api/discorpy.prep.linepattern.rst

@@ -17,6 +17,6 @@
       calc_slope_distance_hor_lines
       calc_slope_distance_ver_lines
       get_tilted_profile
+      convert_chessboard_to_linepattern
       get_cross_points_hor_lines
       get_cross_points_ver_lines
-      convert_chessboard_to_linepattern

docs/source/api/discorpy.prep.preprocessing.rst

@@ -29,4 +29,6 @@
       remove_points_using_parabola_mask
       get_points_dot_pattern
       rotate_points
-      remove_subset_points
+      remove_subset_points
+      group_dots_hor_lines_based_polyfit
+      group_dots_ver_lines_based_polyfit

docs/source/api/discorpy.proc.processing.rst

@@ -32,4 +32,7 @@
       generate_4_source_target_perspective_points
       calc_perspective_coefficients
       update_center
+      correct_perspective_effect
+      find_center_based_vanishing_points
+      find_center_based_vanishing_points_iteration