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)
	Indicates whether the feature is currently enabled.
None	enabled (self, bool value)
	Enables or disables the feature.
None	reset_to_default (self)
	Resets the saturation value to 1.0.
float	value (self)
	Gets the current saturation value.
None	value (self, float saturation)
	Sets the saturation value.
Interval	range (self)
	Retrieves 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

Definition at line 8 of file saturation_feature.py.

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

Definition at line 25 of file saturation_feature.py.

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Indicates whether the feature is currently enabled.

Returns

True if enabled; otherwise, False.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 36 of file saturation_feature.py.

enabled() [2/2]

None enabled	(		self,
		bool	value )

Enables or disables the feature.

Parameters

value

Set to True to enable the feature, or False to disable it.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 47 of file saturation_feature.py.

range()

Interval range

(

self

)

Retrieves 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

Definition at line 95 of file saturation_feature.py.

reset_to_default()

None reset_to_default

(

self

)

Resets the saturation value to 1.0.

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 57 of file saturation_feature.py.

value() [1/2]

float value

(

self

)

Gets the current saturation value.

Returns

The saturation value currently set.

Since

ids_peak_icv 1.0

Definition at line 69 of file saturation_feature.py.

value() [2/2]

None value	(		self,
		float	saturation )

Sets the saturation value.

Parameters

saturation

A floating-point value representing the saturation value. 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

Definition at line 80 of file saturation_feature.py.

Field Documentation

_module

_module = module

protected

Definition at line 33 of file saturation_feature.py.