Back to Adaptive Vision Studio website
You are here: Start » Filter Reference » Region Basics » CreateGridRegion
Creates a grid-shaped region with given parameters.
Name | Type | Range | Description | |
---|---|---|---|---|
inGridBoundingBox | Box | |||
inHorizontalStep | Integer | 1 - | Horizontal distance between vertical grid lines. | |
inVerticalStep | Integer | 1 - | Vertical distance between horizontal grid lines. | |
inFrameWidth | Integer | 0 - | Width of the created region's frame | |
inFrameHeight | Integer | 0 - | Height of the created region's frame | |
outRegion | Region | Output region |
Description
The operation creates a region in a shape of a one-pixel-wide grid. Grid is described by its width, height, distances between its lines and coordinates of its upper-left corner.
The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with.
Hints
- Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.
Examples
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Output region too big in CreateGridRegion. |
Complexity Level
This filter is available on Basic Complexity Level.
See Also
- CreateBoxRegion – Creates a rectangular region corresponding to a given box.
- CreateCrossRegion – Creates a cross-shaped region with given parameters.