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 ICImagingControl.FrameFilterCreate or ICImagingControl.FrameFilterCreateString.
Example
The following example illustrates how to create an instance of the first available frame filter and set it as device frame filter:
' Retrieve the first FrameFilterInfo object. Dim info As FrameFilterInfo Set info = ICImagingControl1.FrameFilterInfos(1) ' Create the frame filter to which the info object refers. Dim filter As FrameFilter Set filter = ICImagingControl1.FrameFilterCreate(info) ' Set the frame filter as the device frame filter. ICImagingControl1.DeviceFrameFilters.Add filter ' Start live mode. ICImagingControl1.LiveStart
Information
Introduced in IC Imaging Control 3.0
Properties
| Property | Description | ||
| AvailableParameters | Returns a list, containing the names of the available frame filter parameters. |
||
| Data | Returns or sets a blob of raw data. |
||
| DataSize | Returns the size of the array returned by FrameFilter.Data. |
||
| 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. |
||
| Parameter | Sets or gets the value of a parameter. |
||
Methods
| Method | Description | ||
| BeginParameterTransfer | BeginParameterTransfer and EndParameterTransfer synchronize the access to a frame filter's parameters. |
||
| EndParameterTransfer | BeginParameterTransfer and EndParameterTransfer synchronize the access to a frame filter's parameters. |
||
| LoadFilterData | Loads filter settings from a file. |
||
| SaveFilterData | Saves the current values of all parameters of this filter in a file. |
||
| ShowDialog | Displays a dialog that lets the user configure the filter. |
||
