lti::viewer::parameters Class Reference

The parameters for the class viewer. More...

#include <ltiViewer.h>

Inheritance diagram for lti::viewer::parameters:

[legend]

Collaboration diagram for lti::viewer::parameters:

[legend]

List of all members.

Public Types
enum	eDefaultPalette { Gray, Hue, Red, Green, Blue, UserDefined }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
const char *	getTypeName () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
General parameters

rgbPixel	overflowColor
rgbPixel	underflowColor
int	zoomFactor
float	contrast
float	brightness
bool	showValue
bool	showHex
Options for monochromatic channels

eDefaultPalette	whichPalette
palette	colors
bool	labelAdjacencyMap
bool	neighborhood8
bool	useFewColors
Options for vectors and histograms

int	vectorHeight
int	pixelsPerElement
bool	useBoxes
bool	useLines
rgbPixel	backgroundColor
rgbPixel	lineColor
bool	drawHorizontalAxis
bool	drawMeanValues
Informational Parameters

point	size
float	minI
float	maxI
float	averageI
rgbPixel	minRGB
rgbPixel	maxRGB
trgbPixel< float >	averageRGB
float	stdDeviation
trgbPixel< float >	diagCovariance

Detailed Description

The parameters for the class viewer.

These parameters control the way an image or channel is displayed. You can also use them to generate with the lti::viewerFunctor images as shown by the lti::viewer.

Member Enumeration Documentation

enum lti::viewer::parameters::eDefaultPalette

Predefined color palettes for the channel and channel8 display.

Enumerator:

Gray	Gray Palette.
Hue	Hue Palette.
Red	Red Palette.
Green	Green Palette.
Blue	Blue Palette.
UserDefined	User Defined Palette.

Constructor & Destructor Documentation

lti::viewer::parameters::parameters ( )

default constructor

Reimplemented from lti::viewerBase::parameters.

lti::viewer::parameters::parameters ( const parameters & other )

copy constructor

Reimplemented from lti::viewerBase::parameters.

virtual lti::viewer::parameters::~parameters ( ) [virtual]

destructor

Reimplemented from lti::viewerBase::parameters.

Member Function Documentation

virtual functor::parameters* lti::viewer::parameters::clone ( ) const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::viewerBase::parameters.

parameters& lti::viewer::parameters::copy ( const parameters & other )

copy member

Reimplemented from lti::viewerBase::parameters.

const char* lti::viewer::parameters::getTypeName ( ) const [virtual]

returns name of this type

Reimplemented from lti::viewerBase::parameters.

parameters& lti::viewer::parameters::operator= ( const parameters & other )

copy data of "other" parameters

Reimplemented from lti::viewerBase::parameters.

virtual bool lti::viewer::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 lti::viewerBase::parameters.

virtual bool lti::viewer::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::viewerBase::parameters.

Member Data Documentation

float lti::viewer::parameters::averageI

intensity average

trgbPixel<float> lti::viewer::parameters::averageRGB

RGB average.

rgbPixel lti::viewer::parameters::backgroundColor

Background color.

See also:: lineColor, underflowColor, overflowColor

Default value: Black

float lti::viewer::parameters::brightness

Add the given value to the intensity channel.

Independent of the type of image or channel used, 1.0 means the complete intensity range.

Default value: 0.0

palette lti::viewer::parameters::colors

if the data to be show is a channel or channel8, then the color palette specified here will be used if whichPalette is UserDefined.

The default is a grey values palette.

float lti::viewer::parameters::contrast

Parameter to control the constrast of the displayed image.

+2.0 Use all the dynamic range. This is the maximum possible contrast, without losing any information of the normal intensity value range (due to underflow or overflow).
+1.0 means keep the original image contrast.
0.0 Zero contrast (a gray value)
-1.0 produce the negative of the image using the original value range.
-2.0 Use all the dynamic range to generate the negative of the shown image.

Default value: 1.0

trgbPixel<float> lti::viewer::parameters::diagCovariance

square root of the diagonal of covariance matrix

