IDS peak ICV v1.5.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)
 Constructs a selector for the specified set of regions.
 
std::vector< Region > GetRegions ()
 
RegionSelector SelectByArea (const peak::common::IntervalU &interval)
 Selects regions by area.
 
RegionSelector SelectByCenterOfGravityX (const peak::common::IntervalF &interval)
 Selects regions by center of gravity X.
 
RegionSelector SelectByCenterOfGravityY (const peak::common::IntervalF &interval)
 Selects regions by center of gravity Y.
 
RegionSelector SelectByCenterOfGravityRect (const peak::common::RectangleF &rect)
 Selects regions by center of gravity within a rectangle.
 

Detailed Description

Selects regions based on feature criteria.

Represents a region selector used to filter a specified set of regions based on features such as area or center of gravity. Used to select the regions the user is interested in.

Since
ids_peak_icv 1.1

Constructor & Destructor Documentation

◆ RegionSelector()

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

Constructs a selector for the specified set of regions.

Parameters
regionsRegions to select from.
Since
ids_peak_icv 1.1

Member Function Documentation

◆ GetRegions()

std::vector< Region > GetRegions ( )
inline
Returns
Vector of selected regions.
Since
ids_peak_icv 1.1

◆ SelectByArea()

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

Selects regions by area.

Provides regions where: interval.minimum <= area(region) <= interval.maximum.

Parameters
intervalArea interval to select by.
Returns
Selector with filtered regions.
Since
ids_peak_icv 1.1

◆ SelectByCenterOfGravityRect()

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

Selects regions by center of gravity within a rectangle.

Provides regions where: rect.x <= x(region) <= rect.x + rect.width && rect.y <= y(region) <= rect.y + rect.height.

Note
If rect.width and rect.height are zero, the selection is based solely on the point (rect.x, rect.y).
Parameters
rectRectangular interval to select by.
Returns
Selector with filtered regions.
Since
ids_peak_icv 1.1

◆ SelectByCenterOfGravityX()

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

Selects regions by center of gravity X.

Provides regions where: interval.minimum <= x(region) <= interval.maximum.

Parameters
intervalX interval to select by.
Returns
Selector with filtered regions.
Since
ids_peak_icv 1.1

◆ SelectByCenterOfGravityY()

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

Selects regions by center of gravity Y.

Provides regions where: interval.minimum <= y(region) <= interval.maximum.

Parameters
intervalY interval to select by.
Returns
Selector with filtered regions.
Since
ids_peak_icv 1.1