Operator Reference

HALCON Operator Reference / Filters / Arithmetic
ClassesClasses | | Operators

log_imagelog_imageLogImageLogImagelog_image (Operator)

log_imagelog_imageLogImageLogImagelog_image — Calculate the logarithm of an image.

Signature

log_image(Image : LogImage : Base : )

Herror log_image(const Hobject Image, Hobject* LogImage, const char* Base)

Herror T_log_image(const Hobject Image, Hobject* LogImage, const Htuple Base)

void LogImage(const HObject& Image, HObject* LogImage, const HTuple& Base)

HImage HImage::LogImage(const HTuple& Base) const

HImage HImage::LogImage(const HString& Base) const

HImage HImage::LogImage(const char* Base) const

HImage HImage::LogImage(const wchar_t* Base) const   ( Windows only)

static void HOperatorSet.LogImage(HObject image, out HObject logImage, HTuple baseVal)

HImage HImage.LogImage(HTuple baseVal)

HImage HImage.LogImage(string baseVal)

def log_image(image: HObject, base: Union[int, float, str]) -> HObject

Description

log_imagelog_imageLogImageLogImagelog_image calculates the logarithm to the base BaseBaseBasebaseValbase of an input image ImageImageImageimageimage and stores the result in the image LogImageLogImageLogImagelogImagelog_image. If ImageImageImageimageimage contains gray values outside the valid domain of the logarithm function, i.e., , the corresponding gray values in LogImageLogImageLogImagelogImagelog_image are set to 0.

Attention

log_imagelog_imageLogImageLogImagelog_image can be executed on an OpenCL device for byte, int1, int2, uint2, int4, and real images. Note that the results of the OpenCL code may vary from the results produced by the CPU.

Execution Information

  • Supports OpenCL compute devices.
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on tuple level.
  • Automatically parallelized on channel level.
  • Automatically parallelized on domain level.

Parameters

ImageImageImageimageimage (input_object)  (multichannel-)image(-array) → objectHImageHObjectHObjectHobject (byte* / int1* / uint2* / int2* / int4* / int8 / real*) *allowed for compute devices

Input image.

LogImageLogImageLogImagelogImagelog_image (output_object)  (multichannel-)image(-array) → objectHImageHObjectHObjectHobject * (real)

Output image.

BaseBaseBasebaseValbase (input_control)  number → HTupleUnion[int, float, str]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Base of the logarithm.

Default: 'e' "e" "e" "e" "e"

Suggested values: 'e'"e""e""e""e", 2, 10

See also

pow_imagepow_imagePowImagePowImagepow_image, exp_imageexp_imageExpImageExpImageexp_image

Module

Foundation

ClassesClasses | | Operators