lti::drawFlowField::parameters Class Reference

the parameters for the class drawFlowField More...

#include <ltiDrawFlowField.h>

Inheritance diagram for lti::drawFlowField::parameters:

[legend]

Collaboration diagram for lti::drawFlowField::parameters:

[legend]

List of all members.

Public Types
enum	eOverlayMode { NoOverlay, OnFlowfield, OnValue, OnPhase }
enum	eVectorMode { Arrows, Lines }
enum	eScalingMode { GridWidth, NoScaling }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
int	zoomfactor
int	samplerate
float	threshold
eOverlayMode	overlayMode
eVectorMode	vectorMode
eScalingMode	scalingMode
float	linecolor
float	tipcolor

---

Detailed Description

the parameters for the class drawFlowField

---

Member Enumeration Documentation

enum lti::drawFlowField::parameters::eOverlayMode

Type for choosing overlayMode.

Enumerator:

NoOverlay	draws flow field on black background
OnFlowfield	draws flow field on channel, which is given for output
OnValue	draws flow field on internally computed value of itself
OnPhase	draws flow field on internally computed phase of itself

enum lti::drawFlowField::parameters::eScalingMode

Type for choosing ScalingMode.

Enumerator:

GridWidth	longest vector will be scaled to gridWidth
NoScaling	vectors will not be scaled in any way

enum lti::drawFlowField::parameters::eVectorMode

Type for choosing vectorMode.

Enumerator:

Arrows	draws flow vectors as arrows
Lines	draws flow vectors as lines

---

Constructor & Destructor Documentation

lti::drawFlowField::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

lti::drawFlowField::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

lti::drawFlowField::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::drawFlowField::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

parameters& lti::drawFlowField::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

const char* lti::drawFlowField::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

virtual bool lti::drawFlowField::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

virtual bool lti::drawFlowField::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

---

Member Data Documentation

float lti::drawFlowField::parameters::linecolor

Color of flow line.

linecolor = 0.0 ... 1.0 (default=0.3)

eOverlayMode lti::drawFlowField::parameters::overlayMode

overlayMode can be one of: noOverlay (default), onFlowfield, onValue, onPhase.

noOverlay = draws flow field on black background

onFlowfield = draws flow field on channel, which is handed over for output

onValue/onPhase = draws flow field on internally computed value/phase

int lti::drawFlowField::parameters::samplerate

Input channels are sampled by this factor.

samplerate = 1,2,... (default=5)

eScalingMode lti::drawFlowField::parameters::scalingMode

scalingMode can be one of: NoScaling, GridWidth(default).

NoScaling = vectors will not be scaled

GridWidth = vectors will be scaled, so that the longest one becomes as long as grid width(=samplerate*zoomfactor)

float lti::drawFlowField::parameters::threshold

If value of current samplingpoint is smaller than the percentage (given by threshold) of maximum value, flow line will not be drawn.

threshold = 0.0 ... 1.0 (default=0.1)

float lti::drawFlowField::parameters::tipcolor

Color of flow line tip.

tipcolor = 0.0 ... 1.0 (default=1.0)

eVectorMode lti::drawFlowField::parameters::vectorMode

vectorMode can be one of: arrows(default), lines.

arrows = draws flow vectors as lines

lines = draws flow vectors as arrows

int lti::drawFlowField::parameters::zoomfactor

Tells, how much larger the output flow field channel should be compared to the the input channel(s).

zoomfactor = 1,2,... (default=1)

---

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

• ltiDrawFlowField.h