ObservationParameters

The ObservationParameters class is used to set filter conditions for the IntermediateResultReceiver, so that only intermediate results meeting specific conditions will be called back.

Definition

Module: dynamsoft_core

class ObservationParameters 

Methods

set_observed_result_unit_types

Sets the types of intermediate result units that have been observed.

def set_observed_result_unit_types(self, types: int) -> None:

Parameters

types The observed types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

get_observed_result_unit_types

Gets the types of intermediate result units that have been observed.

def get_observed_result_unit_types(self) -> int:

Return value

The observed types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

is_result_unit_type_observed

Determines whether the specified result unit type was observed.

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

Parameters

type The type of intermediate result units. This is one of the values of the EnumIntermediateResultUnitType enumeration.

Return value

Returns a boolean value indicating whether the specified result unit type was observed.

See Also

EnumIntermediateResultUnitType

add_observed_task

Adds observed task name to be notified when relevant results are available.

def add_observed_task(self, task_name: str) ->None:

Parameters

task_name The specified task name.

remove_observed_task

Remove the observed task name so that intermediate results generated by the task are not notified.

def remove_observed_task(self, task_name: str) -> None:

Parameters

task_name The specified task name.

is_task_observed

Determines whether the specified task was observed.

def is_task_observed(self, task_name: str) -> bool:

Parameters

task_name The specified task name.

Return value

Returns a boolean value indicating whether the specified task was observed.

set_result_unit_types_only_for_input

Sets the types of intermediate result unit that indicates skipping default calculations and replacing with input data units.

def set_result_unit_types_only_for_input(self, types: int) -> None:

Parameters

types: The types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

get_result_unit_types_only_for_input

Gets the types of intermediate result unit that indicates skipping default calculations and replacing with input data units.

def get_result_unit_types_only_for_input(self) -> int:

Return

Returns the types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

is_result_unit_type_only_for_input

Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

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

Parameters

type: The type of intermediate result unit to check. This is one of the values of the EnumIntermediateResultUnitType enumeration.

Return

Returns a boolean value indicating whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

See Also

EnumIntermediateResultUnitType