gen_image_gray

gen_image_gray_ramp ( : ImageGrayRamp : Alpha, Beta, Mean, Row, Column, Width, Height : )

Create a gray value ramp.

The operator gen_image_gray_ramp creates a gray value ramp according to the following equation:

ImageGrayRamp(r,c) = Alpha(r-Row) +
                        Beta(c-Column) +
Mean

The size of the image is determined by Width and Height The gray values are of the type byte. Gray values outside the valid area are clipped.

Parameters

`ImageGrayRamp` (output_object)	image `->` object : byte
Created image with new image matrix.

`Beta` (input_control)	number `->` real
Gradient in column direction.
Default value: 1.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005

`Row` (input_control)	point.y `->` integer
Line index of reference point.
Default value: 256
Suggested values: 128, 256, 512, 1024
Minimum increment: 1
Recommended increment: 10

`Column` (input_control)	point.x `->` integer
Column index of reference point.
Default value: 256
Suggested values: 128, 256, 512, 1024
Minimum increment: 1
Recommended increment: 10

`Width` (input_control)	extent.x `->` integer
Width of image.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: `1 <= Width <= 512` (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: `Width >= 1`

`Height` (input_control)	extent.y `->` integer
Height of image.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: `1 <= Height <= 512` (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: `Height >= 1`

Result

If the parameter values are correct gen_image_gray_ramp returns the value 2 (H_MSG_TRUE). Otherwise an exception handling is raised.

Parallelization Information

gen_image_gray_ramp is reentrant and processed without parallelization.

Possible Predecessors

Possible Successors

Alternatives

See also

Module

Foundation