{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 0.17" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The dtype of the output array has changed to match the input dtype, or float if the output range is specified by a pair of values." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Image array after rescaling its intensity. This image is the same dtype as the input image." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return image after stretching or shrinking its intensity levels." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "image", "annotation": "array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Image array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "in_range, out_range", "annotation": "str or 2-tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Min and max intensity values of input and output image. The possible values for this parameter are enumerated below." } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'image'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use image min/max as the intensity range." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'dtype'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use min/max of the image's dtype as the intensity range." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "dtype-name" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use intensity range based on desired " }, { "__type": "CrossRef", "__tag": 4002, "value": "dtype", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.util.dtype" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Must be valid key in " }, { "__type": "InlineRole", "__tag": 4003, "value": "DTYPE_RANGE", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "2-tuple" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use " }, { "__type": "InlineRole", "__tag": 4003, "value": "range_values", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " as explicit min/max intensities." } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The desired intensity range of the input and output, " }, { "__type": "ParamRef", "__tag": 4071, "name": "in_range" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "out_range" }, { "__type": "Text", "__tag": 4046, "value": " respectively, are used to stretch or shrink the intensity range of the input image. See examples below." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Returns", "Yields", "Receives", "Raises", "Warns", "Other Parameters", "Attributes", "Methods", "Notes", "Warnings" ], "item_file": "/dev/scikit-image/src/skimage/exposure/exposure.py", "item_line": 491, "item_type": "function", "aliases": [ "skimage.exposure.rescale_intensity" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, the min/max intensities of the input image are stretched to\nthe limits allowed by the image's dtype, since `in_range` defaults to\n'image' and `out_range` defaults to 'dtype':\n\n" }, { "__type": "Code", "__tag": 4050, "value": "image = np.array([51, 102, 153], dtype=np.uint8)\nrescale_intensity(image)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIt's easy to accidentally convert an image dtype from uint8 to float:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "1.0 * image\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nUse `rescale_intensity` to rescale to the proper range for float dtypes:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "image_float = 1.0 * image\nrescale_intensity(image_float)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nTo maintain the low contrast of the original, use the `in_range` parameter:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rescale_intensity(image_float, in_range=(0, 255))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIf the min/max value of `in_range` is more/less than the min/max image\nintensity, then the intensity levels are clipped:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rescale_intensity(image_float, in_range=(0, 102))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIf you have an image with signed integers but want to rescale the image to\njust the positive range, use the `out_range` parameter. In that case, the\noutput dtype will be float:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "image = np.array([-10, 0, 10], dtype=np.int8)\nrescale_intensity(image, out_range=(0, 127))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nTo get the desired range with a specific dtype, use ``.astype()``:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rescale_intensity(image, out_range=(0, 127)).astype(np.int8)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIf the input image is constant, the output will be clipped directly to the\noutput range:\n" }, { "__type": "Code", "__tag": 4050, "value": "image = np.array([130, 130, 130], dtype=np.int32)\nrescale_intensity(image, out_range=(0, 127)).astype(np.int32)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "equalize_hist", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.exposure.exposure:equalize_hist" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "image", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "in_range", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "image" }, { "__type": "SigParam", "__tag": 4030, "name": "out_range", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "dtype" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "rescale_intensity" }, "references": null, "qa": "skimage.exposure.exposure:rescale_intensity", "arbitrary": [], "local_refs": [ "image", "in_range", "out", "out_range" ] }