Start » Filter Reference » Region » Region Basics » CreateCrossRegion

CreateCrossRegion

Basic

Module: FoundationLite

Creates a cross-shaped region with given parameters.

Name Type Range Description
Input value
 inCrossBoundingBox Box
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 cross. Cross is described by its width, height and coordinates of upper-left corner of its bounding box.

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 cross exceeds these dimensions, the output region will be cropped.

Hints

  • Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.

Examples

CreateCrossRegion run with inCrossBoundingBox parameters: X = 50, Y = 100, Width = 200, inCrossHeight = 100.

Complexity Level

This filter is available on Basic Complexity Level.

See Also

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