CVB++ 15.0
SearchResult Class Referencefinal

Definition of a specific detection result. More...

#include <cvb/dnc/search_result.hpp>

Public Member Functions

Point3D< double > Position () const noexcept
 Coordinates of object's origin within point cloud. More...
 
Vector3D< double > RotationVector () const noexcept
 Normalized rotation axis vector of object's orientation. More...
 
Angle Theta () const noexcept
 Rotation angle of object's orientation. More...
 
double Score () const noexcept
 Detection confidence value (0..1). More...
 
bool operator== (const SearchResult &searchResult) const noexcept
 Compares to an other search result. More...
 
bool operator!= (const SearchResult &searchResult) const noexcept
 Compares to an other search result. More...
 

Detailed Description

Definition of a specific detection result.

Member Function Documentation

◆ operator!=()

bool operator!= ( const SearchResult searchResult) const
inlinenoexcept

Compares to an other search result.

Parameters
[in]searchResultOther search result.
Returns
True if not equal, otherwise false.
Exceptions
Doesnot throw any exception.

◆ operator==()

bool operator== ( const SearchResult searchResult) const
inlinenoexcept

Compares to an other search result.

Parameters
[in]searchResultOther search result.
Returns
True if equal, otherwise false.
Exceptions
Doesnot throw any exception.

◆ Position()

Point3D< double > Position ( ) const
inlinenoexcept

Coordinates of object's origin within point cloud.

The indicated position corresponds to the coordinate origin in the CAD file.

Returns
The position.
Exceptions
Doesnot throw any exception.

◆ RotationVector()

Vector3D< double > RotationVector ( ) const
inlinenoexcept

Normalized rotation axis vector of object's orientation.

The axis part of axis-angle representation of object's orientation. The rotation center is the given position Position.

Returns
The object orientation.
Exceptions
Doesnot throw any exception.

◆ Score()

double Score ( ) const
inlinenoexcept

Detection confidence value (0..1).

The score is an individual hash similarity score between point cloud and CAD object. It must be equal or above the threshold given by Cvb.Dnc.SearchParameters.MinScore.

Returns
The score.
Exceptions
Doesnot throw any exception.

◆ Theta()

Angle Theta ( ) const
inlinenoexcept

Rotation angle of object's orientation.

The angle part of axis-angle representation of object's orientation.

Returns
The rotation angle.
Exceptions
Doesnot throw any exception.