ORBKeypointMatcherOptions

giant.image_processing.feature_matchers:

class giant.image_processing.feature_matchers.ORBKeypointMatcherOptions(ratio_threshold=0.9, flann_index_algorithm_type=FLANNIndexAlgorithmType.FLANN_INDEX_LSH, flann_algorithm_parameters=<factory>, flann_search_parameters=<factory>, orb_options=<factory>)

Options for configuring the ORB keypoint matcher

Parameters:

• ratio_threshold (float)

• flann_index_algorithm_type (FLANNIndexAlgorithmType)

• flann_algorithm_parameters (FLANNIndexAutotunedParams | FLANNIndexCompositeParams | FLANNIndexHierarchicalParams | FLANNIndexKdTreeParams | FLANNIndexKdTreeSingleParams | FLANNIndexKMeansParams | FLANNIndexLinearParams | FLANNIndexLSHParams)

• flann_search_parameters (FLANNSearchParams)

• orb_options (ORBOptions)

property options_dict: Dict

Determine the options input to the dataclass.

This property method will ignore all internal properties and functions

ratio_threshold: float = 0.9

The threshold to use in Lowe’s ratio test

flann_search_parameters: FLANNSearchParams

The parameters to configure how FLANN performs searches

orb_options: ORBOptions

Options used to configure cv2.ORB.create() which configures how keypoints are detected and described

flann_index_algorithm_type: FLANNIndexAlgorithmType = 6

What FLANN algorithm to use.

For ORB, FLANN_INDEX_LSH is recommended

flann_algorithm_parameters: FLANNIndexAutotunedParams | FLANNIndexCompositeParams | FLANNIndexHierarchicalParams | FLANNIndexKdTreeParams | FLANNIndexKdTreeSingleParams | FLANNIndexKMeansParams | FLANNIndexLinearParams | FLANNIndexLSHParams

The parameters to configure the index in FLANN.

This should match the flann_index_algorithm_type although OpenCV will not complain if it doesn’t.

Summary of Methods

apply_options	Update the options as attributes of the object class
local_vars	this is used to overwrite options in variables only used in __init__
override_options	This method is used for special cases when certain options should be overwritten