IDS peak ICV v1.0.0
Loading...
Searching...
No Matches
RegionSelector Class Reference

#include <peak_icv/selectors/peak_icv_region_selector.hpp>

Public Member Functions

 RegionSelector (const std::vector< Region > &regions)
 Constructor.
 
std::vector< Region > GetRegions ()
 Returns the selected regions.
 
RegionSelector SelectByArea (const peak::common::IntervalU &interval)
 Select a number of regions from a set of input regions by their area.
 
RegionSelector SelectByCenterOfGravityX (const peak::common::IntervalF &interval)
 Select a number of regions from a set of input regions by their center of gravity x.
 
RegionSelector SelectByCenterOfGravityY (const peak::common::IntervalF &interval)
 Select a number of regions from a set of input regions by their center of gravity y.
 
RegionSelector SelectByCenterOfGravityRect (const peak::common::RectangleF &rect)
 Select a number of regions from a set of input regions by their center of gravity.
 

Detailed Description

Class for selecting regions.

The region selector is used to filter regions based on the given feature criteria (e.g. center of gravity ...). It can be used to reduce the amount of regions to process.

Warning
This function is still in development and not released.

Definition at line 36 of file peak_icv_region_selector.hpp.

Constructor & Destructor Documentation

◆ RegionSelector()

RegionSelector ( const std::vector< Region > & regions)
inlineexplicit

Constructor.

Parameters
regionsRegions to select from
Warning
This function is still in development and not released.

Definition at line 113 of file peak_icv_region_selector.hpp.

Member Function Documentation

◆ GetRegions()

std::vector< Region > GetRegions ( )
inline

Returns the selected regions.

Warning
This function is still in development and not released.

Definition at line 117 of file peak_icv_region_selector.hpp.

◆ SelectByArea()

RegionSelector SelectByArea ( const peak::common::IntervalU & interval)
inline

Select a number of regions from a set of input regions by their area.

This function provides the regions that are in the range area.minimum <= area(region) <= area.maximum.

Parameters
intervalInterval to select by
Warning
This function is still in development and not released.

Definition at line 122 of file peak_icv_region_selector.hpp.

◆ SelectByCenterOfGravityRect()

RegionSelector SelectByCenterOfGravityRect ( const peak::common::RectangleF & rect)
inline

Select a number of regions from a set of input regions by their center of gravity.

This function provides the regions that are in the range rect.x <= x(region) <= rect.x + rect.width && rect.y <= y(region) <= rect.y + rect.height.

Note
Width and height can be set to zero. In this case only the point (x,y) is used.
Parameters
rectInterval to select by
Warning
This function is still in development and not released.

Definition at line 140 of file peak_icv_region_selector.hpp.

◆ SelectByCenterOfGravityX()

RegionSelector SelectByCenterOfGravityX ( const peak::common::IntervalF & interval)
inline

Select a number of regions from a set of input regions by their center of gravity x.

This function provides the regions that are in the range x.minimum <= x(region) <= x.maximum.

Parameters
intervalInterval to select by
Warning
This function is still in development and not released.

Definition at line 128 of file peak_icv_region_selector.hpp.

◆ SelectByCenterOfGravityY()

RegionSelector SelectByCenterOfGravityY ( const peak::common::IntervalF & interval)
inline

Select a number of regions from a set of input regions by their center of gravity y.

This function provides the regions that are in the range y.minimum <= y(region) <= y.maximum.

Parameters
intervalInterval to select by
Warning
This function is still in development and not released.

Definition at line 134 of file peak_icv_region_selector.hpp.