IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit

Compute X and Y gradients of an input image convolving it with 2d Gaussian kernels. More...

IPSDKIPLFILTERING_API GradientXYImg ipsdk::imaproc::filter::gaussianGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDev)
 wrapper function for Gaussian filter used to compute gradient on a 2d image More...
 
IPSDKIPLFILTERING_API GradientXYImg ipsdk::imaproc::filter::gaussianGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDevX, const ipReal32 inStdDevY, const attr::GaussianCoverageConstPtr &pInOptGradientGaussianCoverage)
 wrapper function for Gaussian filter used to compute gradient on a 2d image More...
 
IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDevX, const ipReal32 inStdDevY, const attr::GaussianCoverageConstPtr &pInOptGradientGaussianCoverage, const image::ImagePtr &pOutOptGradXImg, const image::ImagePtr &pOutOptGradYImg)
 wrapper function for Gaussian filter used to compute gradient on a 2d image More...
 
IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::gaussianXGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDev)
 wrapper function for Gaussian filter used to compute gradient along x axis on a 2d image More...
 
IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianXGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDev, const attr::GaussianCoverageConstPtr &pInOptGradientGaussianCoverage, const image::ImagePtr &pOutOptGradXImg)
 wrapper function for Gaussian filter used to compute gradient along x axis on a 2d image More...
 
IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::gaussianYGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDev)
 wrapper function for Gaussian filter used to compute gradient along y axis on a 2d image More...
 
IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianYGradient2dImg (const image::ImageConstPtr &pInImg, const ipReal32 inStdDev, const attr::GaussianCoverageConstPtr &pInOptGradientGaussianCoverage, const image::ImagePtr &pOutOptGradYImg)
 wrapper function for Gaussian filter used to compute gradient along y axis on a 2d image More...
 

Detailed Description

Compute X and Y gradients of an input image convolving it with 2d Gaussian kernels.

Used Gaussian gradient kernel $GaussKnl^{X}_{XY}$ and $GaussKnl^{Y}_{XY}$ coefficients are defined as follow :

\[ GaussKnl^{X}_{XY}[o_x, o_y] = -\dfrac{o_x}{2\pi\sigma^4}e^{-\dfrac{o_x^2+o_y^2}{2\sigma^2}} \]

\[ GaussKnl^{Y}_{XY}[o_x, o_y] = -\dfrac{o_y}{2\pi\sigma^4}e^{-\dfrac{o_x^2+o_y^2}{2\sigma^2}} \]

where :

Size $[n_x, n_y]$ of this finite kernel is controlled by InOptGradientGaussianCoverage attribute.
This parameter defined the minimum distribution spread ratio which should be reach regards to an infinite Gaussian distribution.
We define for example $n_x$ such that :

\[ n_x = \max(MinHalfKernelSize, \min(\{n\}\in \mathbb{N}^+) / \sum_{o_x=-\dfrac{n_x}{2}}^{\dfrac{n_x}{2}}{GaussKnl_X[o_x]}>= GaussianRatio \times \sum_{o_x=-\infty}^{+\infty}{GaussKnl_X[o_x]}) \]

where :

\[ GaussKnl_X[o_x] = \dfrac{1}{\sqrt{2\pi}\sigma}e^{-\dfrac{o_x^2}{2\sigma^2}} \]

On output image values are given by:

\[ OutOptGradXImg[x, y] = \sum_{o_y=-\dfrac{n_y}{2}}^{\dfrac{n_y}{2}}{\sum_{o_x=-\dfrac{n_x}{2}}^{\dfrac{n_x}{2}}{InImg[x+o_x, y+o_y] \times GaussKnl^{X}_{XY}[o_x, o_y]}} \]

\[ OutOptGradYImg[x, y] = \sum_{o_y=-\dfrac{n_y}{2}}^{\dfrac{n_y}{2}}{\sum_{o_x=-\dfrac{n_x}{2}}^{\dfrac{n_x}{2}}{InImg[x+o_x, y+o_y] \times GaussKnl^{Y}_{XY}[o_x, o_y]}} \]

A detailled analysis of this filter has been done in J. Canny (1986) "A computational approach to edge detection", IEEE Trans. Pattern Analysis and Machine Intelligence, vol 8, pages 679-714.

Output images OutOptGradXImg and OutOptGradYImg are optional (at least one must be provided). Input and output images must have same size.

Here is an example of a Gaussian gradient operation applied to an 8-bits grey levels input image (with $InStdDev=3$):

gaussianGradient2d.png
See also
http://en.wikipedia.org/wiki/Edge_detection#cite_note-8

Attributes description

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg [Input] image for processing operation X
ipsdk::imaproc::attr::InStdDevX [Input] standard deviation used for operation along X axis X
ipsdk::imaproc::attr::InStdDevY [Input] standard deviation used for operation along Z axis X
ipsdk::imaproc::attr::InOptGradientGaussianCoverage [Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing X
ipsdk::imaproc::attr::OutOptGradXImg [Output Optional] image associated to X component of gradient computation promoteUnary (_pOutOptGradXImg, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutOptGradYImg [Output Optional] image associated to Y component of gradient computation promoteUnary (_pOutOptGradYImg, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)

Global Rule description

Global rule description for algorithm :
((ipsdk::processor::isSet (_pOutOptGradXImg) || 
  ipsdk::processor::isSet (_pOutOptGradYImg)) && 
 (ipsdk::processor::ifIsSet (_pOutOptGradXImg,
   ipsdk::imaproc::matchSize (_pInImg,_pOutOptGradXImg))) && 
 (ipsdk::processor::ifIsSet (_pOutOptGradYImg,
   ipsdk::imaproc::matchSize (_pInImg,_pOutOptGradYImg))))

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLFiltering as filter

Code Example

# opening of input images
inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
# gaussian gradient filter 2d computation
outGxImg, outGyImg = filter.gaussianGradient2dImg(inImg, 1.5)

Example of C++ code :

Example informations

Associated library

IPSDKIPLFiltering

Header file

Code Example

// opening input image
ImagePtr pInImg = loadTiffImageFile(inputImgPath);
// compute gaussian gradient on input image
GradientXYImg gradientXY = gaussianGradient2dImg(pInImg, inStdDev, inStdDev, createGaussianCoverage(inOptGaussianRatio, minHalfKernelSize));
See also
GaussianGradient2dImgLvl1

Function Documentation

◆ gaussianGradient2dImg() [1/3]

IPSDKIPLFILTERING_API GradientXYImg ipsdk::imaproc::filter::gaussianGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDev 
)

wrapper function for Gaussian filter used to compute gradient on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianXGradient2dImg() [1/2]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::gaussianXGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDev 
)

wrapper function for Gaussian filter used to compute gradient along x axis on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianYGradient2dImg() [1/2]

IPSDKIPLFILTERING_API image::ImagePtr ipsdk::imaproc::filter::gaussianYGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDev 
)

wrapper function for Gaussian filter used to compute gradient along y axis on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianGradient2dImg() [2/3]

IPSDKIPLFILTERING_API GradientXYImg ipsdk::imaproc::filter::gaussianGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDevX,
const ipReal32  inStdDevY,
const attr::GaussianCoverageConstPtr pInOptGradientGaussianCoverage 
)

wrapper function for Gaussian filter used to compute gradient on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianGradient2dImg() [3/3]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDevX,
const ipReal32  inStdDevY,
const attr::GaussianCoverageConstPtr pInOptGradientGaussianCoverage,
const image::ImagePtr pOutOptGradXImg,
const image::ImagePtr pOutOptGradYImg 
)

wrapper function for Gaussian filter used to compute gradient on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianXGradient2dImg() [2/2]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianXGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDev,
const attr::GaussianCoverageConstPtr pInOptGradientGaussianCoverage,
const image::ImagePtr pOutOptGradXImg 
)

wrapper function for Gaussian filter used to compute gradient along x axis on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ gaussianYGradient2dImg() [2/2]

IPSDKIPLFILTERING_API void ipsdk::imaproc::filter::gaussianYGradient2dImg ( const image::ImageConstPtr pInImg,
const ipReal32  inStdDev,
const attr::GaussianCoverageConstPtr pInOptGradientGaussianCoverage,
const image::ImagePtr pOutOptGradYImg 
)

wrapper function for Gaussian filter used to compute gradient along y axis on a 2d image

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure