From dc05d56c8921e844ee38e8a351991f3b4c23ecb7 Mon Sep 17 00:00:00 2001
From: Egor Panfilov <multicolor.mood@gmail.com>
Date: Tue, 8 Dec 2015 00:56:32 +0300
Subject: [PATCH] DOC: Added gallery example for inpainting

---
 doc/examples/plot_inpaint.py | 58 ++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 doc/examples/plot_inpaint.py

diff --git a/doc/examples/plot_inpaint.py b/doc/examples/plot_inpaint.py
new file mode 100644
index 00000000..ed79722b
--- /dev/null
+++ b/doc/examples/plot_inpaint.py
@@ -0,0 +1,58 @@
+"""
+===========
+Inpainting
+===========
+Inpainting [1]_ is the process of reconstructing lost or deteriorated
+parts of images and videos. 
+
+The reconstruction is supposed to be performed in fully automatic way by
+exploiting the information presented in non-damaged regions.
+
+In this example, we show how the masked pixels get inpainted by
+inpainting algorithm based on 'biharmonic equation'-assumption [2]_ [3]_.
+"""
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+from skimage import data, color
+from skimage.restoration import inpaint
+
+image_orig = color.rgb2gray(data.astronaut())
+
+# Create mask with three defect regions: left, middle, right respectively
+mask = np.zeros_like(image_orig)
+mask[20:60, 0:20] = 1
+mask[200:300, 150:170] = 1
+mask[50:100, 400:430] = 1
+
+image_defect = image_orig.copy()
+image_defect[np.where(mask)] = 0
+
+image_result = inpaint.inpaint_biharmonic(image_defect, mask)
+
+fig, (ax1, ax2, ax3) = plt.subplots(ncols=3, nrows=1, figsize=(10, 6))
+
+ax1.set_title('Defected image')
+ax1.imshow(image_orig, cmap=plt.cm.gray, interpolation='nearest')
+ax1.set_xticks([]), ax1.set_yticks([])
+
+ax2.set_title('Defect mask')
+ax2.imshow(mask, cmap=plt.cm.gray, interpolation='nearest')
+ax2.set_xticks([]), ax2.set_yticks([])
+
+ax3.set_title('Inpainted image')
+ax3.imshow(image_result, cmap=plt.cm.gray, interpolation='nearest')
+ax3.set_xticks([]), ax3.set_yticks([])
+
+plt.show()
+
+"""
+.. [1]  Wikipedia. Inpainting
+        https://en.wikipedia.org/wiki/Inpainting
+.. [2]  Wikipedia. Biharmonic equation
+        https://en.wikipedia.org/wiki/Biharmonic_equation
+.. [3]  N.S.Hoang, S.B.Damelin, "On surface completion and image 
+        inpainting by biharmonic functions: numerical aspects",
+        http://www.ima.umn.edu/~damelin/biharmonic
+"""