ImageMattingAlgorithm Class Reference

#include <ImFusion/Seg/ImageMattingAlgorithm.h>

Algorithm for image matting using guided filter. More...

Inheritance diagram for ImageMattingAlgorithm:

Detailed Description

Algorithm for image matting using guided filter.

Public Member Functions
	ImageMattingAlgorithm (const SharedImageSet &imgIn, SharedImageSet &maskIn)
	Algorithm constructor.
	~ImageMattingAlgorithm () override
	Destructor.
void	setParameters (int imageSize, int kernelSize, float eps, int nbIter=1)
	Set the parameters for the guided filter.
void	setImage (const SharedImageSet *img)
	Set input image.
void	setMask (SharedImageSet *mask)
	Set input mask.
void	setInPlace (bool inplace)
	Set whether the result should be computed in place.
void	setUseGPU (bool useGPU)
	Set whether the result should be computed on the GPU or CPU.
void	configure (const Properties *p) override
	Set one or multiple properties.
void	configuration (Properties *p) const override
	Retrieve the properties of this object.
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	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.

Protected Attributes
const SharedImageSet *	m_img
	Input image.
SharedImageSet *	m_mask
	Input mask.
SharedImageSet *	m_output
	Output mask, ownership depending on m_inPlace!
bool	m_inPlace
	Flag for in-place computing.
bool	m_useGPU
	Flag for GPU computation.
int	m_gFilterImageSize
	Target dimension size for working image (no downsampling if 0)
int	m_gFilterKernelSize
	Parameters for the guided filter.
float	m_gFilterEps
	Parameters for the guided filter.
int	m_gFilterIter
	Parameters for the guided filter.
std::unique_ptr< GlGuidedFilter >	m_filter
	filtering algorithm
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.

Additional Inherited Members
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 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.
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.

Member Function Documentation

configure()

void configure ( const Properties * p )

overridevirtual

Set one or multiple properties.

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Retrieve the properties of this object.

Reimplemented from Configurable.

compute()

void compute ( )

overridevirtual

Compute the result.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

If the algorithm creates new image data, it has to be transferred here.

Reimplemented from Algorithm.

---

The documentation for this class was generated from the following file:

• ImFusion/Seg/ImageMattingAlgorithm.h