GitLocker: The Coding Marketplace

Description:

PIKMInpainter 0.0.2

Perturbed Inertial KM Iterations for Image Inpainting
This package provides functions to execute perturbed inertial Krasnoselskii-Mann iterations to solve the image inpainting problem.
This code is related to my Bachelor Thesis on the topic of perturbed inertial Krasnoselskii-Mann iterations. In this thesis, I devise an inertial framework to accelerate the convergence of the standard KM iterations, and apply this algorithm to the image inpainting problem. This problem consists of reconstructing an image after part of it has been deleted (in this case a number of random pixels).
The full text is available via this link.
Installation
The package is available through pip, and may be installed via:
pip install PIKM_Inpainter

Setup
In order to run the package, an image is required. The image must imperatively be called Venice.jpeg, and be placed in the same folder as the code is executed. Examples may be found in /tests.
Main Usage
To utilize this package, you can call the getInpainted function:
getInpainted(rho, sigma, lamb, percent)

Parameters:

rho (float): Step size parameter, in the interval (0,2).
sigma (float): Regularisation parameter, positive number.
lamb (float): Relaxation parameter, in the interval (0,1).
percent (float): Percentage of pixels erased randomly in the image, in the interval (0,1).

Returns:

None

Running Experiments
Experiments are pre-coded in the library, through the function plotExperiments.
plotExperiments(rho, sigma, lamb, percent)

Parameters:
One of the parameters should be a list of parameters, which will determine the experiment.

rho (float): Step size parameter, in the interval (0,2).
sigma (float): Regularisation parameter, positive number.
lamb (float): Relaxation parameter, in the interval (0,1).
percent (float): Percentage of pixels erased randomly in the image, in the interval (0,1).

Output:

its_S (list): List of iterations required for static.
its_H (list): List of iterations required for heavy-ball.
its_N (list): List of iterations required for Nesterov.
its_R (list): List of iterations required for reflected.
time_S (list): List of times required for static.
time_H (list): List of times required for heavy-ball.
time_N (list): List of times required for Nesterov.
time_R (list): List of times required for reflected.

Experiment on Regularisation Parameter
A specific type of experiment may be run on the regularisation parameter, through the function plotExperimentRegularisation.
plotExperimentRegularisation(rho, sigmas, lamb, percent, method)

Parameters:

rho (float): Step size parameter, in the interval (0,2).
sigmas (list): List of regularisation parameters. Array must have 6 regularisation parameters.
lamb (float): Relaxation parameter, in the interval (0,1).
percent (float): Percentage of pixels erased randomly in the image, in the interval (0,1).
method (string): The chosen acceleration method. Must be one of "static", "heavyball", "nesterov" or "reflected".

Example
from PIKM_Inpainter import getInpainted
getInpainted(rho=1.8, sigma=.5, lamb=.8, percent=.5)

In this example we select a step size ρ=1.8, a regularisation parameter σ=0.5, a relaxation parameter λ=0.8, and a percentage of erased pixels of 50.
This produces the result in the following two figures.