Start » Filter Reference » Region » Region Basics » CreateGridRegion

CreateGridRegion

Advanced

Module: FoundationLite

Creates a grid-shaped region with given parameters.

Name Type Range Description
Input value
 inGridBoundingBox Box
Input value
 inHorizontalStep Integer 1 - Horizontal distance between vertical grid lines.
Input value
 inVerticalStep Integer 1 - Vertical distance between horizontal grid lines.
Input value
 inFrameWidth Integer 0 - 65535 Width of the created region's frame
Input value
 inFrameHeight Integer 0 - 65535 Height of the created region's frame
Output value
 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

CreateGridRegion run with inGridBoundingBox parameters: X = 0, Y = 0, inGridWidth = 300, inGridHeight = 300 and with inHorizontalStep = 60, inVerticalStep = 60

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • CreateBoxRegion – Creates a rectangular region corresponding to a given box.