CVB.Net 14.1
SearchResult Struct Reference

Single result of a Finder.Find(DensePointCloud,SearchParameters) operation. More...

Public Member Functions

 SearchResult (Point3Dd position, Point3Dd rotationVector, Angle theta, double score)
 Constructor. More...
 
override bool Equals (object obj)
 Indicates whether this instance the given obj are equal. More...
 
bool Equals (SearchResult obj)
 Indicates whether this instance the given obj are equal. More...
 
override int GetHashCode ()
 Returns the hash code for this instance. More...
 

Static Public Member Functions

static bool operator== (SearchResult lhs, SearchResult rhs)
 Equality comparison operator. More...
 
static bool operator!= (SearchResult lhs, SearchResult rhs)
 Inequality comparison operator. More...
 

Properties

Point3Dd Position [get]
 Coordinates of object's origin within point cloud. More...
 
Point3Dd RotationVector [get]
 Normalized rotation axis vector of object's orientation. More...
 
Angle Theta [get]
 Rotation angle of object's orientation. More...
 
double Score [get]
 Score Detection confidence value (0..1). More...
 

Detailed Description

Single result of a Finder.Find(DensePointCloud,SearchParameters) operation.

Constructor & Destructor Documentation

◆ SearchResult()

SearchResult ( Point3Dd  position,
Point3Dd  rotationVector,
Angle  theta,
double  score 
)

Constructor.

Parameters
positionCoordinates of object's origin within point cloud.
rotationVectorNormalized rotation axis vector of object's orientation.
thetaRotation angle of object's orientation.
scoreScore Detection confidence value (0..1).

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object  obj)

Indicates whether this instance the given obj are equal.

Parameters
objObject to compare.
Returns
True if equal, false if not.

◆ Equals() [2/2]

bool Equals ( SearchResult  obj)

Indicates whether this instance the given obj are equal.

Parameters
objObject to compare.
Returns
True if equal, false if not.

◆ GetHashCode()

override int GetHashCode ( )

Returns the hash code for this instance.

Returns
A 32-bit signed integer that is the hash code for this instance.

◆ operator!=()

static bool operator!= ( SearchResult  lhs,
SearchResult  rhs 
)
static

Inequality comparison operator.

Parameters
lhsLeft hand side operand.
rhsRight hand side operand.
Returns
True if lhs != rhs , otherwise false.

◆ operator==()

static bool operator== ( SearchResult  lhs,
SearchResult  rhs 
)
static

Equality comparison operator.

Parameters
lhsLeft hand side operand.
rhsRight hand side operand.
Returns
True if lhs == rhs , otherwise false.

Property Documentation

◆ Position

Point3Dd Position
get

Coordinates of object's origin within point cloud.

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

◆ RotationVector

Point3Dd RotationVector
get

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.

◆ Score

double Score
get

Score 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 SearchParameters.MinScore.

◆ Theta

Angle Theta
get

Rotation angle of object's orientation.

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