CVBpy 15.0
SearchParameters Class Reference

Definition of search parameters. More...

Inherits object.

Properties

 derivative_patch_size = property
 int: Get or set smoothing area in pixels for gradient and normal calculation. More...
 
 hypotheses_threshold = property
 float: Get or set minimum feature score for hypotheses generation. More...
 
 icp_max_iterations = property
 int: Get or set the maximum number of iterations of the ICP algorithm. More...
 
 icp_shrink = property
 int: Get or set the subsample factor for ICP. More...
 
 indifferent_radius = property
 float: Get or set fraction of template size which accounts for a single object. More...
 
 max_inconsistency = property
 float: Get or set maximum inconsistency. More...
 
 max_occlusion = property
 float: Get or set maximum occlusion. More...
 
 min_coverage = property
 float: Get or set minimum coverage. More...
 
 min_score = property
 float: Get or set minimum score. More...
 
 parts_to_find = property
 int: Get or set the maximum number of objects to find. More...
 
 precision_threshold = property
 float: Get or set precision threshold. More...
 
 raw_results_only = property
 bool: Get or set the raw results flag. More...
 

Detailed Description

Definition of search parameters.

Search parameters strongly influence the search results. Likewise, they havegreat influence on the timing of a search operation.

Default search parameters.

Property Documentation

◆ derivative_patch_size

derivative_patch_size = property
static

int: Get or set smoothing area in pixels for gradient and normal calculation.

This value controls which local environment in the depth image is used to calculate gradients and normals. Minimum is 3. Larger values result in a smoothing of the depth image. This value should be odd. Typical values are in the range 3..9.

◆ hypotheses_threshold

hypotheses_threshold = property
static

float: Get or set minimum feature score for hypotheses generation.

This value controls which areas of the depth image are used as candidates for closer examination. The feature score is calculated from the correspondences of gradients and normals between all models and the actual point cloud data. The threshold should be chosen so that on the one hand all object candidates are found, on the other hand as few false candidates as possible are generated. Typical values are in the range between 0.9 ... 1.0. Disturbances in the point cloud, missing or spurious data may make it necessary to reduce the value. The minimum value is 0.5. To find a usable threshold it is recommended to set the flag SearchParameters.raw_results_only.

◆ icp_max_iterations

icp_max_iterations = property
static

int: Get or set the maximum number of iterations of the ICP algorithm.

This value specifies the maximum number of iterations of the ICP algorithm. Increasing the value may increase the accuracy of the result, while possibly increasing the processing time. A typical value is 10.

◆ icp_shrink

icp_shrink = property
static

int: Get or set the subsample factor for ICP.

This value specifies the factor by which the area of a found candidate is reduced before the exact position of the object is determined by means of an ICP algorithm. The minimum allowed value of 1 means no reduction(highest accuracy). With increasing reduction, the processing speed increases, but at the same time the accuracy of the results also decrease. Typical values are in a range 1..4.

◆ indifferent_radius

indifferent_radius = property
static

float: Get or set fraction of template size which accounts for a single object.

This value specifies within which vicinity of a found candidate no further candidates are searched for. The value 1 indicates the largest extent of the learned object. For elongated objects that are close to each other, a smaller value may have to be selected. The minimum value is 0.5.

◆ max_inconsistency

max_inconsistency = property
static

float: Get or set maximum inconsistency.

This value is a threshold (0..1) that specifies the maximum allowed part of the model view to be insconsistent with the point cloud data in order for the hit to be counted. Inconsistency is defined to be point cloud data which is beyond the model. A typical value may be 0.2. It is influenced by SearchParameters.precision_threshold.

◆ max_occlusion

max_occlusion = property
static

float: Get or set maximum occlusion.

This value is a threshold (0..1) that specifies the maximum allowed part of the model view which is occluded by the point cloud data in order for the hit to be counted. Occlusion is defined to be point cloud data lying between the model and the sensor. A typical value may be 0.2. It is influenced by SearchParameters.precision_threshold.

◆ min_coverage

min_coverage = property
static

float: Get or set minimum coverage.

This value is a threshold (0..1) that specifies the minimum required coverage of the model view by the point cloud data in order for the hit to be counted. A typical value may be 0.8. It is influenced by SearchParameters.precision_threshold.

◆ min_score

min_score = property
static

float: Get or set minimum score.

This value is a threshold (0..1) that determines whether the candidate is counted as a hit. For this, a hash similarity score between final model view and point cloud data must exceed this limit. A typical value may be 0.8.

◆ parts_to_find

parts_to_find = property
static

int: Get or set the maximum number of objects to find.

This value specifies the maximum number of objects to be detected. A value of zero means that all objects should be found.

◆ precision_threshold

precision_threshold = property
static

float: Get or set precision threshold.

The calculation of the result score is based on deviations between the CAD model and the point cloud data.This value determines which deviation is considered tolerable, inconsistent or occlusion. This value depends on the quality of the point cloud data. A typical value is 2 mm, the minimum allowed value is 0.

◆ raw_results_only

raw_results_only = property
static

bool: Get or set the raw results flag.

If this flag is set, candidate locations are considered as hits without further investigation of these candidates. In this case, only parameters SearchParameters.hypotheses_threshold, SearchParameters.parts_to_find and SearchParameters.min_score are decisive for finding objects. If found candidates are indeed true object hits, the result values for SearchResult.position, SearchResult.rotation_vector and SearchResult.theta are only rough in a sense, that no fine tuning (ICP) takes place. Also, in this case the reported SearchResult.Score values coincide with the feature scores, which makes it possible to determine a useful value for SearchParameters.hypotheses_threshold.