log_imagelog_imageLogImageLogImage (Operator)


log_imagelog_imageLogImageLogImage — Calculate the logarithm of an image.


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)


log_imagelog_imageLogImageLogImageLogImage calculates the logarithm to the base BaseBaseBaseBasebaseVal of an input image ImageImageImageImageimage and stores the result in the image LogImageLogImageLogImageLogImagelogImage. If ImageImageImageImageimage contains gray values outside the valid domain of the logarithm function, i.e., , the corresponding gray values in LogImageLogImageLogImageLogImagelogImage are set to 0.


log_imagelog_imageLogImageLogImageLogImage 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


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

Input image.

LogImageLogImageLogImageLogImagelogImage (output_object)  (multichannel-)image(-array) objectHImageHImageHobject * (real)

Output image.

BaseBaseBaseBasebaseVal (input_control)  number HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Base of the logarithm.

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

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

See also

pow_imagepow_imagePowImagePowImagePowImage, exp_imageexp_imageExpImageExpImageExpImage