Morphological Gradient 3d

gradient computation on a 3d image using morphological operations More...

IPSDKIPLBASICMORPHOLOGY_API image::ImagePtr	ipsdk::imaproc::morpho::morphoGradient3dImg (const image::ImageConstPtr &pInImg3d, const StructuringElementXYZInfoConstPtr &pInSEXYZ)
	wrapper function for gradient computation on a 3d image using morphological operations More...
IPSDKIPLBASICMORPHOLOGY_API void	ipsdk::imaproc::morpho::morphoGradient3dImg (const image::ImageConstPtr &pInImg3d, const StructuringElementXYZInfoConstPtr &pInSEXYZ, const image::ImagePtr &pOutImg)
	wrapper function for gradient computation on a 3d image using morphological operations More...

Detailed Description

gradient computation on a 3d image using morphological operations

A morphological gradient is the difference between the dilation and the erosion of a given image. It is a fast way to compute the gradient of an image. Output image pixel values, given a structuring element , are given by the following formula :

Note

Behavior of this algorithm is specialized using specific morphological structuring elements (see 3d structuring elements for more informations about these shapes).
Please refer to Usage for examples of usage of different types of specific structuring elements during morphological operations.

An example of morphological gradient operation is illustrated in 2d case : see Morphological Gradient 2d.

See also

http://en.wikipedia.org/wiki/Morphological_gradient

Note

This algorithm is associated with two temporary working images ipsdk::imaproc::attr::OutOptWk1Img and ipsdk::imaproc::attr::OutWk1Img.

• The first one (ipsdk::imaproc::attr::OutOptWk1Img) is only used in special processing cases defined via ipsdk::imaproc::morpho::eSEProcessingCase enumerate. Such situation can be tested using ipsdk::imaproc::morpho::getSEProcessingCase function and associated image buffer type can be retrieved using ipsdk::imaproc::morpho::getSEWkImageBufferType. This working temporary image can be provided by user or will be automatically allocated when requested.
• The second one (ipsdk::imaproc::attr::OutWk1Img) is systematically needed for internal processing. This working temporary image can be provided by user or will be automatically allocated.

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InSEXYZ	[Input] structuring element xyz for processing operation	X
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	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 (_pInImg3d,_pOutWk1Img)) && 
 (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutImg)) && 
 (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutWk1Img)) && 
 (ipsdk::processor::ifIsSet (
   _pOutOptWk1Img, (
    ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutOptWk1Img)) && 
   (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutOptWk1Img)))))

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLBasicMorphology as morpho

Code Example

    # opening of input image
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
    
    # definition of used structuring element
    inSE = PyIPSDK.sphericalSEXYZInfo(2)
    
    # morphological gradient 3d image computation
    outImg = morpho.morphoGradient3dImg(inImg, inSE)

Example of C++ code :

Example informations

Associated library

IPSDKIPLBasicMorphology

Header file

#include <IPSDKIPL/IPSDKIPLBasicMorphology/Processor/MorphoGradient3dImg/MorphoGradient3dImg.h>

Code Example

    // create a 2x3x4 rectangular structuring element
    StructuringElementXYZInfoConstPtr pInSEXYZ = genericSEXYZInfo(*rectangularSEXYZ(2, 3, 4));

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

    // compute morphological gradient on input image
    ImagePtr pOutImg = morphoGradient3dImg(pInImg, pInSEXYZ);

See also

MorphoGradient3dImgLvl1

Function Documentation

morphoGradient3dImg() [1/2]

IPSDKIPLBASICMORPHOLOGY_API image::ImagePtr ipsdk::imaproc::morpho::morphoGradient3dImg	(	const image::ImageConstPtr &	pInImg3d,
		const StructuringElementXYZInfoConstPtr &	pInSEXYZ
	)

wrapper function for gradient computation on a 3d image using morphological operations

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

morphoGradient3dImg() [2/2]

IPSDKIPLBASICMORPHOLOGY_API void ipsdk::imaproc::morpho::morphoGradient3dImg	(	const image::ImageConstPtr &	pInImg3d,
		const StructuringElementXYZInfoConstPtr &	pInSEXYZ,
		const image::ImagePtr &	pOutImg
	)

wrapper function for gradient computation on a 3d image using morphological operations

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure