SaturationFeature Class Reference

Inheritance diagram for SaturationFeature:

Public Member Functions
None	__init__ (self, ColorMatrixTransformationModule module)
	Creates a SaturationFeature for an existing color matrix transformation module.
bool	enabled (self)
	Gets whether this feature is currently enabled.
None	enabled (self, bool enabled)
	Enables or disables the feature.
None	reset_to_default (self)
	Resets the saturation to its default value (1.0).
float	value (self)
	Gets the current saturation value.
None	value (self, float saturation)
	Sets the saturation value.
Interval	range (self)
	Gets the valid range for the saturation.

Protected Attributes
	_module = module

Detailed Description

Adjusts the saturation of an image by modifying a 3x3 color correction matrix.

Supported pixel formats

BGR8 BGRa8 RGB8 RGBa8 BGR10 BGRa10 RGB10 RGBa10 BGR12 BGRa12

RGB12 RGBa12

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

This feature modifies the image's color saturation by scaling the chrominance components of the color correction matrix. A higher saturation makes colors more vivid, while a lower value results in more muted tones.

The default value for saturation is 1.0.

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		ColorMatrixTransformationModule	module )

Creates a SaturationFeature for an existing color matrix transformation module.

Parameters

module

Reference to the underlying module

Since

ids_peak_icv 1.0

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Gets whether this feature is currently enabled.

Returns

True if enabled; otherwise False.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

enabled() [2/2]

None enabled	(		self,
		bool	enabled )

Enables or disables the feature.

Parameters

enabled

True to enable, False to disable.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

range()

Interval range

(

self

)

Gets the valid range for the saturation.

The returned interval specifies the minimum and maximum values that can be passed to value property.

Returns

An Interval representing the valid saturation range.

Since

ids_peak_icv 1.0

reset_to_default()

None reset_to_default

(

self

)

Resets the saturation to its default value (1.0).

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

value() [1/2]

float value

(

self

)

Gets the current saturation value.

Returns

The current saturation value.

Since

ids_peak_icv 1.0

value() [2/2]

None value	(		self,
		float	saturation )

Sets the saturation value.

Parameters

saturation

A floating-point value representing the saturation value. A value of 1.0 means no change, values greater than 1.0 increase saturation, and values less than 1.0 decrease saturation. Valid values are within the range returned by range property.

:raise OutOfRangeException: If saturation is outside the valid range.

Since

ids_peak_icv 1.0

Field Documentation

_module

_module = module

protected