poIImagePlane SetFilterMode

Syntax

Imageplane_handle SetFilterModemode

Application

HyperView Tcl Modify

Description

The image plane offers several image post-processing filters that can be applied on the image or video. This command sets/changes the filter mode being used for the image plane.

Inputs

mode: The filter mode name. Valid values are returned by GetFilterModeList. They are different for each filter type.; For the Edge filter type - valid values are: Prewitt, Laplacian, and Sobel. Each represents a different edge detection algorithm.; For the ColorAlpha filter type - valid mode values are: equal, lesserthan, and greaterthan. These work in conjunction with SetColorAlphaTarget to define a color target. In lesserthan mode, any values less than the specified target color are made transparent. In greaterthan mode, any values greater than the specified target color are made transparent. In equal mode, any values within the target color and specified tolerance are made transparent. The tolerance is specified by calling SetColorAlphaTolerance.

Context

Example

To create one image plane, and use the edge detection filter to draw the edges in black, and then use the color alpha filter to remove all “white” from the image (making those areas of the image transparent):

Note: The image plane without the filter is shown in Figure 1 (below). The image plane with the edge detection filter active is shown in Figure 2 (below).

hwi OpenStack
if {[catch {
    ::post::GetPostHandle client_handle
    hwi GetSessionHandle session_handle
    client_handle GetImagePlaneCtrlHandle ipc_handle
    set ipid1 [ipc_handle AddImagePlane Logo1]
    ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
    imageplane_handle SetFileName g:/samples2/VideoOverlay/Altair_logo.jpg
    imageplane_handle SetMode background
    imageplane_handle SetCrop 0 0 0.9995 0.995
    imageplane_handle SetFilterType ColorAlpha;
    imageplane_handle SetFilterMode equal;
    imageplane_handle SetColorAlphaTarget "255 255 255"
    imageplane_handle SetColorAlphaTolerance 18
    imageplane_handle SetMipMapMode Linear1
    puts "  Filter Type: [imageplane_handle GetFilterType]";
    puts "  Filter Mode: [imageplane_handle GetFilterMode]";
    puts "  Alpha Color Target: [imageplane_handle GetColorAlphaTarget]";
    puts "  Alpha Color Tolerance: [imageplane_handle GetColorAlphaTolerance]";
    puts "  MipMap Mode: [imageplane_handle GetMipMapMode]";
    client_handle Draw
} result]} {
    global errorInfo;
    puts stderr $result;
    puts "[session_handle GetError]";
    puts stderr "*** Tcl TRACE ***";
    puts stderr $errorInfo;
} else {
    puts "No errors.";
    puts "Warnings: ";
    puts "    [session_handle GetError]";
}

hwi CloseStack

The image plane without the filter is shown in Figure 3. The image plane with the filter active is shown in Figure 4.

Error

Returns HW_InvalidHandle if the image plane handle is invalid, or poIInvalidImgFilterMode if an unexpected error occurred while processing the specified media file.