From 61b7c20e033838f88f6cc6a4b7e8b7cc900dc50e Mon Sep 17 00:00:00 2001 From: Kevin Keraudren Date: Thu, 3 Dec 2015 22:16:56 +0000 Subject: [PATCH] cleaned tests and documentation, added deprecation note in doc for LineModel. --- skimage/measure/fit.py | 6 +++--- skimage/measure/tests/test_fit.py | 2 -- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/skimage/measure/fit.py b/skimage/measure/fit.py index f4a8df37..c6097c57 100644 --- a/skimage/measure/fit.py +++ b/skimage/measure/fit.py @@ -44,6 +44,8 @@ class LineModel(BaseModel): A minimum number of 2 points is required to solve for the parameters. + **Deprecated, use ``LineModelND`` instead.** + Attributes ---------- params : tuple @@ -243,9 +245,7 @@ class LineModelND(BaseModel): axis : int axis orthogonal to the hyperplane intersecting the line. params : (2, ) array, optional - Optional custom parameter set in the form (`dist`, `theta`). - new_params : (2, ) array, optional - Optional custom parameter set in the form (`X0`, `direction`). + Optional custom parameter set in the form (`origin`, `direction`). Returns ------- diff --git a/skimage/measure/tests/test_fit.py b/skimage/measure/tests/test_fit.py index 86791bd7..af34cc29 100644 --- a/skimage/measure/tests/test_fit.py +++ b/skimage/measure/tests/test_fit.py @@ -52,8 +52,6 @@ def test_line_model_residuals(): def test_line_model_under_determined(): data = np.empty((1, 2)) assert_raises(ValueError, LineModel().estimate, data) - data = np.empty((1, 3)) - assert_raises(ValueError, LineModel().estimate, data) def test_line_modelND_invalid_input():