IConvolutionKernel2d.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#ifndef iipr_IConvolutionKernel2d_included
#define iipr_IConvolutionKernel2d_included
 
 
// ICF includes
#include <istd/istd.h>
#include <istd/CIndex2d.h>
#include <iser/ISerializable.h>
 
 
namespace iipr
{
 
 
class IConvolutionKernel2d: virtual public iser::ISerializable
{
public:
    enum SeparationType
    {
        ST_AUTO,
        ST_HOR_VERT
    };
 
    virtual istd::CIndex2d GetKernelSize() const = 0;
 
    virtual void SetKernelSize(const istd::CIndex2d& kernelSize, double value = 0.0) = 0;
 
    virtual double GetKernelElement(const istd::CIndex2d& index) const = 0;
 
    virtual bool SetKernelElement(const istd::CIndex2d& index, double value) = 0;
 
    virtual double GetOffsetValue() const = 0;
    virtual bool SetOffsetValue(double offset) = 0;
 
    virtual bool GetCombinedKernel(const IConvolutionKernel2d& kernel, IConvolutionKernel2d& result) const = 0;
    virtual bool TrySeparateKernels(IConvolutionKernel2d& result1, IConvolutionKernel2d& result2, int separationType = ST_AUTO, double tolerance = I_BIG_EPSILON) const = 0;
};
 
 
} // namespace iipr
 
 
#endif // !iipr_IConvolutionKernel2d_included