gen_image3gen_image3GenImage3GenImage3 (Operator)


gen_image3gen_image3GenImage3GenImage3 — Create an image from three pointers to the pixels (red/green/blue).


gen_image3( : ImageRGB : Type, Width, Height, PixelPointerRed, PixelPointerGreen, PixelPointerBlue : )

Herror gen_image3(Hobject* ImageRGB, const char* Type, const Hlong Width, const Hlong Height, const Hlong PixelPointerRed, const Hlong PixelPointerGreen, const Hlong PixelPointerBlue)

Herror T_gen_image3(Hobject* ImageRGB, const Htuple Type, const Htuple Width, const Htuple Height, const Htuple PixelPointerRed, const Htuple PixelPointerGreen, const Htuple PixelPointerBlue)

void GenImage3(HObject* ImageRGB, const HTuple& Type, const HTuple& Width, const HTuple& Height, const HTuple& PixelPointerRed, const HTuple& PixelPointerGreen, const HTuple& PixelPointerBlue)

void HImage::GenImage3(const HString& Type, Hlong Width, Hlong Height, void* PixelPointerRed, void* PixelPointerGreen, void* PixelPointerBlue)

void HImage::GenImage3(const char* Type, Hlong Width, Hlong Height, void* PixelPointerRed, void* PixelPointerGreen, void* PixelPointerBlue)

void HImage::GenImage3(const wchar_t* Type, Hlong Width, Hlong Height, void* PixelPointerRed, void* PixelPointerGreen, void* PixelPointerBlue)   (Windows only)

static void HOperatorSet.GenImage3(out HObject imageRGB, HTuple type, HTuple width, HTuple height, HTuple pixelPointerRed, HTuple pixelPointerGreen, HTuple pixelPointerBlue)

void HImage.GenImage3(string type, int width, int height, IntPtr pixelPointerRed, IntPtr pixelPointerGreen, IntPtr pixelPointerBlue)


The operator gen_image3gen_image3GenImage3GenImage3GenImage3 creates a three-channel image of the size WidthWidthWidthWidthwidth * HeightHeightHeightHeightheight. The pixels in PixelPointerRedPixelPointerRedPixelPointerRedPixelPointerRedpixelPointerRed, PixelPointerGreenPixelPointerGreenPixelPointerGreenPixelPointerGreenpixelPointerGreen and PixelPointerBluePixelPointerBluePixelPointerBluePixelPointerBluepixelPointerBlue are stored line-sequentially. The type of the given pixels (PixelPointerRedPixelPointerRedPixelPointerRedPixelPointerRedpixelPointerRed etc.) must correspond to TypeTypeTypeTypetype (see gen_image_constgen_image_constGenImageConstGenImageConstGenImageConst for a more detailed description of the pixel types). The storage for the new image is newly created by HALCON. Thus, it can be released after the call. Note that how to pass a pointer value depends on the used operator signature and programming environment. Make sure to pass the actual memory address where the image data is stored, not the address of a pointer variable. Care must be taken not to truncate 64-bit pointers on 64-bit architectures.


gen_image3gen_image3GenImage3GenImage3GenImage3 does not check whether the pixels in PixelPointerRedPixelPointerRedPixelPointerRedPixelPointerRedpixelPointerRed,PixelPointerGreenPixelPointerGreenPixelPointerGreenPixelPointerGreenpixelPointerGreen, and PixelPointerBluePixelPointerBluePixelPointerBluePixelPointerBluepixelPointerBlue are valid or not. Thus, it must be ensured by the user that they are valid. Otherwise, the program may crash!

Execution Information


ImageRGBImageRGBImageRGBImageRGBimageRGB (output_object)  image objectHImageHImageHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real)

Created image with new image matrix.

TypeTypeTypeTypetype (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Pixel type.

Default value: 'byte' "byte" "byte" "byte" "byte"

List of values: 'byte'"byte""byte""byte""byte", 'cyclic'"cyclic""cyclic""cyclic""cyclic", 'direction'"direction""direction""direction""direction", 'int1'"int1""int1""int1""int1", 'int2'"int2""int2""int2""int2", 'int4'"int4""int4""int4""int4", 'real'"real""real""real""real", 'uint2'"uint2""uint2""uint2""uint2"

WidthWidthWidthWidthwidth (input_control)  extent.x HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of image.

Default value: 512

Suggested values: 128, 256, 512, 1024

Typical range of values: 1 ≤ Width Width Width Width width ≤ 512 (lin)

Minimum increment: 1

Recommended increment: 10

HeightHeightHeightHeightheight (input_control)  extent.y HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of image.

Default value: 512

Suggested values: 128, 256, 512, 1024

Typical range of values: 1 ≤ Height Height Height Height height ≤ 512 (lin)

Minimum increment: 1

Recommended increment: 10

PixelPointerRedPixelPointerRedPixelPointerRedPixelPointerRedpixelPointerRed (input_control)  pointer HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Pointer to first red value (channel 1).

PixelPointerGreenPixelPointerGreenPixelPointerGreenPixelPointerGreenpixelPointerGreen (input_control)  pointer HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Pointer to first green value (channel 2).

PixelPointerBluePixelPointerBluePixelPointerBluePixelPointerBluepixelPointerBlue (input_control)  pointer HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Pointer to first blue value (channel 3).

Example (C)

void NewRGBImage(Hobject *new)
  unsigned char  red[768*525];
  unsigned char  green[768*525];
  unsigned char  blue[768*525];
  int            r,c;
  for (r=0; r<525; r++)
    for (c=0; c<768; c++)
      red[r*768+c]   = c % 255;
      green[r*768+c] = (767 - c) % 255;
      blue[r*768+c]  = r % 255;

  Hobject  rgb;


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

Possible Predecessors

gen_image_constgen_image_constGenImageConstGenImageConstGenImageConst, get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1GetImagePointer1

Possible Successors



gen_image1gen_image1GenImage1GenImage1GenImage1, compose3compose3Compose3Compose3Compose3, gen_image_constgen_image_constGenImageConstGenImageConstGenImageConst

See also

reduce_domainreduce_domainReduceDomainReduceDomainReduceDomain, paint_graypaint_grayPaintGrayPaintGrayPaintGray, paint_regionpaint_regionPaintRegionPaintRegionPaintRegion, set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayval, get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1GetImagePointer1, decompose3decompose3Decompose3Decompose3Decompose3