cvr::viewer2DPainter::viewer2DPainter::parameters Class Reference

Parameters of the cvr::viewer2DPainter class. More...

#include <cvrViewer2DPainter.h>

Inheritance diagram for cvr::viewer2DPainter::viewer2DPainter::parameters:

[legend]

Collaboration diagram for cvr::viewer2DPainter::viewer2DPainter::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
float	zoom
eMappingType	mappingType
float	offset
float	slope
vector< ubyte >	userMapping
bool	hexadecimal
rgbaPixel	underflowColor
rgbaPixel	overflowColor
ePaletteType	paletteType
palette	userPalette
bool	labelAdjacency
eNeighborhoodType	adjacencyNeighborhood
bool	minAdjacencyColors

---

Detailed Description

Parameters of the cvr::viewer2DPainter class.

---

Constructor & Destructor Documentation

cvr::viewer2DPainter::viewer2DPainter::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

cvr::viewer2DPainter::viewer2DPainter::parameters::parameters

(

const parameters &

other

)

Copy constructor.

virtual cvr::viewer2DPainter::viewer2DPainter::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

---

Member Function Documentation

virtual parameters* cvr::viewer2DPainter::viewer2DPainter::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

parameters& cvr::viewer2DPainter::viewer2DPainter::parameters::copy

(

const parameters &

other

)

Copy data of "other" parameters.

virtual const std::string& cvr::viewer2DPainter::viewer2DPainter::parameters::name

(

)

const [virtual]

Returns the name of this class.

Implements cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

virtual parameters* cvr::viewer2DPainter::viewer2DPainter::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

parameters& cvr::viewer2DPainter::viewer2DPainter::parameters::operator=

(

const parameters &

other

)

Copy data of "other" parameters.

virtual bool cvr::viewer2DPainter::viewer2DPainter::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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 cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

virtual bool cvr::viewer2DPainter::viewer2DPainter::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 cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

---

Member Data Documentation

eNeighborhoodType cvr::viewer2DPainter::viewer2DPainter::parameters::adjacencyNeighborhood

Neighborhood type for the adjacency analysis.

Default value: FourNeighborhood

bool cvr::viewer2DPainter::viewer2DPainter::parameters::hexadecimal

Should the data in the status bar be displayed in hexadecimal or in decimal notation.

Default value: false

bool cvr::viewer2DPainter::viewer2DPainter::parameters::labelAdjacency

Label adjacency analysis.

If true, then the channel8 or channel32 being displayed will be assumed to be a labeled mask, and an adjacency analysis will be done to improve the visualization of adjacent regions.

Default value: false

eMappingType cvr::viewer2DPainter::viewer2DPainter::parameters::mappingType

Type of mapping used for the intensity of the data.

Default value: Original

bool cvr::viewer2DPainter::viewer2DPainter::parameters::minAdjacencyColors

If labelAdjacency is true, this flag indicates if the number of used colors should be minimal (the first items in the userPalette) or all colors in userPalette can be used.

Default value: true;

float cvr::viewer2DPainter::viewer2DPainter::parameters::offset

Offset used if the linear mapping is chosen.

This is the b value in a mx+b equation.

The value given here is normalized, which means that a value of 1 indicates an offset of the whole value range (1.0 for cvr::channel and 255 for channel8 or images). In other words, you want here usually values between -1.0 and 1.0.

Default value: 0

rgbaPixel cvr::viewer2DPainter::viewer2DPainter::parameters::overflowColor

Color used for an overflow.

The linear maps used can produce data outside the expected ranges. If the values are below the lowest valid value, this color will be used instead.

Default value: Red

ePaletteType cvr::viewer2DPainter::viewer2DPainter::parameters::paletteType

Palette type to be used or channel to be mapped.

If you

Default value: GrayPalette

float cvr::viewer2DPainter::viewer2DPainter::parameters::slope

Slope used if the linear mapping is chosen.

This is the m value in a mx+b equation.

Default value: 1

rgbaPixel cvr::viewer2DPainter::viewer2DPainter::parameters::underflowColor

Color used for an underflow.

The linear maps used can produce data outside the expected ranges. If the values are above the highest valid value, this color will be used instead.

Default value: Blue

vector<ubyte> cvr::viewer2DPainter::viewer2DPainter::parameters::userMapping

User defined curve, given as a LUT.

Default value: a linear mapping

palette cvr::viewer2DPainter::viewer2DPainter::parameters::userPalette

Used defined color palette.

It is used as a palette for representation of channels (ubyte, float and int), but also as the palette for the label adjacency representations.

Default value: labelAdjacencyMap::defaultPalette

float cvr::viewer2DPainter::viewer2DPainter::parameters::zoom

Zoom factor.

The zoom functor is simply a scale factor used for each pixel. You can interpret it as the number of pixels used per pixel.

Values greater than one indicate a zoom-in factor, where the value indicates the number of displayed pixels for each image pixel.

Values smaller than one indicate a zoom-out factor, where only each 1/zoom pixel is shown.

This values have to be positive and different than zero.

Default value: 1.0

---

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

• cvrViewer2DPainter.h