From 57438a8d26df0ecbd912b4fd4c1a69041d8834ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 12 Jun 2016 20:59:49 +0200 Subject: [PATCH 1/4] DOC: remove wrong math tags --- skimage/transform/_geometric.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 1cd5621f..c006bcbb 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -344,9 +344,7 @@ class ProjectiveTransform(GeometricTransform): class AffineTransform(ProjectiveTransform): - """2D affine transformation of the form: - - ..:math: + """2D affine transformation of the form:: X = a0*x + a1*y + a2 = = sx*x*cos(rotation) - sy*y*sin(rotation + shear) + a2 @@ -572,9 +570,7 @@ class PiecewiseAffineTransform(GeometricTransform): class SimilarityTransform(ProjectiveTransform): - """2D similarity transformation of the form: - - ..:math: + """2D similarity transformation of the form:: X = a0 * x - b0 * y + a1 = = m * x * cos(rotation) - m * y * sin(rotation) + a1 @@ -744,9 +740,7 @@ class SimilarityTransform(ProjectiveTransform): class PolynomialTransform(GeometricTransform): - """2D transformation of the form: - - ..:math: + """2D transformation of the form:: X = sum[j=0:order]( sum[i=0:j]( a_ji * x**(j - i) * y**i )) Y = sum[j=0:order]( sum[i=0:j]( b_ji * x**(j - i) * y**i )) From 41e9c8d91ac080453c4b040291ec6692d9f48503 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 12 Jun 2016 21:00:07 +0200 Subject: [PATCH 2/4] DOC: explicit default value behavior --- skimage/data/_binary_blobs.py | 1 + 1 file changed, 1 insertion(+) diff --git a/skimage/data/_binary_blobs.py b/skimage/data/_binary_blobs.py index 83503151..e4a23984 100644 --- a/skimage/data/_binary_blobs.py +++ b/skimage/data/_binary_blobs.py @@ -21,6 +21,7 @@ def binary_blobs(length=512, blob_size_fraction=0.1, n_dim=2, Should be in [0, 1]. seed : int, optional Seed to initialize the random number generator. + If `None`, a random seed from the operating system is used. Returns ------- From 323e9ff5005e8441d2bf4ac328872704ad154f6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 12 Jun 2016 21:05:06 +0200 Subject: [PATCH 3/4] DOC: optional tag to optional args --- skimage/util/dtype.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/skimage/util/dtype.py b/skimage/util/dtype.py index a0ff637e..d1108776 100644 --- a/skimage/util/dtype.py +++ b/skimage/util/dtype.py @@ -36,7 +36,7 @@ def dtype_limits(image, clip_negative=True): ---------- image : ndarray Input image. - clip_negative : bool + clip_negative : bool, optional If True, clip the negative range (i.e. return 0 for min intensity) even if the image dtype allows negative values. """ @@ -67,9 +67,9 @@ def convert(image, dtype, force_copy=False, uniform=False): Input image. dtype : dtype Target data-type. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. - uniform : bool + uniform : bool, optional Uniformly quantize the floating point range to the integer range. By default (uniform=False) floating point values are scaled and rounded to the nearest integers, which minimizes back and forth @@ -284,7 +284,7 @@ def img_as_float(image, force_copy=False): ---------- image : ndarray Input image. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. Returns @@ -308,7 +308,7 @@ def img_as_uint(image, force_copy=False): ---------- image : ndarray Input image. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. Returns @@ -332,7 +332,7 @@ def img_as_int(image, force_copy=False): ---------- image : ndarray Input image. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. Returns @@ -357,7 +357,7 @@ def img_as_ubyte(image, force_copy=False): ---------- image : ndarray Input image. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. Returns @@ -381,7 +381,7 @@ def img_as_bool(image, force_copy=False): ---------- image : ndarray Input image. - force_copy : bool + force_copy : bool, optional Force a copy of the data, irrespective of its current dtype. Returns From 6032870897f1f232da5a5375b393ad8b5a7326b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 12 Jun 2016 22:17:33 +0200 Subject: [PATCH 4/4] DOC: remove warning --- skimage/transform/_geometric.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index c006bcbb..71516faa 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -344,7 +344,7 @@ class ProjectiveTransform(GeometricTransform): class AffineTransform(ProjectiveTransform): - """2D affine transformation of the form:: + """2D affine transformation of the form: X = a0*x + a1*y + a2 = = sx*x*cos(rotation) - sy*y*sin(rotation + shear) + a2 @@ -570,7 +570,7 @@ class PiecewiseAffineTransform(GeometricTransform): class SimilarityTransform(ProjectiveTransform): - """2D similarity transformation of the form:: + """2D similarity transformation of the form: X = a0 * x - b0 * y + a1 = = m * x * cos(rotation) - m * y * sin(rotation) + a1 @@ -740,7 +740,7 @@ class SimilarityTransform(ProjectiveTransform): class PolynomialTransform(GeometricTransform): - """2D transformation of the form:: + """2D transformation of the form: X = sum[j=0:order]( sum[i=0:j]( a_ji * x**(j - i) * y**i )) Y = sum[j=0:order]( sum[i=0:j]( b_ji * x**(j - i) * y**i ))