ConvolutionKernel.h

Go to the documentation of this file.

#if !defined CONVOLUTION_KERNEL_
#define CONVOLUTION_KERNEL_
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------

namespace mudbox {

class ConvolutionKernel {
    private:
        float      *m_Kernel;        // floating point version.
        short      *m_fixedKernel;   // fixed point version S4.11
        int         m_Size;          // always square

        bool        m_Generated;     // true if the kernel is generated
                                     // by the following parameters.
        float       m_Sharpness;
        float       m_Radius;
        float       m_Sigma;

        void        Generate(void);  // generate the FP kernel from the 3 parms
        void        makeFixed(void); // generate the fixed point kernel from the FP one

    public:
        ConvolutionKernel(const ConvolutionKernel &k);

        ConvolutionKernel(float *kernel, int size);

        ConvolutionKernel(float sharpness = 0.5f,
                          float radius    = 1.5f,
                          float sigma     = (1.0f/3.0f));

        ~ConvolutionKernel();

        void  setSharpness(float val);
        void  setRadius(float val);
        void  setSigma(float val);

        void  setKernel(float *f, int Size);

        float getSharpness()     const { return m_Sharpness; }
        float getRadius()        const { return m_Radius;    }
        float getSigma()         const { return m_Sigma;     }

        bool  isGenerated(void)  const { return m_Generated; }

        int   getSize (void)     const { return m_Size; }

        void         getKernel(float *targetBuffer) const;

        const float *getKernel(void) const      { return m_Kernel; }

        const short *getFixedKernel(void) const { return m_fixedKernel; }

        void         logPrintKernel(void) const;
};

//-----------------------------------------------------------------------------

//-
// ==================================================================
// (C) Copyright 2009 by Autodesk, Inc. All Rights Reserved. By using
// this code,  you  are  agreeing  to the terms and conditions of the
// License  Agreement  included  in  the documentation for this code.
// AUTODESK  MAKES  NO  WARRANTIES,  EXPRESS  OR  IMPLIED,  AS TO THE
// CORRECTNESS OF THIS CODE OR ANY DERIVATIVE WORKS WHICH INCORPORATE
// IT.  AUTODESK PROVIDES THE CODE ON AN 'AS-IS' BASIS AND EXPLICITLY
// DISCLAIMS  ANY  LIABILITY,  INCLUDING CONSEQUENTIAL AND INCIDENTAL
// DAMAGES  FOR ERRORS, OMISSIONS, AND  OTHER  PROBLEMS IN THE  CODE.
//
// Use, duplication,  or disclosure by the U.S. Government is subject
// to  restrictions  set forth  in FAR 52.227-19 (Commercial Computer
// Software Restricted Rights) as well as DFAR 252.227-7013(c)(1)(ii)
// (Rights  in Technical Data and Computer Software),  as applicable.
// ==================================================================
//+
#endif

}; // end of namespace mudbox