GainOffsetKneeChannelParameters Class Reference

Properties for configuring settings belonging to a certain channel of the GainOffsetKnee filter. More...

Inheritance diagram for GainOffsetKneeChannelParameters:

Public Member Functions
	__init__ (self, *args, **kwargs)
	hObj (self)
	Returns a unique identifier for the component collection referenced by this object.
	restoreDefault (self)
	Restores the default for every component of this collection.

Properties
	gain = property(lib_mvIMPACT_acquire.GainOffsetKneeChannelParameters_gain_get, doc=)
	A float property that contains the channel specific gain to be applied to the selected channel of the image.
	offset_pc = property(lib_mvIMPACT_acquire.GainOffsetKneeChannelParameters_offset_pc_get, doc=)
	A float property that contains the channel specific offset (in percent) to be applied to the selected channel of the image.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Properties for configuring settings belonging to a certain channel of the GainOffsetKnee filter.

First the master offset will be added to all channels of the image, then each channels individual gain factor will be applied to the pixel of each channel and finally the channel specific offset will be added.

Note

Objects of this class can't be constructed directly. Its parameters can be accessed via an instance of a class derived from mvIMPACT.acquire.ImageProcessing.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Member Function Documentation

hObj()

hObj ( self )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

restoreDefault ( self )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

Property Documentation

gain

gain = property(lib_mvIMPACT_acquire.GainOffsetKneeChannelParameters_gain_get, doc=)

static

A float property that contains the channel specific gain to be applied to the selected channel of the image.

This gain will be applied after the master offset but before the channel specific offset.

offset_pc

offset_pc = property(lib_mvIMPACT_acquire.GainOffsetKneeChannelParameters_offset_pc_get, doc=)

static

A float property that contains the channel specific offset (in percent) to be applied to the selected channel of the image.

This offset will be applied after the channel specific gain.

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static