IlvMorphologyFilter Class Reference

Morphology filter. More...

#include <ilviews/bitmaps/filters/morphology.h>

Inheritance diagram for IlvMorphologyFilter:

Public Types
enum	Operator { Erode, Dilate }

Public Member Functions
	IlvMorphologyFilter (IlUInt radiusX=0, IlUInt radiusY=0, Operator op=Erode)
	Constructor. More...
	~IlvMorphologyFilter ()
	Destructor. More...
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **inputs=0)
	Applies the morphology to the given image.
Operator	getOperator () const
	Returns the mode of the filter. More...
IlUInt	getRadiusX () const
	Returns the width of the kernel. More...
IlUInt	getRadiusY () const
	Returns the height of the kernel. More...
void	setOperator (Operator op)
	Sets the operator for this instance. More...
void	setRadiusX (IlUInt radius)
	Sets the width of the kernel. More...
void	setRadiusY (IlUInt radius)
	Sets the height of the kernel. More...
Public Member Functions inherited from IlvBitmapFilter
	IlvBitmapFilter ()
	Constructor. More...
virtual	~IlvBitmapFilter ()
	Destructor. More...
IlvBitmapData *	applyUnary (const IlvBitmapData *data)
	Convenience method for unary filters. More...
virtual const char *	getClassName () const
	Returns the class name of the filter. More...
IlUInt	getHeight () const
	Returns the height of the filter effect region. More...
const char *const *	getInputs (IlUInt &count) const
	Returns the name of the input bitmap data. More...
const char *	getName () const
	Returns the name of the filter. More...
IlUInt	getRefCount () const
	Returns the reference count for this instance.
const char *	getResult () const
	Returns the name of the result bitmap data. More...
IlUInt	getWidth () const
	Returns the width of the filter effect region. More...
IlInt	getX () const
	Returns the left coordinate of the filter effect region. More...
IlInt	getY () const
	Returns the top coordinate of the filter effect region. More...
void	lock ()
	Locks the current instance.
void	setHeight (IlUInt height)
	Sets the height of the filter effect region. More...
void	setInputs (IlUInt count, const char *const *name)
	Sets the input names of the filter. More...
void	setName (const char *id)
	Sets the name of the filter. More...
void	setResult (const char *name)
	Sets the result name of the filter. More...
void	setWidth (IlUInt width)
	Sets the width of the filter effect region. More...
void	setX (IlInt x)
	Sets the left coordinate of the filter effect region. More...
void	setY (IlInt y)
	Sets the top coordinate of the filter effect region. More...
void	unLock ()
	Unlocks the current instance. When the reference count is 0, the instance is deleted.
Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...
virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...
virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...
virtual void	getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
	Retrieves the list of available accessors of an object. More...
virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...
virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapFilter
static IlvBitmapFilter *	Create (const char *classname, IlBoolean forceLoad=IlTrue)
	This static method creates an instance of a bitmap filter of given classname. If the filter class is not registered and forceLoad is IlTrue, an attempt to load a dynamic module for this filter is made. More...
static const char **	GetRegisteredFilters (IlUInt &num)
	This static method returns an array of registered filter class names. More...

Detailed Description

Morphology filter.

Library: ilvbmpflt

This bitmap filter lets you perform fattening or thinning on an image. This filter uses a kernel to compute component-wise minimum or maximum values to set the new component value.

See also

IlvRGBBitmapData, IlvBitmapFilter

Member Enumeration Documentation

Operator

enum IlvMorphologyFilter::Operator

This enumeration defines the possible values for the operation mode.

Enumerator
Erode	Erode The filter erodes (thins) the source image. This is the default.
Dilate	Dilate The filter dilates (fattens) the source image.

Constructor & Destructor Documentation

IlvMorphologyFilter()

IlvMorphologyFilter::IlvMorphologyFilter	(	IlUInt	radiusX = 0,
		IlUInt	radiusY = 0,
		Operator	op = Erode
	)

Constructor.

Initializes a new instance of the class IlvMorphologyFilter.

Parameters

radiusX	The morphology radius in the x dimension.
radiusY	The morphology radius in the y dimension.
op	The morphology operator.

~IlvMorphologyFilter()

IlvMorphologyFilter::~IlvMorphologyFilter

(

)

Destructor.

The destructor releases all the memory used by the instance.

Member Function Documentation

getOperator()

Operator IlvMorphologyFilter::getOperator

(

)

const

Returns the mode of the filter.

Returns

The mode of the filter.

getRadiusX()

IlUInt IlvMorphologyFilter::getRadiusX

(

)

const

Returns the width of the kernel.

Returns

The width of the kernel.

getRadiusY()

IlUInt IlvMorphologyFilter::getRadiusY

(

)

const

Returns the height of the kernel.

Returns

The height of the kernel.

setOperator()

void IlvMorphologyFilter::setOperator

(

Operator

op

)

Sets the operator for this instance.

Parameters

op	The new morphology operator.

setRadiusX()

void IlvMorphologyFilter::setRadiusX

(

IlUInt

radius

)

Sets the width of the kernel.

Parameters

radius

The new width of the kernel.

setRadiusY()

void IlvMorphologyFilter::setRadiusY

(

IlUInt

radius

)

Sets the height of the kernel.

Parameters

radius

The new width of the kernel.