CVB++ 14.0
RangeMapSegmentor Class Referenceabstract

Base class for segmentor object to configure and compute segmentation on range maps. More...

#include <cvb/foundation/metric_aqs12.hpp>

Inherited by AQS12RangeMapSegmentor.

Public Member Functions

double RangeMapIgnoreValue () const noexcept
 Returns the range map ignore value of the segmentor. More...
 
void SetRangeMapIgnoreValue (double rangeMapIgnoreValue) const noexcept
 Sets the range map ignore value of the segmentor. More...
 
int WindowSize () const noexcept
 Gets window size for calculation of normals (used for the classification of the AQS12 faces). More...
 
void SetWindowSize (int windowSize) const
 Sets window size for the calculation of normals (used for the classification of the AQS12 faces). More...
 
void * Handle () const noexcept
 Returns C-API style handle to Node Object. More...
 

Static Public Member Functions

static std::shared_ptr< RangeMapSegmentorFromHandle (HandleGuard< RangeMapSegmentor > &&guard)
 Creates a segmentor from a classic API handle. More...
 

Detailed Description

Base class for segmentor object to configure and compute segmentation on range maps.

Member Function Documentation

◆ FromHandle()

std::shared_ptr< RangeMapSegmentor > FromHandle ( HandleGuard< RangeMapSegmentor > &&  guard)
inlinestatic

Creates a segmentor from a classic API handle.

Parameters
[in]guardLife time guard for C-API handle.
Returns
The segmentor created from the classic API handle.
Exceptions
Anyexception derived from std::exception including CvbException.

The segmentor takes ownership of the handle, so you must share it before using this function.

◆ Handle()

void * Handle ( ) const
inlinenoexcept

Returns C-API style handle to Node Object.

Returns
C-API handle

◆ RangeMapIgnoreValue()

double RangeMapIgnoreValue ( ) const
inlinenoexcept

Returns the range map ignore value of the segmentor.

Returns
Value to be ignored in the range map segmenting faces.

◆ SetRangeMapIgnoreValue()

void SetRangeMapIgnoreValue ( double  rangeMapIgnoreValue) const
inlinenoexcept

Sets the range map ignore value of the segmentor.

Parameters
[in]rangeMapIgnoreValueValue to be ignored in the range map segmenting faces.

◆ SetWindowSize()

void SetWindowSize ( int  windowSize) const
inline

Sets window size for the calculation of normals (used for the classification of the AQS12 faces).

If WindowSize is set to zero, the window size will be calculated automatically. If it is an even number, it will be extended with one.

Parameters
[in]windowSizeSide length of squared window.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ WindowSize()

int WindowSize ( ) const
inlinenoexcept

Gets window size for calculation of normals (used for the classification of the AQS12 faces).

If WindowSize is set to zero, the window size will be calculated automatically.

Returns
Side length of squared window.