Operator Reference

gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp (Operator)

gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp — Create a gray value ramp.

Signature

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

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 GenImageGrayRamp(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)

static void HOperatorSet.GenImageGrayRamp(out HObject imageGrayRamp, HTuple alpha, HTuple beta, HTuple mean, HTuple row, HTuple column, HTuple width, HTuple height)

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

def gen_image_gray_ramp(alpha: float, beta: float, mean: float, row: int, column: int, width: int, height: int) -> HObject

Description

The operator gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp creates a gray value ramp according to the following equation: ImageGrayRampImageGrayRampImageGrayRampimageGrayRampimage_gray_ramp(r,c) = AlphaAlphaAlphaalphaalpha(r-RowRowRowrowrow) + BetaBetaBetabetabeta(c-ColumnColumnColumncolumncolumn) + MeanMeanMeanmeanmean The size of the image is determined by WidthWidthWidthwidthwidth and HeightHeightHeightheightheight The gray values are of the type byte. Gray values outside the valid area are clipped.

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

ImageGrayRampImageGrayRampImageGrayRampimageGrayRampimage_gray_ramp (output_object)  image objectHImageHObjectHObjectHobject * (byte)

Created image with new image matrix.

AlphaAlphaAlphaalphaalpha (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Gradient in line direction.

Default: 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

BetaBetaBetabetabeta (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Gradient in column direction.

Default: 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

MeanMeanMeanmeanmean (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Mean gray value.

Default: 128

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.0

Minimum increment: 1

Recommended increment: 10

RowRowRowrowrow (input_control)  point.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Line index of reference point.

Default: 256

Suggested values: 128, 256, 512, 1024

Minimum increment: 1

Recommended increment: 10

ColumnColumnColumncolumncolumn (input_control)  point.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column index of reference point.

Default: 256

Suggested values: 128, 256, 512, 1024

Minimum increment: 1

Recommended increment: 10

WidthWidthWidthwidthwidth (input_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of image.

Default: 512

Suggested values: 128, 256, 512, 1024

Value range: 1 ≤ Width Width Width width width (lin)

Minimum increment: 1

Recommended increment: 10

HeightHeightHeightheightheight (input_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of image.

Default: 512

Suggested values: 128, 256, 512, 1024

Value range: 1 ≤ Height Height Height height height (lin)

Minimum increment: 1

Recommended increment: 10

Result

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

Possible Predecessors

moments_gray_planemoments_gray_planeMomentsGrayPlaneMomentsGrayPlanemoments_gray_plane

Possible Successors

paint_regionpaint_regionPaintRegionPaintRegionpaint_region, reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain, get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1get_image_pointer1, copy_objcopy_objCopyObjCopyObjcopy_obj

Alternatives

gen_image1gen_image1GenImage1GenImage1gen_image1

See also

reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain, paint_graypaint_grayPaintGrayPaintGraypaint_gray, gen_image_constgen_image_constGenImageConstGenImageConstgen_image_const

Module

Foundation