Resource Base
Table of contents

MultiFrameResultCrossFilter

The MultiFrameResultCrossFilter class is responsible for filtering captured results. As a default implementation of CapturedResultFilter, it provides results verification and duplicate results filtering features.

Definition

Module: dynamsoft_utility

Inheritance: CapturedResultFilter -> MultiFrameResultCrossFilter

class MultiFrameResultCrossFilter(dynamsoft_capture_vision_router.CapturedResultFilter)

Methods

Method Description
__init__ Initializes a new instance of the MultiFrameResultCrossFilter class.
enable_result_cross_verification Enable result cross verification feature to improve the accuracy of video streaming recognition results.
is_result_cross_verification_enabled Determines whether the result cross verification feature is enabled for the specific captured result item type.
enable_result_deduplication Enable result deduplication feature to filter out the duplicate results in the period of duplicateForgetTime for video streaming recognition.
is_result_deduplication_enabled Determines whether the result deduplication feature is enabled for the specific result item type.
set_duplicate_forget_time Sets the duplicate forget time for the specific captured result item types.
get_duplicate_forget_time Gets the duplicate forget time for a specific captured result item type.
set_max_overlapping_frames Sets the max referencing frames count for the to-the-latest overlapping feature.
get_max_overlapping_frames Gets the max referencing frames count for the to-the-latest overlapping feature.
enable_latest_overlapping Enables the to-the-latest overlapping feature. The output captured result will become a combination of the recent results if the latest frame is proved to be similar with the previous.
is_latest_overlapping_enabled Determines whether the to-the-latest overlapping feature is enabled for the specific result item type.

__init__

Initializes a new instance of the MultiFrameResultCrossFilter class.

def __init__(self):

enable_result_cross_verification

Enable result cross verification feature to improve the accuracy of video streaming recognition results.

def enable_result_cross_verification(self, result_item_types: int, enabled: bool) -> None:

Parameters

result_item_types A bitwise OR combination of one or more values from the EnumCapturedResultItemType enumeration.

enabled Set whether to enable result verification.

See Also

EnumCapturedResultItemType

is_result_cross_verification_enabled

Determines whether the result cross verification feature is enabled for the specific captured result item type.

def is_result_cross_verification_enabled(self, type: int) -> bool:

Parameters

type The specific captured result item type. It is a value from the EnumCapturedResultItemType enumeration.

Return Value

Returns a bool value indicating whether result verification is enabled for the specific captured result item type.

See Also

EnumCapturedResultItemType

enable_result_deduplication

Enable result deduplication feature to filter out the duplicate results in the period of duplicateForgetTime for video streaming recognition.

def enable_result_deduplication(self, result_item_types: int, enabled: bool) -> None:

Parameters

result_item_types A bitwise OR combination of one or more values from the EnumCapturedResultItemType enumeration.

enabled Set whether to enable result result deduplication.

See Also

EnumCapturedResultItemType

is_result_deduplication_enabled

Determines whether the result deduplication feature is enabled for the specific result item type.

def is_result_deduplication_enabled(self, type: int) -> bool:

Parameters

type The specific captured result item type. It is a value from the EnumCapturedResultItemType enumeration.

Return Value

Returns a bool value indicating whether result deduplication is enabled for the specific result item type.

See Also

EnumCapturedResultItemType

set_duplicate_forget_time

Sets the duplicate forget time for the specific captured result item types. The same captured result item will be returned only once during the period if deduplication feature is enabled. The default value is 3000ms.

def set_duplicate_forget_time(self, result_item_types: int, time: int) -> None:

Parameters

result_item_types A bitwise OR combination of one or more values from the EnumCapturedResultItemType enumeration.

time The duplicate forget time measured in milliseconds. The value rang is [1, 180000].

See Also

EnumCapturedResultItemType

get_duplicate_forget_time

Gets the duplicate forget time for a specific captured result item type.

def get_duplicate_forget_time(self, type: int) -> int:

Parameters

type The specific captured result item type. It is a value from the EnumCapturedResultItemType enumeration.

Return Value

Returns the duplicate forget time for the specific captured result item type.

See Also

EnumCapturedResultItemType

set_max_overlapping_frames

Sets the max referencing frames count for the to-the-latest overlapping feature.

def set_max_overlapping_frames(self, result_item_types: int, max_overlapping_frames: int) -> None:

Parameters

[in] result_item_types The or value of the captured result item types.

[in] max_overlapping_frames The max referencing frames count for the to-the-latest overlapping feature.

See Also

EnumCapturedResultItemType

get_max_overlapping_frames

Gets the max referencing frames count for the to-the-latest overlapping feature.

def get_max_overlapping_frames(self, type: int) -> int:

Parameters

[in] type Specifies a specific result item type, which can be defined using EnumCapturedResultItemType.

Return value

Returns the max referencing frames count for the to-the-latest overlapping feature.

See Also

EnumCapturedResultItemType

enable_latest_overlapping

Enables the to-the-latest overlapping feature. The output captured result will become a combination of the recent results if the latest frame is proved to be similar with the previous.

def enable_latest_overlapping(self, result_item_types: int, enabled: bool) -> None:

Parameters

[in] result_item_types The or value of the captured result item types.
[in] enabled Sets whether to enable the to-the-latest overlapping feature.

See Also

EnumCapturedResultItemType

is_latest_overlapping_enabled

Determines whether the to-the-latest overlapping feature is enabled for the specific result item type.

def is_latest_overlapping_enabled(self, type: int) -> bool:

Parameters

[in] type The specific captured result item type.

Return value

Returns a bool value indicating whether the to-the-latest overlapping feature is enabled for the specific result item type.

See Also

EnumCapturedResultItemType

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

latest version

    Change +