Z Stack Focus Ponderation

function computing a contrasted image by ponderation along the Z axis More...

IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...
IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg, const ipUInt32 inOptContrastRadius)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...
IPSDKIPLFILTERING_API image::ImagePtr	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg, const ipUInt32 inOptContrastRadius, const ipUInt32 inOptMeanSmoothingValue, const ipReal32 inOptZoomFactor)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg, const image::ImagePtr &pOutImg)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg, const ipUInt32 inOptContrastRadius, const image::ImagePtr &pOutImg)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...
IPSDKIPLFILTERING_API void	ipsdk::imaproc::filter::zStackFocusPonderationImg (const image::ImageConstPtr &pInImg, const ipUInt32 inOptContrastRadius, const ipUInt32 inOptMeanSmoothingValue, const ipReal32 inOptZoomFactor, const image::ImagePtr &pOutImg)
	wrapper function for function computing a contrasted image by ponderation along the Z axis More...

Detailed Description

function computing a contrasted image by ponderation along the Z axis

The Z stack focus by pondaration computes the contrast of pixels for each plan of a 3D image, then averages the pixels of each plans according to their contrast.

The parameters of this filter are :

• is the radius of the structuring element used to compute the contrast. With a low value for we are more sensitive to small details but also to noise. The default value is 10.
• defines the way the different plans are combined. If the value is too low the transitions between plans won't be smooth, and if the value is too high it will results in a blurred image. The default value is 1.
• is the factor by which the image is resized before processing. A low value allows us to save time during the process. The lower this value is, the more we are sensitive to macro elements in the image, instead of small details. The defaut value is 1.

Here is an example with default parameters.

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InOptZoomFactor	[Input Optional] z-size of 3d output image	X
ipsdk::imaproc::attr::InOptContrastRadius	[Input Optional] contrast radius for Z focus	X
ipsdk::imaproc::attr::InOptMeanSmoothingValue	[Input Optional] mean smoothing value for Z focus	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk1Img, outputZoom3d(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk2Img, outputZoom3d(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk3Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk3Img, outputZoom3dGrey(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk1RealImg, outputZoom2dGreyReal(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk2RealImg, outputZoom3dGreyReal(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk1BinImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk1BinImg, outputZoom3dGreyBin(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk3RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk3RealImg, duplicateGreyReal(_pInImg3d))
ipsdk::imaproc::attr::OutWk4RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk4RealImg, duplicate2dGreyReal(_pInImg3d))
ipsdk::imaproc::attr::OutOptWk1RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutWk5RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk5RealImg, duplicate2dReal(_pInImg3d))
ipsdk::imaproc::attr::OutImg2d	[Output] 2d image for processing operation	duplicate2dInOut (_pOutImg2d, _pInImg3d)

Global Rule description

Global rule description for algorithm :
(ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_Z,_pInImg3d,_pOutWk1Img) && 
 ipsdk::imaproc::matchSize (_pOutWk1Img,_pOutWk2Img) && 
 ipsdk::processor::ifIsSet (
  _pOutOptWk1Img, (
   ipsdk::imaproc::isGrey (_pInImg3d) || 
   ipsdk::imaproc::matchSize (_pOutWk1Img,_pOutOptWk1Img))) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk3Img) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pOutWk1Img,_pOutWk1RealImg) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk2RealImg) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk1BinImg) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInImg3d,_pOutWk3RealImg) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutWk4RealImg) && 
 ipsdk::processor::ifIsSet (
  _pOutOptWk1RealImg, (
   ipsdk::imaproc::isGrey (_pInImg3d) || 
   ipsdk::imaproc::matchSize (_pInImg3d,_pOutOptWk1RealImg))) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutWk5RealImg) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutImg2d) && 
 ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_C,_pInImg3d,_pOutImg2d))

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLFiltering as filter

Code Example

    # opening of input images
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)

    # Optional parameters
    smoothing = 1
    zoomFactor = 0.25
    contrastRay = 1
    # Z stack focus ponderation
    outImg = filter.zStackFocusPonderationImg(inImg, contrastRay, smoothing, zoomFactor)

Example of C++ code :

Example informations

Associated library

IPSDKIPLFiltering

Header file

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

Code Example

    // opening input image
    ImagePtr pInImg = loadTiffImageFile(inputImgPath);

    // define optionals parameters
    ipUInt32 meanSmoothingValue = 1;
    ipReal32 zoomFactor = 0.25;
    ipUInt16 contrastRadius = 1;

    // compute Z stack focus ponderation on input image
    ImagePtr pOutImg = zStackFocusPonderationImg(pInImg, contrastRadius,meanSmoothingValue,zoomFactor);

See also

ZStackFocusPonderationImgLvl1

Function Documentation

zStackFocusPonderationImg() [1/6]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::zStackFocusPonderationImg

(

const image::ImageConstPtr &

pInImg

)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

zStackFocusPonderationImg() [2/6]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::zStackFocusPonderationImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inOptContrastRadius
	)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

zStackFocusPonderationImg() [3/6]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::zStackFocusPonderationImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inOptContrastRadius,
		const ipUInt32	inOptMeanSmoothingValue,
		const ipReal32	inOptZoomFactor
	)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

zStackFocusPonderationImg() [4/6]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::zStackFocusPonderationImg	(	const image::ImageConstPtr &	pInImg,
		const image::ImagePtr &	pOutImg
	)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

zStackFocusPonderationImg() [5/6]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::zStackFocusPonderationImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inOptContrastRadius,
		const image::ImagePtr &	pOutImg
	)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

zStackFocusPonderationImg() [6/6]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::zStackFocusPonderationImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inOptContrastRadius,
		const ipUInt32	inOptMeanSmoothingValue,
		const ipReal32	inOptZoomFactor,
		const image::ImagePtr &	pOutImg
	)

wrapper function for function computing a contrasted image by ponderation along the Z axis

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure