goFilter1D Class Reference

Separable filter for 3D signals. More...

#include <gofilter1d.h>

Public Member Functions
	goFilter1D (const goArray< goFloat > &mask, goIndex_t center=0, bool normalize=true)
	Constructor, setting the mask and center. More...
	goFilter1D (const goFloat *mask, goIndex_t length, goIndex_t center=0, bool normalize=true)
	Constructor, setting the mask and center. More...
	goFilter1D (const goMath::Vector< goFloat > &mask, goIndex_t center=0, bool normalize=true)
bool	setMask (const goArray< goFloat > &mask)
	Set the filter mask. More...
bool	setMask (const goMath::Vector< goFloat > &mask)
bool	setMask (const goFloat *mask, goIndex_t length)
	Set filter mask. More...
bool	setCenter (goIndex_t c)
	Set the center of the filter mask. More...
bool	filter (goSignal3DBase< void > &sig)
	Apply the filter in-place. More...
bool	filter (goMath::Matrixf &m, int direction=0)
bool	filter (goMath::Matrixd &m, int direction=0)
bool	normalize (goDouble constant=1.0)
	Normalize the filter mask. More...
Public Member Functions inherited from goObjectBase
	goObjectBase ()
	Constructor.
virtual	~goObjectBase ()
	Destructor. More...
const char *	getClassName () const
	Returns the class name. More...
int	getClassID () const
virtual goSize_t	memoryUsage () const
	Returns the size of this object or some measure of its memory consumption. More...
void	setObjectName (const char *name)
	Set name string for an object. More...
void	setObjectName (const goString &name)
	Set name string for an object. More...
const goString &	getObjectName () const
	Get the object name. More...
virtual bool	writeObjectFile (FILE *) const
	Write object to a file. More...
virtual bool	readObjectFile (FILE *)
	Read object from a file. More...
void	connectObject (goObjectBase *object)
	Connects an object to this object. More...
void	disconnectObject (const goObjectBase *object)
	Disconnects an object from this object.
virtual bool	callObjectMethod (int methodID, goObjectMethodParameters *param=NULL)
	Call an object method by identifier. More...
virtual bool	queueObjectMethod (int methodID, goObjectMethodParameters *param=NULL, bool blocking=false)
	Enqueue a method call to an internal list of methods. More...
bool	callQueuedMethods ()
	Call all queued methods. More...

Additional Inherited Members
Protected Member Functions inherited from goObjectBase
void	setClassID (int id)
	Sets the class name.
void	printClassMessage (const char *msg)
	Sets the class name. More...
void	printClassMessage (goString &msg)
	Prints an informational message to the calling console. More...
void	sendObjectMessage (int messageID, void *data=NULL)
	Sends a message to all connected objects.
void	sendObjectMessage (goObjectBase *object, int messageID, void *data=NULL)
	Sends a message to a specific object.
virtual void	receiveObjectMessage (const goObjectMessage &message)
	Receive a message. More...

Detailed Description

Separable filter for 3D signals.

Applies a separable filter to a goSignal3DBase<void>. Note that this filter class was not implemented for typed instances of goSignal3DBase. You should not use typed versions anymore anyway.

Usage would be like this:

 
     ...
     goSignal3D<void> sig;
     ...
     goArray<goFloat> mask;
     mask += 1.0f;
     mask += 2.0f;
     mask += 1.0f;
     goFilter1D filter;
     filter.setMask   (mask);  // Set the mask
     filter.setCenter (1);     // Set center to the entry "2"
     filter.normalize ();      // Normalize the mask
     filter.filter    (sig);   // Filter in-place
     ...
 

Returns

Constructor & Destructor Documentation

goFilter1D() [1/2]

goFilter1D::goFilter1D	(	const goArray< goFloat > &	mask,
		goIndex_t	center = 0,
		bool	normalize = true
	)

Constructor, setting the mask and center.

Parameters

mask	Array with mask values.
center	Center of the mask.
normalize	If true, the mask is normalized to one.

goFilter1D() [2/2]

goFilter1D::goFilter1D	(	const goFloat *	mask,
		goIndex_t	length,
		goIndex_t	center = 0,
		bool	normalize = true
	)

Constructor, setting the mask and center.

Parameters

mask	Pointer to mask values.
length	Length of the mask.
center	Center of the mask.
normalize	If true, the mask is normalized to one.

Member Function Documentation

filter()

bool goFilter1D::filter

(

goSignal3DBase< void > &

sig

)

Apply the filter in-place.

Parameters

sig	Signal to apply the filter to.

Returns

True if successful, false otherwise.

normalize()

bool goFilter1D::normalize

(

goDouble

constant = 1.0

)

Normalize the filter mask.

Parameters

constant

Constant to normalize to. Default is 1.0.

Returns

True if successful, false otherwise.

setCenter()

bool goFilter1D::setCenter

(

goIndex_t

c

)

Set the center of the filter mask.

Parameters

c	Center index.

Returns

True if successful, false otherwise.

setMask() [1/2]

bool goFilter1D::setMask

(

const goArray< goFloat > &

m

)

Set the filter mask.

Note

If the mask is not normalized, you can do that by calling this->normalize().

Parameters

m	Float array containing the mask.

Returns

True if successful, false otherwise.

setMask() [2/2]

bool goFilter1D::setMask	(	const goFloat *	mask,
		goIndex_t	length
	)

Set filter mask.

Sets the filter mask. Note that you need to set the filter centre with setCenter().

Parameters

mask	Pointer to the mask data. Must not be null.
length	Length of the mask. Must be larger than zero.

Returns

True if successful, false otherwise.

---

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

• gofilter1d.h
• gofilter1d.cpp