{ "__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": "The implemented algorithm is described in " }, { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Table2" } ] }, { "__type": "Text", "__tag": 4046, "value": " of " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Color images are not supported." } ] } ] } ] } ], "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": "flow", "annotation": "ndarray, shape (reference_image.ndim, M, N[, P[, ...]])", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The estimated optical flow components for each axis." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Coarse to fine optical flow estimator." } ] } ], "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": "reference_image", "annotation": "ndarray, shape (M, N[, P[, ...]])", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The first grayscale image of the sequence." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "moving_image", "annotation": "ndarray, shape (M, N[, P[, ...]])", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The second grayscale image of the sequence." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "radius", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Radius of the window considered around each pixel." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "num_warp", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of times moving_image is warped." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "gaussian", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, a Gaussian kernel is used for the local integration. Otherwise, a uniform kernel is used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "prefilter", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to prefilter the estimated optical flow before each image warp. When True, a median filter with window size 3 along each axis is applied. This helps to remove potential outliers." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output data type: must be floating point. Single precision provides good results and saves memory usage and computation time compared to double precision." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The iterative Lucas-Kanade (iLK) solver is applied at each level of the image pyramid. iLK " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " is a fast and robust alternative to TVL1 algorithm although less accurate for rendering flat surfaces and object boundaries (see " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ], "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/registration/_optical_flow.py", "item_line": 347, "item_type": "function", "aliases": [ "skimage.registration.optical_flow_ilk" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.color import rgb2gray\nfrom skimage.data import stereo_motorcycle\nfrom skimage.registration import optical_flow_ilk\nreference_image, moving_image, disp = stereo_motorcycle()\nreference_image = rgb2gray(reference_image)\nmoving_image = rgb2gray(moving_image)\nflow = optical_flow_ilk(moving_image, reference_image)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "reference_image", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "moving_image", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "radius", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "7" }, { "__type": "SigParam", "__tag": 4030, "name": "num_warp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "10" }, { "__type": "SigParam", "__tag": 4030, "name": "gaussian", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "prefilter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "optical_flow_ilk" }, "references": [ ".. [1] Le Besnerais, G., & Champagnat, F. (2005, September). Dense", " optical flow by iterative local window registration. In IEEE", " International Conference on Image Processing 2005 (Vol. 1,", " pp. I-137). IEEE. :DOI:`10.1109/ICIP.2005.1529706`", ".. [2] Plyer, A., Le Besnerais, G., & Champagnat,", " F. (2016). Massively parallel Lucas Kanade optical flow for", " real-time video processing applications. Journal of Real-Time", " Image Processing, 11(4), 713-730. :DOI:`10.1007/s11554-014-0423-0`" ], "qa": "skimage.registration._optical_flow:optical_flow_ilk", "arbitrary": [], "local_refs": [ "dtype", "flow", "gaussian", "moving_image", "num_warp", "prefilter", "radius", "reference_image" ] }