gen_image3_externgen_image3_externGenImage3ExternGenImage3Externgen_image3_extern (Operator)

Name

gen_image3_externgen_image3_externGenImage3ExternGenImage3Externgen_image3_extern — Create a three-channel image from three pointers on the pixels with storage management.

Signature

Description

The operator gen_image3_externgen_image3_externGenImage3ExternGenImage3ExternGenImage3Externgen_image3_extern creates a three-channel image of the size WidthWidthWidthWidthwidthwidth * HeightHeightHeightHeightheightheight. The pixels in PointerRedPointerRedPointerRedPointerRedpointerRedpointer_red, PointerGreenPointerGreenPointerGreenPointerGreenpointerGreenpointer_green, and PointerBluePointerBluePointerBluePointerBluepointerBluepointer_blue are stored line-sequentially. The type of the given pixels must correspond to TypeTypeTypeTypetypetype (see gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const for a more detailed description of the image types). 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.

The memory for the new image is not newly allocated by HALCON, contrary to gen_image3gen_image3GenImage3GenImage3GenImage3gen_image3, and thus is not copied either. This means that the memory space that PointerRedPointerRedPointerRedPointerRedpointerRedpointer_red, PointerGreenPointerGreenPointerGreenPointerGreenpointerGreenpointer_green, and PointerBluePointerBluePointerBluePointerBluepointerBluepointer_blue point to must be released by deleting the object ImageImageImageImageimageimage. This is done by the procedure ClearProcClearProcClearProcClearProcclearProcclear_proc provided by the caller. This procedure must have the following signature

void ClearProc(void* ptr);

and will be called using __cdecl calling convention when deleting ImageImageImageImageimageimage. If the memory shall not be released (in the case of frame grabbers or static memory) a procedure “without trunk” or the NULL-Pointer can be passed. Analogous to the parameters PointerRedPointerRedPointerRedPointerRedpointerRedpointer_red, PointerGreenPointerGreenPointerGreenPointerGreenpointerGreenpointer_green, and PointerBluePointerBluePointerBluePointerBluepointerBluepointer_blue the pointer has to be passed to the procedure depending on the used operator signature and programming environment.

Attention

gen_image3_externgen_image3_externGenImage3ExternGenImage3ExternGenImage3Externgen_image3_extern does not check if enough memory for an image of WidthWidthWidthWidthwidthwidth * HeightHeightHeightHeightheightheight is allocated in PointerRedPointerRedPointerRedPointerRedpointerRedpointer_red, PointerGreenPointerGreenPointerGreenPointerGreenpointerGreenpointer_green, and PointerBluePointerBluePointerBluePointerBluepointerBluepointer_blue.

Also, gen_image3_externgen_image3_externGenImage3ExternGenImage3ExternGenImage3Externgen_image3_extern does not check whether the pixels in PointerRedPointerRedPointerRedPointerRedpointerRedpointer_red, PointerGreenPointerGreenPointerGreenPointerGreenpointerGreenpointer_green, and PointerBluePointerBluePointerBluePointerBluepointerBluepointer_blue are valid or not. Thus, it must be ensured by the user that they are valid. Otherwise, the program may crash!

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

Example (C)

void NewImage(Hobject *new)
{
  unsigned char  *image_red;
  unsigned char  *image_green;
  unsigned char  *image_blue;
  int            r,c;
  image_red = malloc(640*480);
  image_green = malloc(640*480);
  image_blue = malloc(640*480);
  for (r=0; r<480; r++)
    for (c=0; c<640; c++)
    {
      image_red[r*640+c] = c % 255;
      image_green[r*640+c] = (c+64) % 255;
      image_blue[r*640+c] = (c+128) % 255;
    }
  gen_image3_extern(new,"byte",640,480,(Hlong)image_red,\
(Hlong)image_green,(Hlong)image_blue,(Hlong)free);
}

Result

The operator gen_image3_externgen_image3_externGenImage3ExternGenImage3ExternGenImage3Externgen_image3_extern returns the value 2 (H_MSG_TRUE) if the parameter values are correct. Otherwise an exception is raised.

Alternatives

gen_image3gen_image3GenImage3GenImage3GenImage3gen_image3, gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const, get_image_pointer3get_image_pointer3GetImagePointer3GetImagePointer3GetImagePointer3get_image_pointer3, gen_image1_externgen_image1_externGenImage1ExternGenImage1ExternGenImage1Externgen_image1_extern

See also

reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain, paint_graypaint_grayPaintGrayPaintGrayPaintGraypaint_gray, paint_regionpaint_regionPaintRegionPaintRegionPaintRegionpaint_region, set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayvalset_grayval

Module

Foundation