You are here: Start » Function Reference » Image » Image Local Transforms » OpenImage
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | FoundationLite |
Removes small bright structures from an image (or fills in dark ones) by applying consecutive erosion and dilation.
Applications: E.g. removal of the "salt" component of salt-and-pepper noise.
Syntax
void fil::OpenImage ( const fil::Image& inImage, ftl::Optional<const fil::Region&> inRoi, ftl::Optional<const fil::Region&> inSourceRoi, ftl::Optional<fil::Pixel> inBorderColor, fil::KernelShape::Type inKernel, int inRadiusX, ftl::Optional<int> inRadiusY, fil::Image& outImage, fil::Region& diagKernel )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | Input image | |||
inRoi | Optional<const Region&> | NIL | Range of outImage pixels to be computed | ||
inSourceRoi | Optional<const Region&> | NIL | Range of inImage pixels to be considered in computations | ||
inBorderColor | Optional<Pixel> | NIL | Color of the imaginary pixels outside the image boundaries | ||
inKernel | KernelShape::Type | Kernel shape | |||
inRadiusX | int | 0 - | 1 | Nearly half of the kernel's width (2*R+1) | |
inRadiusY | Optional<int> | 0 - | NIL | Nearly half of the kernel's height (2*R+1), or same as inRadiusX | |
outImage | Image& | Output image | |||
diagKernel | Region& | Kernel shape |
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.
Examples
Hardware Acceleration
This operation is optimized for SSE2 technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).
This operation is optimized for NEON technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).
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 OpenImage. |