poIImagePlane GetFilterTypeList

Gets the types of image post-processing filters available for image planes.

Syntax

Imageplane_handle GetFilterTypeList

Application

HyperView Tcl Query

Description

The image plane offers several image post-processing filters that can be applied on the image or video. This command returns the filter types available for image planes.

Console Output:

********
Image Plane Filter Types and Modes
Filter Type None: 
  Filter Modes: 
Filter Type Edge: 
  Filter Modes: Prewitt Laplacian Sobel
Filter Type ColorAlpha: 
  Filter Modes: Equal Lesserthan Greaterthan
********
No errors.
Warnings:

Example

To create one image plane, and then query it for available filter types and modes:
hwi OpenStack
if {[catch {
    hwi GetSessionHandle session_handle
    session_handle GetProjectHandle project_handle
    project_handle GetPageHandle page_handle [project_handle GetActivePage]
    page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
    window_handle GetClientHandle client_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 SetLabel "Company Logo";
    set filterTypes [imageplane_handle GetFilterTypeList];
    puts "********";
    puts "Image Plane Filter Types and Modes";
    foreach fType $filterTypes {
        puts "Filter Type $fType: ";
        set filterModes [imageplane_handle GetFilterModeList $fType];
        puts "  Filter Modes: $filterModes";
    }
    puts "********";
    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

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.