GainOffsetKneeChannelParameters Class Reference

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

Inheritance diagram for GainOffsetKneeChannelParameters:

Public Member Functions
synchronized void	delete ()
PropertyF	getGain ()
	A float property that contains the channel specific gain to be applied to the selected channel of the image.
PropertyF	getOffset_pc ()
	A float property that contains the channel specific offset (in percent) to be applied to the selected channel of the image.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	GainOffsetKneeChannelParameters (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (GainOffsetKneeChannelParameters obj)

Protected Attributes
transient boolean	swigCMemOwn

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

GainOffsetKneeChannelParameters()

GainOffsetKneeChannelParameters ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getGain()

PropertyF getGain

(

)

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.

getOffset_pc()

PropertyF getOffset_pc

(

)

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.

hObj()

int hObj ( )

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()

ComponentCollection restoreDefault ( )

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( GainOffsetKneeChannelParameters obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited