You are here: Start » Function Reference » Region » Region Basics

Region Basics

Icon Name Description / Applications Modules
CreateBoxBorderRegion CreateBoxBorderRegion

Creates a frame-shaped region with given parameters.

FoundationLite
CreateBoxRegion CreateBoxRegion

Creates a rectangular region corresponding to a given box.

FoundationLite
CreateCircleRegion CreateCircleRegion

Creates a circular region corresponding to a given circle.

FoundationLite
CreateCrossRegion CreateCrossRegion

Creates a cross-shaped region with given parameters.

FoundationLite
CreateEllipseRegion CreateEllipseRegion

Creates an elliptic region of given bounding rectangle.

FoundationLite
CreateGridRegion CreateGridRegion

Creates a grid-shaped region with given parameters.

FoundationLite
CreateLineRegion CreateLineRegion

Creates a line region.

FoundationLite
CreatePathBorderRegion CreatePathBorderRegion

Creates a region along a given path. The region may be internal or external to the path.

FoundationLite
CreatePathRegion CreatePathRegion

Creates a region along the given path.

FoundationLite
CreatePolygonRegion CreatePolygonRegion

Creates a polygonal region corresponding to a given closed path.

FoundationLite
CreateRectangleBorderRegion CreateRectangleBorderRegion

Creates a frame-shaped region with given parameters.

FoundationLite
CreateRectangleRegion CreateRectangleRegion

Creates a region corresponding to a given rectangle.

FoundationLite
CreateRingRegion CreateRingRegion

Creates a ring-shaped region with given parameters.

FoundationLite
CreateSegmentRegion CreateSegmentRegion

Creates a segment region.

FoundationLite
EmptyRegion EmptyRegion

Creates an empty region with a given frame.

FoundationLite
GetRegionFrame GetRegionFrame

Returns the width and height of the entire region's frame (not to be confused with RegionBoundingBox!).

FoundationLite
LocationsToRegion LocationsToRegion

Forms a region containing pixels of given locations.

FoundationLite
RegionCharacteristicPoint RegionCharacteristicPoint

Returns a characteristic point of the input's region bounding box.

FoundationLite
RegionToLocations RegionToLocations

Converts a region to an array of its pixel locations.


It may be considered explicit region decompression.

FoundationLite
SetRegionFrame SetRegionFrame

Changes the width and the height of a region's frame (but does not rescale the content).

FoundationLite
SkipEmptyRegion SkipEmptyRegion

If the input region contains at least one pixel, then it is copied to the output; otherwise Nil is returned.


Secures against domain errors caused by empty regions, e.g. just before the RegionMassCenter filter is to be invoked.

FoundationLite
TestRegionEmpty TestRegionEmpty

Tests whether the size of a region equals zero.

FoundationLite
TestRegionNotEmpty TestRegionNotEmpty

Tests whether the size of a region doesn't equal zero.

FoundationLite
TestRegionOnBorder TestRegionOnBorder

Tests whether a region is adjacent to its border.

FoundationLite
VerifyRegion VerifyRegion

Checks if the point-runs of the input region are correctly arranged (sorted, not overlapping etc.).


You only need to use this tool if you create regions from point-runs manually.

FoundationLite