Merge pull request #316 from tonysyu/doc-img_as_bool

DOC: Fix docstring note about conversion range
2026-07-01 21:32:10 +08:00 · 2012-09-15 00:50:33 -07:00
parent 051f73f2b6 81e49b6686
commit 9b5be5ed03
1 changed files with 2 additions and 1 deletions
@@ -360,7 +360,8 @@ def img_as_bool(image, force_copy=False):

    Notes
    -----
-    All non-zero elements are treated as True.
+    The upper half of the input dtype's positive range is True, and the lower
+    half is False. All negative values (if present) are False.

    """
    return convert(image, np.bool_, force_copy)