RegionSelector Class Reference

Public Member Functions
	RegionSelector (DisposableList< Region > regions)
	Creates a RegionSelector with a collection of Region objects.
RegionSelector	SelectByArea (IntervalU interval)
	Selects regions based on their area.
RegionSelector	SelectByCenterOfGravityX (IntervalF interval)
	Selects regions based on the x-coordinate of the center of gravity.
RegionSelector	SelectByCenterOfGravityY (IntervalF interval)
	Selects regions based on the y-coordinate of the center of gravity.
RegionSelector	SelectByCenterOfGravityRectangle (RectangleF rect)
	Selects regions based on whether their center of gravity lies within the given rectangle.

Data Fields
readonly DisposableList< Region >	Regions
	The currently selected regions.

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

IDSImaging.Peak.ICV 1.3

Definition at line 19 of file RegionSelector.cs.

Constructor & Destructor Documentation

RegionSelector()

RegionSelector ( DisposableList< Region > regions )

inline

Creates a RegionSelector with a collection of Region objects.

Parameters

regions

Collection of Region objects to select from. Must not be null.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 34 of file RegionSelector.cs.

Member Function Documentation

SelectByArea()

RegionSelector SelectByArea ( IntervalU interval )

inline

Selects regions based on their area.

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

Parameters

interval

Interval to select by. Only positive values are allowed.

Returns

A new RegionSelector instance containing the selected regions.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 53 of file RegionSelector.cs.

SelectByCenterOfGravityRectangle()

RegionSelector SelectByCenterOfGravityRectangle ( RectangleF rect )

inline

Selects regions based on whether their center of gravity lies within the given 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

rect	Rectangle to select by.

Returns

A new RegionSelector instance containing the selected regions.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 124 of file RegionSelector.cs.

SelectByCenterOfGravityX()

RegionSelector SelectByCenterOfGravityX ( IntervalF interval )

inline

Selects regions based on the x-coordinate of the center of gravity.

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

Parameters

interval

Interval to select by.

Returns

A new RegionSelector instance containing the selected regions.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 74 of file RegionSelector.cs.

SelectByCenterOfGravityY()

RegionSelector SelectByCenterOfGravityY ( IntervalF interval )

inline

Selects regions based on the y-coordinate of the center of gravity.

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

Parameters

interval

Interval to select by.

Returns

A new RegionSelector instance containing the selected regions.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 95 of file RegionSelector.cs.

Field Documentation

Regions

readonly DisposableList<Region> Regions

The currently selected regions.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 25 of file RegionSelector.cs.