mudbox::ConvolutionKernel Class Reference

#include <ConvolutionKernel.h>


Public Member Functions
	ConvolutionKernel (const ConvolutionKernel &k)
	copy constructor
	ConvolutionKernel (float *kernel, int size)
	user specified arbitrary size x size kernel.
	ConvolutionKernel (float sharpness=0.5f, float radius=1.5f, float sigma=(1.0f/3.0f))
	construct a procedurally generated kernel (as described above)
	~ConvolutionKernel ()
	destructor. Releases memory
void	setSharpness (float val)
void	setRadius (float val)
void	setSigma (float val)
void	setKernel (float *f, int Size)
	Copies the supplied kernel into this class.
float	getSharpness () const
float	getRadius () const
float	getSigma () const
bool	isGenerated (void) const
	true if procedurally generated, false otherwise
int	getSize (void) const
	the size of the kernel (width and height are the same)
void	getKernel (float *targetBuffer) const
	copies the kernel to the target buffer which must be appropriately sized
const float *	getKernel (void) const
	a pointer to the kernel (in 32 bit float format)
const short *	getFixedKernel (void) const
void	logPrintKernel (void) const
	Prints the convolution kernel to the log. (for debugging purposes).

Constructor & Destructor Documentation

mudbox::ConvolutionKernel::ConvolutionKernel

(

const ConvolutionKernel &

)

copy constructor

mudbox::ConvolutionKernel::ConvolutionKernel	(	float *	kernel,
		int	size
	)

user specified arbitrary size x size kernel.

The ctor copies the kernel into this class.

mudbox::ConvolutionKernel::ConvolutionKernel	(	float	sharpness = `0.5f`,
		float	radius = `1.5f`,
		float	sigma = `(1.0f/3.0f)`
	)

construct a procedurally generated kernel (as described above)

mudbox::ConvolutionKernel::~ConvolutionKernel

(

)

destructor. Releases memory

Member Function Documentation

void mudbox::ConvolutionKernel::setSharpness

(

float

val

)

void mudbox::ConvolutionKernel::setRadius

(

float

val

)

void mudbox::ConvolutionKernel::setSigma

(

float

val

)

void mudbox::ConvolutionKernel::setKernel	(	float *	f,
		int	Size
	)

Copies the supplied kernel into this class.

float mudbox::ConvolutionKernel::getSharpness ( ) const [inline]

00126 { return m_Sharpness; }

float mudbox::ConvolutionKernel::getRadius ( ) const [inline]

00127 { return m_Radius;    }

float mudbox::ConvolutionKernel::getSigma ( ) const [inline]

00128 { return m_Sigma;     }

bool mudbox::ConvolutionKernel::isGenerated ( void ) const [inline]

true if procedurally generated, false otherwise

00131 { return m_Generated; }

int mudbox::ConvolutionKernel::getSize ( void ) const [inline]

the size of the kernel (width and height are the same)

00134 { return m_Size; }

void mudbox::ConvolutionKernel::getKernel

(

float *

targetBuffer

)

const

copies the kernel to the target buffer which must be appropriately sized

const float* mudbox::ConvolutionKernel::getKernel ( void ) const [inline]

a pointer to the kernel (in 32 bit float format)

00140 { return m_Kernel; }

const short* mudbox::ConvolutionKernel::getFixedKernel ( void ) const [inline]

Returns:: a pointer to the 16 bit fixed point kernel in S4.11 format

Note:: The Fixed kernel is made up of fixed point signed numbers in the form S4.11. This was chosen because the procedurally generated kernel will always be expressable in this form as long as the sharpness is in the range -1 to 10.

00148 { return m_fixedKernel; }

void mudbox::ConvolutionKernel::logPrintKernel

(

void

)

const

Prints the convolution kernel to the log. (for debugging purposes).

mudbox::ConvolutionKernel Class Reference

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation