 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Base/ImageInpaintingAlgorithm.h>
Algorithm that inpaints a masked area of an image. More...
Inheritance diagram for ImageInpaintingAlgorithm:Algorithm that inpaints a masked area of an image.
By default the algorithm will inpaint the areas with mask value == 0, if the parameter p_invertMask is true then the algorithm will inpaint the areas with mask value != 0. The algorithm uses normalized convolutions for inpainting, that means that given an image x, a mask m and a convolution function c() the output of the algorithm is c(x) / (c(m) + eps) where m == 0 and x everywhere else. The convolution filter could be a Gaussian (supported on both CPU and GPU), a box filter or a sum of Gaussians. The "sum of Gaussians" filter is constructed by summing different Gaussians filters with sigma parameters going from 1 to p_kernelSizePix / 3. The idea is that such filter will give more importance to nearby pixels, resulting in less pronounced edges between the image and the inpainted area.
Public Types | |
| enum | InpaintingMethod { NORMALIZED_CONVOLUTION = 0 , NORMALIZED_CONVOLUTION_GAUSSIAN = 0 , NORMALIZED_CONVOLUTION_BOX = 1 , NORMALIZED_CONVOLUTION_GAUSSIAN_GPU = 2 , NORMALIZED_CONVOLUTION_GAUSSIAN_SUM_GPU = 3 , NR_METHODS = 4 } |
| Enum for inpainting method. More... | |
| Public Types inherited from Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
Public Member Functions | |
| ImageInpaintingAlgorithm (SharedImage &imgIn, SharedImage *mask=nullptr) | |
| ImageInpaintingAlgorithm (SharedImageSet &img, SharedImage *mask=nullptr) | |
| ImageInpaintingAlgorithm (std::vector< SharedImage * > images, SharedImage *mask=nullptr) | |
| void | setKernelSize (int kernelSizePix) |
| Set the Gaussian kernel size. | |
| void | setInPlace (bool inplace) |
| Set whether the result should be computed in place. | |
| void | compute () override |
| Compute the result. | |
| OwningDataList | takeOutput () override |
| If the algorithm creates new image data, it has to be transferred here. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a) |
| If data is compatible with algorithm return true. If a is not zero, create algorithm with input data. | |
| Static Public Member Functions inherited from Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Public Attributes | |
| Parameter< InpaintingMethod > | p_method = {"method", NORMALIZED_CONVOLUTION_GAUSSIAN, this} |
| Parameter< int > | p_kernelSizePix = {"kernelSizePix", 31, this} |
| Parameter< bool > | p_createNew = {"createNew", true, this} |
| Parameter< bool > | p_invertMask = {"invertMask", false, this} |
| Public Attributes inherited from Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute() | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
| enum InpaintingMethod |
Enum for inpainting method.
|
overridevirtual |
Compute the result.
Implements Algorithm.
|
overridevirtual |
If the algorithm creates new image data, it has to be transferred here.
Reimplemented from Algorithm.
