unsharp mask filtering of input 3d image More...

IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::unsharpMask3dImg (const image::ImageConstPtr &pInImg3d, const ipReal32 inBlurWeight, const ipReal32 inStdDev)
	wrapper function for unsharp mask filtering of input 3d image More...

IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::unsharpMask3dImg (const image::ImageConstPtr &pInImg3d, const ipReal32 inBlurWeight, const ipReal32 inStdDev, const attr::GaussianCoverageConstPtr &pInOptSmoothingGaussianCoverage)
	wrapper function for unsharp mask filtering of input 3d image More...

IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::unsharpMask3dImg (const image::ImageConstPtr &pInImg3d, const ipReal32 inBlurWeight, const ipReal32 inStdDev, const attr::GaussianCoverageConstPtr &pInOptSmoothingGaussianCoverage, const image::ImagePtr &pOutImg)
	wrapper function for unsharp mask filtering of input 3d image More...

Detailed Description

unsharp mask filtering of input 3d image

Unsharp mask filter is an image sharpening filter which uses a blurred (so unsharped) image to create a mask of the original image. This unsharp mask is then combined with original image to enhance high frequencies (edges) of input image. An undesirable side effect of this filter is an increase of noise in output image.

Given a gaussian smoothing operation on an input image $InImg$ using standard deviation $\sigma=InStdDev$ :

$G_{\sigma}(InImg[x, y, z]) = \sum_{o_z=-\dfrac{n_z}{2}}^{\dfrac{n_z}{2}}{\sum_{o_y=-\dfrac{n_y}{2}}^{\dfrac{n_y}{2}}{\sum_{o_x=-\dfrac{n_x}{2}}^{\dfrac{n_x}{2}}{InImg3d[x+o_x, y+o_y, z+o_z] \times GaussKnl^{\sigma}_{XYZ}[o_x, o_y, o_z]}}}$

(see Gaussian Smoothing 3d for more informations)

Unsharp mask filtering of input image with blur weight $w=InBlurWeight \in ]0;1]$ is given by :

$OutImg = \dfrac{w+1}{2w}InImg + \dfrac{w-1}{2w}G_{\sigma}(InImg)$

See Unsharp Mask 2d for an illustration of unsharp mask on a 2d image

See also: http://en.wikipedia.org/wiki/Unsharp_masking

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InBlurWeight	[Input] weight factor used for blur combination operation	X
ipsdk::imaproc::attr::InStdDev	[Input] standard deviation used for operation along all axis	X
ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage	[Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk1Img, _pInImg3d)
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	ipsdk::imaproc::duplicateInOut (_pOutImg, _pInImg3d)

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutImg) &&
ipsdk::imaproc::matchSizeAndType (_pOutImg,_pOutWk1Img) &&
ipsdk::imaproc::noInSitu (_pInImg3d,_pOutWk1Img) &&
ipsdk::imaproc::noInSitu (_pOutImg,_pOutWk1Img)

Example of Python code :

Example imports

import PyIPSDK

import PyIPSDK.IPSDKIPLFiltering as filter

Code Example

    # opening of input images
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
    
    # unsharp mask 3d computation
    outImg = filter.unsharpMask3dImg(inImg, 0.7, 1.0)

Example of C++ code :

Example informations

Associated library

IPSDKIPLFiltering

Header file

#include <IPSDKIPL/IPSDKIPLFiltering/Processor/UnsharpMask3dImg/UnsharpMask3dImg.h>

Code Example

    // opening input image
    ImagePtr pInImg = loadTiffImageFile(inputImgPath, eTiffDirectoryMode::eTDM_Volume);
        
    // compute unsharp mask filter on input image
    ImagePtr pOutImg1 = unsharpMask3dImg(pInImg, 0.7f, 1.0f);

See also: UnsharpMask3dImgLvl1

Function Documentation

◆ unsharpMask3dImg() [1/3]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::unsharpMask3dImg	(	const image::ImageConstPtr &	pInImg3d,
		const ipReal32	inBlurWeight,
		const ipReal32	inStdDev
	)

wrapper function for unsharp mask filtering of input 3d image

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ unsharpMask3dImg() [2/3]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::unsharpMask3dImg	(	const image::ImageConstPtr &	pInImg3d,
		const ipReal32	inBlurWeight,
		const ipReal32	inStdDev,
		const attr::GaussianCoverageConstPtr &	pInOptSmoothingGaussianCoverage
	)

wrapper function for unsharp mask filtering of input 3d image

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ unsharpMask3dImg() [3/3]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::unsharpMask3dImg	(	const image::ImageConstPtr &	pInImg3d,
		const ipReal32	inBlurWeight,
		const ipReal32	inStdDev,
		const attr::GaussianCoverageConstPtr &	pInOptSmoothingGaussianCoverage,
		const image::ImagePtr &	pOutImg
	)

wrapper function for unsharp mask filtering of input 3d image

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure