IDS peak ICV v1.5.0
Loading...
Searching...
No Matches
Inheritance diagram for IGain:

Public Member Functions

float master (self)
 Retrieves the current master gain value.
 
None master (self, float value)
 Sets the master gain value.
 
float red (self)
 Retrieves the gain value for the red channel.
 
None red (self, float value)
 Sets the gain value for the red channel.
 
float green (self)
 Retrieves the gain value for the green channel.
 
None green (self, float value)
 Sets the gain value for the green channel.
 
float blue (self)
 Retrieves the gain value for the blue channel.
 
None blue (self, float value)
 Sets the gain value for the blue channel.
 

Detailed Description

Interface for modules that provide gain control functionality.

A gain module consists of a master gain value applied to all channels, along with individual gain values for the red, green, and blue channels.

Since
ids_peak_common 1.1

Member Function Documentation

◆ blue() [1/2]

float blue ( self)

Retrieves the gain value for the blue channel.

Returns
The blue channel gain value.
Since
ids_peak_common 1.1

◆ blue() [2/2]

None blue ( self,
float value )

Sets the gain value for the blue channel.

Parameters
valueThe gain value for the blue channel.
Since
ids_peak_common 1.1

◆ green() [1/2]

float green ( self)

Retrieves the gain value for the green channel.

Returns
The green channel gain value.
Since
ids_peak_common 1.1

◆ green() [2/2]

None green ( self,
float value )

Sets the gain value for the green channel.

Parameters
valueThe gain value for the green channel.
Since
ids_peak_common 1.1

◆ master() [1/2]

float master ( self)

Retrieves the current master gain value.

Returns
The master gain value.
Since
ids_peak_common 1.1

◆ master() [2/2]

None master ( self,
float value )

Sets the master gain value.

This value is applied uniformly to all color channels.

Parameters
valueThe master gain value to apply.
Since
ids_peak_common 1.1

◆ red() [1/2]

float red ( self)

Retrieves the gain value for the red channel.

Returns
The red channel gain value.
Since
ids_peak_common 1.1

◆ red() [2/2]

None red ( self,
float value )

Sets the gain value for the red channel.

Parameters
valueThe gain value for the red channel.
Since
ids_peak_common 1.1