You are here: Start » Function Reference » All Functions » Image Point Transforms » AvsFilter_LogarithmImage
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Header: | AVL.h |
---|---|
Namespace: | avs |
Module: | FoundationLite |
Computes a natural logarithm of each pixel.
Applications: Transforms an image in such a way that a quotient on the input image becomes a difference on the output image. This can be useful for dealing with variable illumination.
Syntax
void avs::AvsFilter_LogarithmImage ( AvsFilters_ImagePointTransformsState& ioState, const avl::Image& inImage, atl::Optional<const avl::Region&> inRoi, atl::Optional<const float&> inScale, float inOffset, bool inNormalizeZero, avl::Image& outImage, avl::Profile& diagLutProfile )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | AvsFilters_ImagePointTransformsState& | Object used to maintain state of the function. | |||
inImage | const Image& | Input image | |||
inRoi | Optional<const Region&> | NIL | Region of interest | ||
inScale | Optional<const float&> | NIL | Scaling factor (default: 255) | ||
inOffset | float | 1.0 - | 1.0f | Offset factor | |
inNormalizeZero | bool | Specifies whether the output range should be rescaled to start from 0 | |||
outImage | Image& | Output image | |||
diagLutProfile | Profile& | Profile depicting the resulting look-up table of the logarithm transform |
Requirements
For input inImage only pixel formats are supported: int8, uint8, int16, uint16, int32.
Read more about pixel formats in Image documentation.
In-place Processing
This function supports in-place data processing - you can pass the same reference to inImage and outImage
Read more about In-place Computation.
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Region exceeds an input image in LogarithmImage. |
DomainError | Not supported inImage pixel format in AvsFilter_LogarithmImage. Supported formats: Int8, UInt8, Int16, UInt16, Int32. |