gen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_rampgen_image_gray_ramp

HALCON ScriptCpp++.NETPythonC

Short description

gen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_rampgen_image_gray_ramp — Create a gray value ramp.

Signature

gen_image_gray_ramp( out image ImageGrayRamp, real Alpha, real Beta, real Mean, point.y Row, point.x Column, extent.x Width, extent.y Height )void GenImageGrayRamp( HObject* ImageGrayRamp, const HTuple& Alpha, const HTuple& Beta, const HTuple& Mean, const HTuple& Row, const HTuple& Column, const HTuple& Width, const HTuple& Height )static void HOperatorSet.GenImageGrayRamp( out HObject imageGrayRamp, HTuple alpha, HTuple beta, HTuple mean, HTuple row, HTuple column, HTuple width, HTuple height )def gen_image_gray_ramp( alpha: float, beta: float, mean: float, row: int, column: int, width: int, height: int ) -> HObject

Herror gen_image_gray_ramp( Hobject* ImageGrayRamp, double Alpha, double Beta, double Mean, const Hlong Row, const Hlong Column, const Hlong Width, const Hlong Height )

Herror T_gen_image_gray_ramp( Hobject* ImageGrayRamp, const Htuple Alpha, const Htuple Beta, const Htuple Mean, const Htuple Row, const Htuple Column, const Htuple Width, const Htuple Height )

void HImage::GenImageGrayRamp( double Alpha, double Beta, double Mean, Hlong Row, Hlong Column, Hlong Width, Hlong Height )

void HImage.GenImageGrayRamp( double alpha, double beta, double mean, int row, int column, int width, int height )

Description

The operator gen_image_gray_rampGenImageGrayRamp 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 Widthwidthwidth and Heightheightheight The gray values are of the type byte. Gray values outside the valid area are clipped.

Execution information

Execution information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).

• Multithreading scope: global (may be called from any thread).

• Processed without parallelization.

Parameters

ImageGrayRampimageGrayRampimage_gray_ramp (output_object) image → object (byte)HObject (byte)HImage (byte)HObject (byte)Hobject * (byte)

Created image with new image matrix.

Alphaalphaalpha (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Gradient in line direction.

Default: 1.01.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0-2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005

Betabetabeta (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Gradient in column direction.

Default: 1.01.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0-2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005

Meanmeanmean (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Mean gray value.

Default: 128128
Suggested values: 0.0, 20.0, 40.0, 60.0, 80.0, 100.0, 120.0, 140.0, 160.0, 180.0, 200.0, 220.0, 255.00.0, 20.0, 40.0, 60.0, 80.0, 100.0, 120.0, 140.0, 160.0, 180.0, 200.0, 220.0, 255.0
Minimum increment: 1
Recommended increment: 10

Rowrowrow (input_control) point.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Line index of reference point.

Default: 256256
Suggested values: 128, 256, 512, 1024128, 256, 512, 1024
Minimum increment: 1
Recommended increment: 10

Columncolumncolumn (input_control) point.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Column index of reference point.

Default: 256256
Suggested values: 128, 256, 512, 1024128, 256, 512, 1024
Minimum increment: 1
Recommended increment: 10

Widthwidthwidth (input_control) extent.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Width of image.

Default: 512512
Suggested values: 128, 256, 512, 1024128, 256, 512, 1024
Value range: 1 ≤ Width (lin)
Minimum increment: 1
Recommended increment: 10

Heightheightheight (input_control) extent.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Height of image.

Default: 512512
Suggested values: 128, 256, 512, 1024128, 256, 512, 1024
Value range: 1 ≤ Height (lin)
Minimum increment: 1
Recommended increment: 10

Result

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

Combinations with other operators

Combinations

Possible predecessors

moments_gray_planeMomentsGrayPlane

Possible successors

paint_regionPaintRegion, reduce_domainReduceDomain, get_image_pointer1GetImagePointer1, copy_objCopyObj

Alternatives

gen_image1GenImage1

See also

reduce_domainReduceDomain, paint_grayPaintGray, gen_image_constGenImageConst

Module

Foundation