Regions

Most measurement tools use user-defined regions, or regions of interest, to limit the area in which measurements occur. Unlike reducing the active area, reducing the region of interest does not increase the maximum frame rate of the sensor.

You can use Ctrl-Z and Ctrl-Shift-Z to undo and redo changes to the last changed region's size and position.

You can also quickly center a region in the data viewer and reset it to its default size; this is useful if you have zoomed in or out a lot. You can center a specific region by clicking its "Center tool region" button () in the tool's Parameters section, next to the region expander.

You can center and reset all regions in a tool by clicking the "Center tool region" button () above the data viewer. When a tool has multiple regions, the regions are spaced out in the center of the data viewer.

Some tools provide "flexible" regions, which in addition to rectangular regions let you create circular and elliptical regions (which can optionally be annular). Some tools also let you use Surface and Surface Intensity data as masks. For information on setting flexible regions, see Flexible Regions.

Other tools are currently limited to standard, rectangular regions.

Standard Regions

Some tools provide regions limited to boxes/rectangles.

The Transform Matrix setting is not currently used.

Flexible Regions

Many tools provide "flexible" regions, which let you choose region types such as circle and ellipse, in addition to rectangle regions. For a complete list and information on the related settings, see Flexible Region Parameters.

The following parameters are available in tools that support flexible regions.

Flexible Region Parameters
Parameter Description

Mask Mode

One of the following:

Include Data in Region: The tool uses only the data inside the region or regions.

Exclude Data in Region: The tool ignores the data inside the region or regions, using only the data outside.

Number of Regions

The number of regions or masks the tool uses to extract surface data. You can define up to 64 regions. This parameter is not available in some tools. To set a number of regions greater than 16, choose "Custom" in this parameter and set Custom Region Count.

When you specify more than one region, the regions are initially stacked on top of one another, in the same location.

Custom Region Count

The number of regions (from 17 to 64) when Number of Regions is set to "Custom".

Region {n} An expandable section containing region definitions for each region.

Region Type {n}

The type of each region. Regions can overlap.

(For more information on the settings you use with the Circle and Ellipse types, see Working with Circular and Elliptical Regions.)

 

One of the following:

 

Rectangle

Extracts a rectangular region from the surface data.

 

Circle

Extracts a circular region from the surface data, constrained by a square region.

Set the region's inner circle using the Inner Diameter parameter to 0 to extract circular data. Set it to a non-zero to extract annular data.

Use the Sector Start Angle and Sector Angle Range parameters to extract a partial circular or elliptical region. (See below.)

 

Ellipse

Extracts an elliptical region from the surface data, constrained by a square or rectangular region.

Set the region's inner ellipse (inner cyan ellipse below) using the Inner Major Axis and Inner Minor Axis parameters to extract annular data.

Use the Sector Start Angle and Sector Angle Range settings to extract a partial circular or elliptical region. (See below.)

 

Surface

Uses the Surface data you select in Mask Source {n}, in the Inputs panel, to create a mask.

 

Surface Intensity

Uses the intensity data you select in Mask Source {n}, in the Inputs panel, to create a mask.

Set the Low Threshold and High Threshold parameters as required.

X, Y, Z

Width (X), Length (Y), Height (Z)

Z Angle

These parameters define the size, location (center of the region), and orientation of the region. Not available when Region Type {n} is set to Surface or Surface Intensity.

Inner Diameter

Only available when Region Type {n} is set to Circle.

Defines the diameter of the inner circle.

Set this parameter to a value greater than 0 to extract a ring of data. Set this parameter to 0 to extract a circle of data.

Inner Major Axis

Inner Minor Axis

Only available when Region Type {n} is set to Ellipse.

These parameters define the major and minor axes of the inner ellipse, respectively

Set this parameter to a value greater than 0 to extract a ring of data. Set this parameter to 0 to extract an elliptical disk of data.

Sector Start Angle

Sector Angle Range

Only available when Region Type {n} is set to Circle or Ellipse

Use these parameters together to extract a partial ring of data. Sector Start Angle controls the starting angle of the data, whereas Sector Angle Range controls the length of the arc.

Note that the angles and ranges in these parameters are measured clockwise around Z, where 0 degrees is along the positive X axis.

For more information on how these settings work together, see Working with Circular and Elliptical Regions.

High Threshold

Low Threshold

The high and low thresholds the tool uses in combination with the intensity mask.

Only available when Region Type {n} is set to Surface Intensity.

Working with Circular and Elliptical Regions

When you set a region's type to Circle or Ellipse, the tool displays several additional settings that work together to define the region. Sector Start Angle and Sector Angle Range work together to define the start and end of a partial circular/elliptical region (solid or annular). A region will be annular if Inner Circle Diameter is non-zero. Note that the "length" of the partial region extends from the start angle. In the following illustration, the start angle (θ) is 135 degrees relative to the 0-degree point indicated below, and the region extends 270 degrees (δ) from that, clockwise around Z.

Sector Start Angle starts at the 0-degree point around Z.

Note that the angles defining a partial circular/elliptical region are relative to the region, and not the sensor's coordinate system. So a region rotated 30 degrees using its Z Angle setting rotates the start angle and angle range by 30 degrees.

When you set a region type to Ellipse, instead of the inner circle diameter, you must set the major and minor axes of the inner ellipse.

Region Rotation

The measurement region of some tools can be rotated by setting the region's Z Angle to better accommodate features that are on an angle on a target. By rotating the measurement region, data not related to the feature can often be excluded, improving accuracy of measurements. You can modify the size and position of a rotated region.