bool lti::viewer::parameters::drawHorizontalAxis

Show axis.

If true, the horizontal axis (value 0) will be drawn using the color given in underflowColor.

Default value: true

bool lti::viewer::parameters::drawMeanValues

Show mean values.

If true, the mean value of the elements and the mean value of the indices will be drawn using the color given by overflowColor

Default value: false

bool lti::viewer::parameters::labelAdjacencyMap

for integer images, consider them as a label-mask and use only a few colors to appreciate the different labeled regions in a better way.

See also:: labelAdjacencyMap

Default value: false

rgbPixel lti::viewer::parameters::lineColor

Line color.

See also:: backgroundColor, underflowColor, overflowColor

Default value: White

float lti::viewer::parameters::maxI

maximum intensity value

rgbPixel lti::viewer::parameters::maxRGB

maximum RGB components

float lti::viewer::parameters::minI

minimum intensity value

rgbPixel lti::viewer::parameters::minRGB

minimum RGB components

bool lti::viewer::parameters::neighborhood8

If labelAdjacencyMap is true, indicate if an 8-Neighborhood (true) or a 4-Neighborhood (false) between the regions exist.

Default value: 4-Neighborhood (i.e. false);

rgbPixel lti::viewer::parameters::overflowColor

color of the overflow values.

For vectors and 1D histograms, this is used to draw the mean value of the elements and the mean index value.

The default is Yellow

int lti::viewer::parameters::pixelsPerElement

Number of pixels per element or per histogram bin used.

Default value: 1 pixel

bool lti::viewer::parameters::showHex

if showHex is true, then the RGB value will be displayed in hex.

Default value: false

bool lti::viewer::parameters::showValue

if showValue is true, then the color or channel value will be displayed in a status bar.

Default value: true

point lti::viewer::parameters::size

Size of the matrix, image or vector.

float lti::viewer::parameters::stdDeviation

standard deviation

rgbPixel lti::viewer::parameters::underflowColor

color of the underflow values.

For vectors and 1D histograms, this is used as the axis color.

The default is Blue

bool lti::viewer::parameters::useBoxes

Used to specify if the elements of the vector or bins of histogram1D s should be represented with boxes or with points.

If false, points will represent each cell:

  |
  |           .
  |           |
  |        .  |           .
  |        |  |     .     |
  |  .     |  |  .  |     |
  |  |  .  |  |  |  |  .  |
  .  |  |  |  |  |  |  |  |
  |__|__|__|__|__|__|__|__|____

If true, boxes will be used:

  |
  |           .__
  |           |  |
  |        .__|  |        .__
  |        |  |  |  .__   |  |
  |  .__   |  |  .__|  |  |  |
  |  |  .__|  |  |  |  .__|  |
  .__|  |  |  |  |  |  |  |  |
  |__|__|__|__|__|__|__|__|__|_

Default value: true (i.e. boxes will be displayed)

bool lti::viewer::parameters::useFewColors

If labelAdjacencyMap is true, indicate if all colors in the user defined palette should be used or only the first ones.

Default value: false (i.e. use all colors in the palette if possible)

bool lti::viewer::parameters::useLines

show the lines between the coordinate system and the points should be drawn.

If true, (and with useBoxes=false) the result will be like the one on the left side.

  |                               |
  |           .                   |           .
  |           |                   |
  |        .  |           .       |        .              .
  |        |  |     .     |       |                 .
  |  .     |  |  .  |     |       |  .           .
  |  |  .  |  |  |  |  .  |       |     .              .
  .  |  |  |  |  |  |  |  |       .
  |__|__|__|__|__|__|__|__|____   |____________________________

Default value: false

int lti::viewer::parameters::vectorHeight

Number of pixels used at the y-coordinate of the vector or histogram1D representation.

Default value: 256

eDefaultPalette lti::viewer::parameters::whichPalette

Which palette should be used?

Default value: Gray

int lti::viewer::parameters::zoomFactor

zoom factor of the window.

The scale factor is 2^zoomFactor. Only values between -4 and 4 are valid.

Default value: 0

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