Celartem::ImageUtils::SmoothScaleParam Struct Reference

#include <pxl_imageparam.h>

Inheritance diagram for Celartem::ImageUtils::SmoothScaleParam:

[legend]

List of all members.

Public Member Functions
	SmoothScaleParam (ssize_t inWidth=0, ssize_t inHeight=0, double inSmoothLevel=1.0, const String &inMode="Final", size_t inInfluence=8, size_t inAmplitude=5)
	SmoothScaleParam (const Size &inDim, double inSmoothLevel=1.0, const String &inMode="Final", size_t inInfluence=8, size_t inAmplitude=5)
Public Attributes
Size	dim
	Output image's dimensions in pixels.
double	smoothLevel
	Strength of the smoothness (0.1 - 2.0), default value is 1.0.
String	mode
	Output mode; "Final" or "Base". "Base" to output the input image directly.
size_t	influence
	It must be within 0-10, default is 8.
size_t	amplitude
	The strength of the contrast. It must be within 0-10, default is 5.

---

Detailed Description

This structure is used to set the parameter of the Image instance which is created by SmoothScale function.

See also:

SmoothScale, Image Parameter Structures, ImageParam, Scale

Definition at line 188 of file pxl_imageparam.h.

---

Constructor & Destructor Documentation

Celartem::ImageUtils::SmoothScaleParam::SmoothScaleParam	(	ssize_t	inWidth = 0,
		ssize_t	inHeight = 0,
		double	inSmoothLevel = 1.0,
		const String &	inMode = "Final",
		size_t	inInfluence = 8,
		size_t	inAmplitude = 5
	)			[inline]

This constructor initializes the structure with the specified parameters.

Parameters:

	inWidth	The output width of the image in pixels.
	inHeight	The output height of the image in pixels.
	inSmoothLevel	Strength of the smoothness (0.1 - 2.0), default value is 1.0.
	inMode	Output mode; "Final" or "Base". "Base" to output the input image directly.
	inInfluence	It must be within 0-10, default is 8.
	inAmplitude	The strength of the contrast. It must be within 0-10, default is 5.

Definition at line 215 of file pxl_imageparam.h.

Celartem::ImageUtils::SmoothScaleParam::SmoothScaleParam	(	const Size &	inDim,
		double	inSmoothLevel = 1.0,
		const String &	inMode = "Final",
		size_t	inInfluence = 8,
		size_t	inAmplitude = 5
	)			[inline]

This constructor initializes the structure with the specified parameters.

Parameters:

	inDim	The dimensions of the output image in pixels.
	inSmoothLevel	Strength of the smoothness (0.1 - 2.0), default value is 1.0.
	inMode	Output mode; "Final" or "Base". "Base" to output the input image directly.
	inInfluence	It must be within 0-10, default is 8.
	inAmplitude	The strength of the contrast. It must be within 0-10, default is 5.

Definition at line 247 of file pxl_imageparam.h.

---

Member Data Documentation

Size Celartem::ImageUtils::SmoothScaleParam::dim

Output image's dimensions in pixels.

Definition at line 190 of file pxl_imageparam.h.

double Celartem::ImageUtils::SmoothScaleParam::smoothLevel

Strength of the smoothness (0.1 - 2.0), default value is 1.0.

Definition at line 191 of file pxl_imageparam.h.

String Celartem::ImageUtils::SmoothScaleParam::mode

Output mode; "Final" or "Base". "Base" to output the input image directly.

Definition at line 192 of file pxl_imageparam.h.

size_t Celartem::ImageUtils::SmoothScaleParam::influence

It must be within 0-10, default is 8.

Definition at line 193 of file pxl_imageparam.h.

size_t Celartem::ImageUtils::SmoothScaleParam::amplitude

The strength of the contrast. It must be within 0-10, default is 5.

Definition at line 194 of file pxl_imageparam.h.

---

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

• pxl_imageparam.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:34 2008.