{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A class for finding the minimum cost path through a given n-d costs array." } ] } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "offsets", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Equivalent to the " }, { "__type": "ParamRef", "__tag": 4071, "name": "offsets" }, { "__type": "Text", "__tag": 4046, "value": " provided to the constructor, or if none were so provided, the offsets created for the requested n-d neighborhood. These are useful for interpreting the " }, { "__type": "CrossRef", "__tag": 4002, "value": "traceback", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "traceback", "version": "*", "kind": "api", "path": "traceback" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " array returned by the find_costs() method." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "costs", "annotation": "ndarray", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "offsets", "annotation": "iterable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A list of offset tuples: each offset specifies a valid move from a given n-d position. If not provided, offsets corresponding to a singly- or fully-connected n-d neighborhood will be constructed with make_offsets(), using the " }, { "__type": "ParamRef", "__tag": 4071, "name": "fully_connected" }, { "__type": "Text", "__tag": 4046, "value": " parameter value." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fully_connected", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If no " }, { "__type": "ParamRef", "__tag": 4071, "name": "offsets" }, { "__type": "Text", "__tag": 4046, "value": " are provided, this determines the connectivity of the generated neighborhood. If true, the path may go along diagonals between elements of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "costs" }, { "__type": "Text", "__tag": 4046, "value": " array; otherwise only axial moves are permitted." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sampling", "annotation": "tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For each dimension, specifies the distance between two cells/voxels. If not given or None, the distance is assumed unit." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Given an n-d costs array, this class can be used to find the minimum-cost path through that array from any set of points to any other set of points. Basic usage is to initialize the class and call find_costs() with a one or more starting indices (and an optional list of end indices). After that, call traceback() one or more times to find the path from any given end-position to the closest starting index. New paths through the same costs array can be found by calling find_costs() repeatedly." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The cost of a path is calculated simply as the sum of the values of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "costs" }, { "__type": "Text", "__tag": 4046, "value": " array at each point on the path. The class MCP_Geometric, on the other hand, accounts for the fact that diagonal vs. axial moves are of different lengths, and weights the path cost accordingly." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array elements with infinite or negative costs will simply be ignored, as will paths whose cumulative cost overflows to infinite." } ] } ], "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/build/cp314/src/skimage/graph/_mcp.cpython-314-darwin.so", "item_line": null, "item_type": "class", "aliases": [ "skimage.graph.MCP" ], "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": "costs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "offsets", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "fully_connected", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "sampling", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "MCP" }, "references": null, "qa": "skimage.graph._mcp:MCP", "arbitrary": [], "local_refs": [ "costs", "fully_connected", "offsets", "sampling" ] }