ScaleColorImage

ScaleColorImage resamples the pixels in an input image or region of interest (ROI) to produce a reduced, enlarged, unrotated or unbent version of a color image. The function displays the resampled image in the upper-left corner of the In-Sight spreadsheet.

ScaleColorImage Inputs

Syntax: ScaleColorImage(Image,Fixture.Row,Fixture.Column,Fixture.Theta,Region.X,Region.Y,Region.High,Region.Wide,Region.Angle,Region.Curve,Sample Type,Sample Ratio.X Ratio,Sample Ratio.Y,Display Row,Display Column,Show)

Parameter

Description

Image

This parameter must reference a spreadsheet cell that contains an Image data structure. By default, this parameter references A0, the cell containing the AcquireImage Image data structure. This parameter can also reference other Image data structures, such as those returned by the Vision Tool Image functions. For more information, see AcquireImage and Image.

Fixture

Defines the Region of Interest (ROI) relative to a Fixture input or the output of a Vision Tool function's image coordinate system. Setting the ROI relative to a Fixture ensures that if the Fixture is rotated or translated, the ROI will be rotated or translated in relation to the Fixture. For more information, see Fixture and Vision Tools.

Note: The default setting is (0,0,0), the top leftmost corner of the image.

Row	The row offset, in image coordinates.
Column	The column offset, in image coordinates.
Theta	The angle of orientation, in the image coordinate system.

Region

Also known as the Region of Interest (ROI), specifies the region of the image that undergoes analysis and creates a rectangular image region that can be transformed and rotated. For more information, see Interactive Graphics Mode.

Tip: With this parameter selected, you can press the Maximize Region button on the property sheet's toolbar to maximize the region and cover the entire image.

X	The x-offset of the origin, in fixture coordinates.
Y	The y-offset of the origin, in fixture coordinates.
High	The dimension along the region's x-axis.
Wide	The dimension along the region's y-axis.
Angle	The orientation, in fixture coordinates.
Curve	The angular deviation between the region's x-axis and the opposing boundary line.

Sample Type

Specifies the pixel-resampling technique.

0 = Interpolate Points (default)

Specifies using a weighted average value of the pixel region to resample the image.

Sample Ratio

Specifies the sample ratio in the (X,Y) direction of the region.

Note: Values between 100 and 1000 specify upsampling. For example, if both the ratios are specified as 200, the resampled image will be twice as large as the specified Region.

X Ratio	Specifies the ratio (10–1000; default = 50) in the X direction of the region.
Y Ratio	Specifies the ratio (10–1000; default = 50) in the Y direction of the region.

Display Row

Specifies the Row coordinate (default = 0) where the rescaled image will be displayed, relative to the upper left-hand corner.

Note: Specifying a value of -1 will ensure that the function places the scaled image at the same row coordinate as the input image:

For acquired images, the Start Row specified in the AcquireImage function will be used. Therefore, if a ScaleColorImage function is configured with a Display Row and Display Column parameter settings of 0,0, and the image was a partial acquisition, the ScaleColorImage function would display its output above the acquired image. For more information, see AcquireImage.
For images output by other Vision Tools, such as a Color tool like the ExtractColor function, the row coordinate that defines the input image will be used. For example, if the ExtractColor function is defined at the Col/Row coordinates of 100,100, the referencing ScaleColorImage function with the -1 parameter setting would display at the Row coordinate of 100. For more information, see ExtractColor.

Display Column

Specifies the Column coordinate (default = 0) where the rescaled image will be displayed, relative to the upper left-hand corner.

Show

Specifies which graphical overlays are displayed on top of the image.

0 = hide all (default)	The input region boundary and resampled image will be hidden, except when the cell containing the ScaleColorImage function is highlighted in the spreadsheet.
1 = result graphics only	The resampled image will be displayed at all times.
2 = input graphics only	The input region boundary will be displayed at all times.

ScaleColorImageOutputs

Returns

An Image data structure containing the processed image, or #ERR if any of the input parameters are invalid.