{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When " }, { "__type": "ParamRef", "__tag": 4071, "name": "decomposition" }, { "__type": "Text", "__tag": 4046, "value": " is not None, each element of the " }, { "__type": "CrossRef", "__tag": 4002, "value": "footprint", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "footprint" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " tuple is a 2-tuple of the form " }, { "__type": "InlineCode", "__tag": 4051, "value": "(ndarray, num_iter)" }, { "__type": "Text", "__tag": 4046, "value": " that specifies a footprint array and the number of iterations it is to be applied." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For binary morphology, using " }, { "__type": "InlineCode", "__tag": 4051, "value": "decomposition='sequence'" }, { "__type": "Text", "__tag": 4046, "value": " was observed to give better performance, with the magnitude of the performance increase rapidly increasing with footprint size. For grayscale morphology with square footprints, it is recommended to use " }, { "__type": "InlineCode", "__tag": 4051, "value": "decomposition=None" }, { "__type": "Text", "__tag": 4046, "value": " since the internal SciPy functions that are called already have a fast implementation based on separable 1D sliding windows." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The 'sequence' decomposition mode only supports odd valued " }, { "__type": "ParamRef", "__tag": 4071, "name": "width" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "width" }, { "__type": "Text", "__tag": 4046, "value": " is even, the sequence used will be identical to the 'separable' mode." } ] } ], "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": "footprint", "annotation": "ndarray or tuple", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The footprint where elements of the neighborhood are 1 and 0 otherwise. When " }, { "__type": "ParamRef", "__tag": 4071, "name": "decomposition" }, { "__type": "Text", "__tag": 4046, "value": " is None, this is just a numpy.ndarray. Otherwise, this will be a tuple whose length is equal to the number of unique structuring elements to apply (see Notes for more detail)" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Generates a cube-shaped footprint." } ] } ], "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": "width", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The width, height and depth of the cube." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 0.25" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "cube", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.morphology.footprints:cube" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is deprecated since version 0.25 and will be removed in version 0.27. Use " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.morphology.footprint_rectangle", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.morphology.footprints:footprint_rectangle" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " instead." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is the 3D equivalent of a square. Every pixel along the perimeter has a chessboard distance no greater than radius (radius=floor(width/2)) pixels." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The data type of the footprint." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "decomposition", "annotation": "{None, 'separable', 'sequence'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If None, a single array is returned. For 'sequence', a tuple of smaller footprints is returned. Applying this series of smaller footprints will given an identical result to a single, larger footprint, but often with better computational performance. See Notes for more details." } ] } ] } ] } ], "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/morphology/footprints.py", "item_line": 701, "item_type": "function", "aliases": [ "skimage.morphology.cube" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "width", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "decomposition", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "cube" }, "references": null, "qa": "skimage.morphology.footprints:cube", "arbitrary": [], "local_refs": [ "decomposition", "dtype", "footprint", "width" ] }