lti::viewerBase Class Reference

Abstract class parent for all viewer objects in the LTI-Lib. More...

#include <ltiViewerBase.h>

Inheritance diagram for lti::viewerBase:

[legend]

Collaboration diagram for lti::viewerBase:

[legend]

List of all members.

Classes
class	invalidParametersException
	Exception thrown when the parameters are not set. More...
class	parameters
	Base class for all lti parameter objects. More...
Public Member Functions
	viewerBase ()
	viewerBase (const viewerBase &other)
virtual	~viewerBase ()
virtual const char *	getTypeName () const
virtual bool	show (const image &data)=0
virtual bool	show (const channel8 &data)
virtual bool	show (const channel &data)
virtual bool	show (const matrix< float > &data)
virtual bool	show (const vector< double > &data)
virtual bool	show (const vector< float > &data)
virtual bool	show (const vector< int > &data)
virtual bool	show (const matrix< double > &data)
virtual bool	show (const matrix< int > &data)
virtual bool	hide ()=0
viewerBase &	copy (const viewerBase &other)
viewerBase &	operator= (const viewerBase &other)
virtual viewerBase *	clone () const =0
const parameters &	getParameters () const
parameters &	getParameters ()
virtual bool	setParameters (const parameters &param)
virtual bool	useParameters (parameters &param)
virtual bool	validParameters () const
virtual const char *	getStatusString () const
virtual void	setStatusString (const char *msg) const

---

Detailed Description

Abstract class parent for all viewer objects in the LTI-Lib.

---

Constructor & Destructor Documentation

lti::viewerBase::viewerBase

(

)

default constructor

lti::viewerBase::viewerBase

(

const viewerBase &

other

)

copy constructor

virtual lti::viewerBase::~viewerBase

(

)

[virtual]

destructor

---

Member Function Documentation

virtual viewerBase* lti::viewerBase::clone

(

)

const [pure virtual]

returns a pointer to a clone of the functor.

Implemented in lti::externViewer, lti::histogramViewer, lti::scene3DViewer, lti::viewer, and lti::viewerBase3D.

viewerBase& lti::viewerBase::copy

(

const viewerBase &

other

)

copy data of "other" functor.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::scene3DViewer, lti::viewer, and lti::viewerBase3D.

parameters& lti::viewerBase::getParameters

(

)

returns used parameters

Reimplemented in lti::viewer, and lti::viewerBase3D.

const parameters& lti::viewerBase::getParameters

(

)

const

returns used parameters

Reimplemented in lti::externViewer, lti::histogramViewer, lti::scene3DViewer, lti::viewer, and lti::viewerBase3D.

virtual const char* lti::viewerBase::getStatusString

(

)

const [virtual]

return the last message set with setStatusString().

This will never return 0. If no status-string has been set yet an empty string (pointer to a string with only the char(0)) will be returned.

virtual const char* lti::viewerBase::getTypeName

(

)

const [virtual]

returns the name of this type ("viewerBase")

Reimplemented from lti::object.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::scene3DViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::hide

(

)

[pure virtual]

hides the display window

Returns:

true if successful, false otherwise.

Implemented in lti::externViewer, lti::viewer, and lti::viewerBase3D.

viewerBase& lti::viewerBase::operator=

(

const viewerBase &

other

)

copy data of "other" functor.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::scene3DViewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::setParameters

(

const parameters &

param

)

[virtual]

set the parameters to be used.

This object makes a copy of the given object and manages the memory of the copy

Reimplemented in lti::viewer, and lti::viewerBase3D.

virtual void lti::viewerBase::setStatusString

(

const char *

msg

)

const [virtual]

set a status string.

Parameters:

msg

the const string to be reported next time by getStatusString(). The given string will be copied. This message will be usually set within the apply methods to indicate an error cause.

Note that the change of the status string is not considered as a change in the functor status.

virtual bool lti::viewerBase::show

(

const matrix< int > &

data

)

[virtual]

shows a matrix of integers as a channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const matrix< double > &

data

)

[virtual]

shows a matrix of doubles as a channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const vector< int > &

data

)

[virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const vector< float > &

data

)

[virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const vector< double > &

data

)

[virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const matrix< float > &

data

)

[virtual]

shows a channel or matrix of float

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const channel &

data

)

[virtual]

shows a channel or matrix of float

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const channel8 &

data

)

[virtual]

shows a 8-bit channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented in lti::externViewer, lti::histogramViewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::show

(

const image &

data

)

[pure virtual]

shows a color image.

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Implemented in lti::externViewer, lti::histogramViewer, lti::viewer, and lti::viewerBase3D.

virtual bool lti::viewerBase::useParameters

(

parameters &

param

)

[virtual]

set the parameters to be used.

Just a reference to the given object is done. The memory managment must be done outside this object.

Usually the viewers provide GUI to specify the parameters, that is why the given reference is not const.

virtual bool lti::viewerBase::validParameters

(

)

const [virtual]

returns true if the parameters are valid

---

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

• ltiViewerBase.h