lti::draw2DDistribution< T >::parameters Class Reference

the parameters for the class draw2DDistribution More...

#include <ltiDraw2DDistribution.h>

Inheritance diagram for lti::draw2DDistribution< T >::parameters:

[legend]

Collaboration diagram for lti::draw2DDistribution< T >::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
bool	write (ioHandler &handler, const bool complete=true) const
bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	coSystem
bool	scaleEqual
tpoint< float >	scale
tpoint< float >	offset
bool	autoscale
T	background
T	axisColor
std::vector< T >	palette
std::vector< char >	marker

---

Detailed Description

template<class T>
class lti::draw2DDistribution< T >::parameters

the parameters for the class draw2DDistribution

---

Constructor & Destructor Documentation

template<class T >

lti::draw2DDistribution< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::functor::parameters.

References lti::draw2DDistribution< T >::parameters::autoscale, lti::draw2DDistribution< T >::parameters::axisColor, lti::draw2DDistribution< T >::parameters::background, lti::draw2DDistribution< T >::parameters::coSystem, lti::draw2DDistribution< T >::parameters::offset, lti::draw2DDistribution< T >::parameters::scale, and lti::draw2DDistribution< T >::parameters::scaleEqual.

Referenced by lti::draw2DDistribution< T >::parameters::clone().

template<class T >

lti::draw2DDistribution< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

References lti::draw2DDistribution< T >::parameters::copy().

template<class T >

lti::draw2DDistribution< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

template<class T >

virtual functor::parameters* lti::draw2DDistribution< T >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

References lti::draw2DDistribution< T >::parameters::parameters().

template<class T >

parameters& lti::draw2DDistribution< T >::parameters::copy

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

References lti::draw2DDistribution< T >::parameters::autoscale, lti::draw2DDistribution< T >::parameters::axisColor, lti::draw2DDistribution< T >::parameters::background, lti::functor::parameters::copy(), lti::draw2DDistribution< T >::parameters::coSystem, lti::draw2DDistribution< T >::parameters::marker, lti::draw2DDistribution< T >::parameters::offset, lti::draw2DDistribution< T >::parameters::scale, and lti::draw2DDistribution< T >::parameters::scaleEqual.

Referenced by lti::draw2DDistribution< T >::parameters::operator=(), and lti::draw2DDistribution< T >::parameters::parameters().

template<class T >

const char* lti::draw2DDistribution< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

template<class T >

parameters& lti::draw2DDistribution< T >::parameters::operator=

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

References lti::draw2DDistribution< T >::parameters::copy().

template<class T >

bool lti::draw2DDistribution< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, virtual]

read the parameters from 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.

References lti::draw2DDistribution< T >::parameters::autoscale, lti::draw2DDistribution< T >::parameters::axisColor, lti::draw2DDistribution< T >::parameters::background, lti::draw2DDistribution< T >::parameters::coSystem, lti::draw2DDistribution< T >::parameters::marker, lti::draw2DDistribution< T >::parameters::offset, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), lti::draw2DDistribution< T >::parameters::scale, and lti::draw2DDistribution< T >::parameters::scaleEqual.

template<class T >

bool lti::draw2DDistribution< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [inline, 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.

References lti::draw2DDistribution< T >::parameters::autoscale, lti::draw2DDistribution< T >::parameters::axisColor, lti::draw2DDistribution< T >::parameters::background, lti::draw2DDistribution< T >::parameters::coSystem, lti::draw2DDistribution< T >::parameters::marker, lti::draw2DDistribution< T >::parameters::offset, lti::draw2DDistribution< T >::parameters::scale, lti::draw2DDistribution< T >::parameters::scaleEqual, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

bool lti::draw2DDistribution< T >::parameters::autoscale

If true, the optimal scaling factor is computed, so that all points of the distribution are in the picture.

Default true.

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

T lti::draw2DDistribution< T >::parameters::axisColor

the drawing color of the coordinate system.

Default white.

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

T lti::draw2DDistribution< T >::parameters::background

the backgroundColor of the picture.

Default black.

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

bool lti::draw2DDistribution< T >::parameters::coSystem

if true a coordiate system is drawn.

Default false.

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

std::vector<char> lti::draw2DDistribution< T >::parameters::marker

the markers for the different ids

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

tpoint<float> lti::draw2DDistribution< T >::parameters::offset

All pixels are move by this offset.

If you set both components of offset to the half of the picture size, the drawn pixels are centred. Default (400,400).

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

std::vector<T> lti::draw2DDistribution< T >::parameters::palette

the color palette for drawing

template<class T >

tpoint<float> lti::draw2DDistribution< T >::parameters::scale

the scaling factor.

Default (20,20)

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

template<class T >

bool lti::draw2DDistribution< T >::parameters::scaleEqual

if true, the axis will be scaled equal, otherwise the space is used as well as possible.

Default true.

Referenced by lti::draw2DDistribution< T >::parameters::copy(), lti::draw2DDistribution< T >::parameters::parameters(), lti::draw2DDistribution< T >::parameters::read(), and lti::draw2DDistribution< T >::parameters::write().

---

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

• ltiDraw2DDistribution.h