{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineRole", "__tag": 4003, "value": "sigma > 0", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the image is smoothed using a Gaussian kernel prior to segmentation." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "sigma" }, { "__type": "Text", "__tag": 4046, "value": " is scalar and " }, { "__type": "ParamRef", "__tag": 4071, "name": "spacing" }, { "__type": "Text", "__tag": 4046, "value": " is provided, the kernel width is divided along each dimension by the spacing. For example, if " }, { "__type": "InlineCode", "__tag": 4051, "value": "sigma=1" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "spacing=[5, 1, 1]" }, { "__type": "Text", "__tag": 4046, "value": ", the effective " }, { "__type": "ParamRef", "__tag": 4071, "name": "sigma" }, { "__type": "Text", "__tag": 4046, "value": " is " }, { "__type": "InlineCode", "__tag": 4051, "value": "[0.2, 1, 1]" }, { "__type": "Text", "__tag": 4046, "value": ". This ensures sensible smoothing for anisotropic images." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The image is rescaled to be in [0, 1] prior to processing (masked values are ignored)." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Images of shape (M, N, 3) are interpreted as 2D RGB images by default. To interpret them as 3D with the last dimension having length 3, use " }, { "__type": "InlineRole", "__tag": 4003, "value": "channel_axis=None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "ParamRef", "__tag": 4071, "name": "start_label" }, { "__type": "Text", "__tag": 4046, "value": " is introduced to handle the issue " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "4" }, { "__type": "Text", "__tag": 4046, "value": ". Label indexing starts at 1 by default." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "convert2lab" }, { "__type": "Text", "__tag": 4046, "value": " is set to " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " but the last array dimension is not of length 3." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "start_label" }, { "__type": "Text", "__tag": 4046, "value": " is not 0 or 1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "image" }, { "__type": "Text", "__tag": 4046, "value": " contains unmasked NaN values." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "image" }, { "__type": "Text", "__tag": 4046, "value": " contains unmasked infinite values." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "image" }, { "__type": "Text", "__tag": 4046, "value": " is 2D but " }, { "__type": "InlineCode", "__tag": 4051, "value": "channel_axis" }, { "__type": "Text", "__tag": 4046, "value": " is -1 (the default)." } ] } ] } ] } ], "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": "labels", "annotation": "2D or 3D array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Integer mask indicating segment labels." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Segments image using k-means clustering in Color-(x,y,z) space." } ] } ], "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": "(M, N[, P][, C]) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input image. Can be 2D or 3D, and grayscale or multichannel (see " }, { "__type": "ParamRef", "__tag": 4071, "name": "channel_axis" }, { "__type": "Text", "__tag": 4046, "value": " parameter). Input image must either be NaN-free or the NaN's must be masked out." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n_segments", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The (approximate) number of labels in the segmented output image." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "compactness", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Balances color proximity and space proximity. Higher values give more weight to space proximity, making superpixel shapes more square/cubic. In SLICO mode, this is the initial compactness. This parameter depends strongly on image contrast and on the shapes of objects in the image. We recommend exploring possible values on a log scale, e.g., 0.01, 0.1, 1, 10, 100, before refining around a chosen value." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_num_iter", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of iterations of k-means." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sigma", "annotation": "float or array-like of floats, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Width of Gaussian smoothing kernel for pre-processing for each dimension of the image. The same sigma is applied to each dimension in case of a scalar value. Zero means no smoothing. Note that " }, { "__type": "ParamRef", "__tag": 4071, "name": "sigma" }, { "__type": "Text", "__tag": 4046, "value": " is automatically scaled if it is scalar and if a manual voxel spacing is provided (see Notes section). If sigma is array-like, its size must match " }, { "__type": "InlineCode", "__tag": 4051, "value": "image" }, { "__type": "Text", "__tag": 4046, "value": "'s number of spatial dimensions." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "spacing", "annotation": "array-like of floats, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The voxel spacing along each spatial dimension. By default, " }, { "__type": "CrossRef", "__tag": 4002, "value": "slic", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.segmentation.slic_superpixels:slic" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " assumes uniform spacing (same voxel resolution along each spatial dimension). This parameter controls the weights of the distances along the spatial dimensions during k-means clustering." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "convert2lab", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether the input should be converted to Lab colorspace prior to segmentation. The input image " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "must" } ] }, { "__type": "Text", "__tag": 4046, "value": " be RGB. Highly recommended. This option defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " when " }, { "__type": "InlineCode", "__tag": 4051, "value": "channel_axis` is not None *and* ``image.shape[-1] == 3" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "enforce_connectivity", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether the generated segments are connected or not" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "min_size_factor", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Proportion of the minimum segment size to be removed with respect to the supposed segment size " }, { "__type": "InlineCode", "__tag": 4051, "value": "`depth*width*height/n_segments`" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_size_factor", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Proportion of the maximum connected segment size. A value of 3 works in most of the cases." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "slic_zero", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Run SLIC-zero, the zero-parameter mode of SLIC. " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "start_label", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The labels' index start. Should be 0 or 1." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.17" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "start_label" }, { "__type": "Text", "__tag": 4046, "value": " was introduced in 0.17" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mask", "annotation": "ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, superpixels are computed only where mask is True, and seed points are homogeneously distributed over the mask using a k-means clustering strategy. Mask number of dimensions must be equal to image number of spatial dimensions." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.17" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "mask" }, { "__type": "Text", "__tag": 4046, "value": " was introduced in 0.17" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "channel_axis", "annotation": "int or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If None, the image is assumed to be a grayscale (single channel) image. Otherwise, this parameter indicates which axis of the array corresponds to channels." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.19" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "channel_axis" }, { "__type": "Text", "__tag": 4046, "value": " was added in 0.19." } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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/segmentation/slic_superpixels.py", "item_line": 105, "item_type": "function", "aliases": [ "skimage.segmentation.slic" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.segmentation import slic\nfrom skimage.data import astronaut\nimg = astronaut()\nsegments = slic(img, n_segments=100, compactness=10)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIncreasing the compactness parameter yields more square regions:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "segments = slic(img, n_segments=100, compactness=20)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "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": "n_segments", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "100" }, { "__type": "SigParam", "__tag": 4030, "name": "compactness", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10.0" }, { "__type": "SigParam", "__tag": 4030, "name": "max_num_iter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10" }, { "__type": "SigParam", "__tag": 4030, "name": "sigma", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "spacing", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "convert2lab", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "enforce_connectivity", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "min_size_factor", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.5" }, { "__type": "SigParam", "__tag": 4030, "name": "max_size_factor", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "3" }, { "__type": "SigParam", "__tag": 4030, "name": "slic_zero", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "start_label", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "mask", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "channel_axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "-1" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "slic" }, "references": [ ".. [1] Radhakrishna Achanta, Appu Shaji, Kevin Smith, Aurelien Lucchi,", " Pascal Fua, and Sabine Süsstrunk, SLIC Superpixels Compared to", " State-of-the-art Superpixel Methods, TPAMI, May 2012.", " :DOI:`10.1109/TPAMI.2012.120`", ".. [2] https://www.epfl.ch/labs/ivrl/research/slic-superpixels/#SLICO", ".. [3] Irving, Benjamin. \"maskSLIC: regional superpixel generation with", " application to local pathology characterisation in medical images.\",", " 2016, :arXiv:`1606.09518`", ".. [4] https://github.com/scikit-image/scikit-image/issues/3722" ], "qa": "skimage.segmentation.slic_superpixels:slic", "arbitrary": [], "local_refs": [ "channel_axis", "compactness", "convert2lab", "enforce_connectivity", "image", "labels", "mask", "max_num_iter", "max_size_factor", "min_size_factor", "n_segments", "sigma", "slic_zero", "spacing", "start_label" ] }