mvIMPACT Acquire SDK C++
GainOffsetKneeChannelParameters Class Reference

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

Inheritance diagram for GainOffsetKneeChannelParameters:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

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

Protected Attributes

HOBJ m_hRoot
 

Friends

class ImageProcessing
 

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.

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

const ComponentCollection& restoreDefault ( void  ) const
inlineinherited

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.

Friends And Related Function Documentation

◆ ImageProcessing

friend class ImageProcessing
friend

Member Data Documentation

◆ gain

PropertyF gain

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.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ offset_pc

PropertyF offset_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.


The documentation for this class was generated from the following file: