Start » Filter Reference » Region » Region Basics » CreateRectangleRegion
Basic| Module: | FoundationLite |
|---|
Creates a region corresponding to a given rectangle.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inRectangle | Rectangle2D | ||
|
inRectangleAlignment | CoordinateSystem2D* | Adjusts the rectangle to the position of the inspected object | |
|
inFrameWidth | Integer | 0 - 65535 | Width of the created region's frame (not to be confused with the width of the rectangle!) |
|
inFrameHeight | Integer | 0 - 65535 | Height of the created region's frame (not to be confused with the height of the rectangle!) |
 |
outRegion | Region | Output region | |
|
outAlignedRectangle | Rectangle2D | The input rectangle transformed to the absolute coordinate system | |
Description
The operation creates a region containing pixels lying inside the specified rectangle.
The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input rectangle exceeds these dimensions, the output region will be cropped.
Hints
- Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.
Examples
Complexity Level
This filter is available on Basic Complexity Level.
See Also
- CreateCircleRegion – Creates a circular region corresponding to a given circle.