ProcAlg Class Reference

The base class of an image processing algorithm. More...

#include <procAlg.h>

Inheritance diagram for ProcAlg:

[legend]List of all members.

Public Slots
virtual void	processFrame (QImage *frame)=0
	The slot that should be called to do the actual image processing.
Signals
void	imageReady (QImage *frame)
	Signal of completed frame.
void	foundObstacle (threatType type, trendDir dir, int relalt, int x_ang, int y_vec, unsigned long &key)
	Signal of obtacle found.
void	foundOther ()
	Signal that indicates an obstacle of type 'other' was found.
void	foundProximate ()
	Signal that indicates an obstacle of type 'proximate' was found.
void	foundIntruding ()
	Signal that indicates an obstacle of type 'intruding' was found.
void	foundReal ()
	Signal that indicates an obstacle of type 'real' was found.
void	videoMessage (QString *msg)
	Send a message to the video display.
void	displayMessage (QString *msg)
	This sends a message to the other displays.
Public Member Functions
QString	getName ()
	Returns the name of this algorithm.
Protected Attributes
QString	algName
	The name of the algorithm.

---

Detailed Description

The base class of an image processing algorithm.

This class should be derived from when creating a custom image processing algorithm to be integrated into the VisualODF framework.

It should be noted that the signal "foundObstacle" has two distinct uses:

1) For location-aware classes, the trendDir is set to ascending/descending and the x and y positions are known.

2) For non-location aware classes, the trendDir is set to "none" and the x_ang and y_vec variables are set to angular values, not x and y positions.

Definition at line 22 of file procAlg.h.

---

Member Function Documentation

void ProcAlg::displayMessage

(

QString *

msg

)

[signal]

This sends a message to the other displays.

Referenced by TestAlg::processFrame().

void ProcAlg::foundIntruding

(

)

[signal]

Signal that indicates an obstacle of type 'intruding' was found.

Referenced by TestAlg::processFrame().

void ProcAlg::foundObstacle	(	threatType	type,
		trendDir	dir,
		int	relalt,
		int	x_ang,
		int	y_vec,
		unsigned long &	key
	)			[signal]

Signal of obtacle found.

When an obstacle has been detected, this signal is emitted to indicate that to any other classes that may be listening.

Parameters:

	type	The type of threat.
	dir	The direction (ascending, descending, or none). None must be used if the obstacle information is to be used in a class/widget that is not aware of the location of the obstacle (distance) relative to the aircraft. If it is not set to none, then the obstacle information will be assumed to be for a class/widget that is location-aware.
	relalt	The obstacle altitude relative to the aircraft.
	x_ang	Either the x position (location aware) or the angle of the obstacle relative to the aircraft.
	y_vec	Either the y position (location aware) or the angle of the orientation of the threat.
	key	The key value of the threat. This is needed when one wants to remove the threat, for example.

Referenced by TestAlg::processFrame().

void ProcAlg::foundOther

(

)

[signal]

Signal that indicates an obstacle of type 'other' was found.

Referenced by TestAlg::processFrame().

void ProcAlg::foundProximate

(

)

[signal]

Signal that indicates an obstacle of type 'proximate' was found.

Referenced by TestAlg::processFrame().

void ProcAlg::foundReal

(

)

[signal]

Signal that indicates an obstacle of type 'real' was found.

Referenced by TestAlg::processFrame().

QString ProcAlg::getName

(

)

[inline]

Returns the name of this algorithm.

Definition at line 29 of file procAlg.h.

References algName.

Referenced by obstDet::algToggle(), and obstDet::obstDet().

void ProcAlg::imageReady

(

QImage *

frame

)

[signal]

Signal of completed frame.

When an image has been processed and is ready, this signal should be emitted.

Referenced by TestAlg::processFrame().

virtual void ProcAlg::processFrame

(

QImage *

frame

)

[pure virtual, slot]

The slot that should be called to do the actual image processing.

This slot is connected to a signal emitted by the frameServer whenever a frame is available. This ensures that regardless of whether we are using a video data file or a live video input, we have access to the current frame (whether it is being aquired live or being played back).

Parameters:

frame

The frame to be processed.

Implemented in TestAlg.

void ProcAlg::videoMessage

(

QString *

msg

)

[signal]

Send a message to the video display.

This sends a message related to the video display.

---

Member Data Documentation

QString ProcAlg::algName [protected]

The name of the algorithm.

This should be set so that programs have a name to reference each instance.

Definition at line 97 of file procAlg.h.

Referenced by getName(), and TestAlg::TestAlg().

---

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

• procAlg.h

---