gen_image_surface_second

gen_image_surface_second_order ( : ImageSurface : Type, Alpha, Beta, Gamma, Delta, Epsilon, Zeta, Row, Col, Width, Height : )

Create a curved gray surface with second order polynomial.

The operator gen_image_surface_second_order creates a curved gray value surface according to the following equation:

ImageSurface(r,c) =  Alpha(r- Row)**2 +
                        Beta(c-Col)**2 + 
                        Gamma(r- Row)*(c-Col) +
                        Delta(r- Row) + 
                        Epsilon(c- Col) +  
                        Zeta

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

Parameters

`ImageSurface` (output_object)	image `->` object : byte / uint2 / real
Created image with new image matrix.

`Type` (input_control)	string `->` string
Pixel type.
Default value: 'byte'
List of values: 'byte', 'uint2', 'real'

`Alpha` (input_control)	number `->` real
Second order coefficient in vertical 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

`Beta` (input_control)	number `->` real
Second order coefficient in horizontal 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

`Gamma` (input_control)	number `->` real
Mixed second order coefficient.
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

`Delta` (input_control)	number `->` real
First order coefficient in vertical 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

`Epsilon` (input_control)	number `->` real
First order coefficient in horizontal 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

`Zeta` (input_control)	number `->` real
Zero order coefficient
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)	number `->` real
line coordinate of the apex of the surface
Default value: 256.0
Suggested values: 0.0, 128.0, 256.0, 512.0
Minimum increment: 0.000001
Recommended increment: -0.005

`Col` (input_control)	number `->` real
Column coordinate of the apex of the surface
Default value: 256.0
Suggested values: 0.0, 128.0, 256.0, 512.0
Minimum increment: 0.000001
Recommended increment: -0.005

`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_surface_second_order returns the value 2 (H_MSG_TRUE). Otherwise an exception handling is raised.

Parallelization Information

gen_image_surface_second_order is reentrant, local, and processed without parallelization.

Possible Predecessors

fit_surface_second_order

Possible Successors

sub_image

Module

Foundation