RichardsonLucyDeconvolution2dImg_Grp

IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipBool bStaturateImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipReal32 epsilonValue)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipReal32 epsilonValue, const ipBool bStaturateImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const image::ImagePtr &pOutRealImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipBool bStaturateImg, const image::ImagePtr &pOutRealImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipReal32 epsilonValue, const image::ImagePtr &pOutRealImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg (const image::ImageConstPtr &pInRealImg, const KernelXYConstPtr &pInKnlXY, const ipUInt32 nbIter, const ipReal32 epsilonValue, const ipBool bStaturateImg, const image::ImagePtr &pOutRealImg)
	wrapper function for Richardson-Lucy deconvolution algorithm More...

Detailed Description

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InRealImg	[Input] image for processing operation (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::InKnlXY	[Input] kernel xy for processing operation	X
ipsdk::imaproc::attr::InNbIter	[Input] Number of iterations for an iterative algorithm	X
ipsdk::imaproc::attr::InOptEpsilon	[Input Optional] Epsilon value, used to consider lower values as zero	X
ipsdk::imaproc::attr::InOptSaturateOutput	[Input Optional] Flag indicating if the ouput must be normalized	X
ipsdk::imaproc::attr::OutWk1BinImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk1BinImg, _pInRealImg, ipsdk::image::eImageBufferType::eIBT_Binary)
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk1RealImg, _pInRealImg, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutRealImg	[Output] image for processing operation (data contained in image buffer are reals)	duplicateInOut (_pOutRealImg, _pInRealImg, ipsdk::image::eImageBufferType::eIBT_Real32)

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::matchSize (_pInRealImg,_pOutRealImg) && 
ipsdk::imaproc::matchSize (_pInRealImg,_pOutWk1RealImg) && 
ipsdk::imaproc::matchSize (_pInRealImg,_pOutWk1BinImg)

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLFiltering as filter

Code Example

    # opening of input images
    geom = PyIPSDK.geometry2d(PyIPSDK.eImageBufferType.eIBT_Real32, 510, 509)
    inImg = PyIPSDK.loadRawImageFile(inputImgPath, geom)
    
    # create a processing kernel
    inKnl = PyIPSDK.rectangularKernelXY(1, 1, [1/9, 1/9, 1/9, 1/9, 1/9, 1/9, 1/9, 1/9, 1/9])
    
    # deconvolution filter 2d computation without normalization
    outImg = filter.richardsonLucyDeconvolution2dImg(inImg, inKnl, 50)

    # deconvolution filter 2d computation with normalization
    outNormalizedImg = filter.richardsonLucyDeconvolution2dImg(inImg, inKnl, 50, True)

Example of C++ code :

Example informations

Associated library

IPSDKIPLFiltering

Header file

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

Code Example

        // opening input image
        ImagePtr pInImg = loadRawImageFile(inputImgPath, *pGeometry);
        
        // compute un-normalized deconvolution on input image
        ImagePtr pOutImg = richardsonLucyDeconvolution2dImg(pInImg, pInKnlXY, 50);
        ImagePtr pOutImg_normalized = richardsonLucyDeconvolution2dImg(pInImg, pInKnlXY, 50, true);

See also

RichardsonLucyDeconvolution2dImgLvl1

Function Documentation

richardsonLucyDeconvolution2dImg() [1/8]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [2/8]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipBool	bStaturateImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [3/8]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipReal32	epsilonValue
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [4/8]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipReal32	epsilonValue,
		const ipBool	bStaturateImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [5/8]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const image::ImagePtr &	pOutRealImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [6/8]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipBool	bStaturateImg,
		const image::ImagePtr &	pOutRealImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [7/8]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipReal32	epsilonValue,
		const image::ImagePtr &	pOutRealImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

richardsonLucyDeconvolution2dImg() [8/8]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::richardsonLucyDeconvolution2dImg	(	const image::ImageConstPtr &	pInRealImg,
		const KernelXYConstPtr &	pInKnlXY,
		const ipUInt32	nbIter,
		const ipReal32	epsilonValue,
		const ipBool	bStaturateImg,
		const image::ImagePtr &	pOutRealImg
	)

wrapper function for Richardson-Lucy deconvolution algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure