FrameFilter

FrameFilter is the class provides the interface to a filter that was loaded from a filter module. It contains methods to access the filter's parameters, display a configuration dialog and save filter settings.

To create a frame filter, use FrameFilter.Create.

FrameFilter is the base class of all frame filters. It contains methods to access the filter's parameters, display a configuration dialog and save filter settings. This class provides the interface to use an existing filter.

Example

The following example illustrates how to create an instance of the first available frame filter and set it as device frame filter:

[C#]
// Retrieve the first FrameFilterInfo object.
FrameFilterInfo info = ICImagingControl1.FrameFilterInfos[0];
// Create the frame filter to which the info object refers.
FrameFilter filter = ICImagingControl1.FrameFilterCreate(info);
// Set the  frame filter as the device frame filter.
ICImagingControl1.DeviceFrameFilters.Add(filter);
// Start live mode.
ICImagingControl1.LiveStart();

Information

Namespace: TIS.Imaging
Introduced in version 3.0

Properties

	Property		Description


	AvailableParameters		Returns a list, containing the names of the available frame filter parameters.

	FilterData		This property returns an XML formatted string, containing the current values of all parameters of this filter.

	FilterInfo		Returns the FrameFilterInfo describing this filter.

	HasDialog		Returns whether this frame filter has a built-in dialog that allows the user to modify the filter's parameters.

	Name		Returns the name of this frame filter.

Methods

	Method		Description


	BeginParameterTransfer		BeginParameterTransfer and EndParameterTransfer synchronize the access to a frame filter's parameters.

	Create		Creates an instance of a FrameFilter

	EndParameterTransfer		BeginParameterTransfer and EndParameterTransfer synchronize the access to a frame filter's parameters.

	GetBoolParameter		Gets a boolean parameter.

	GetDataParameter		Gets a string parameter.

	GetFloatParameter		Gets a float parameter.

	GetIntParameter		Gets an integer parameter.

	GetStringParameter		Gets a string parameter.

	LoadFilterData		Loads filter settings from a file.

	SaveFilterData		Saves the current values of all parameters of this filter in a file.

	SetBoolParameter		Sets an boolean parameter.

	SetDataParameter		Sets an data parameter.

	SetFloatParameter		Sets an float parameter.

	SetIntParameter		Sets an integer parameter.

	SetStringParameter		Sets an string parameter.

	ShowDialog		Displays a dialog that lets the user configure the filter.

<< Classes