Erase

Algorithm allowing to erase values of an image. More...

IPSDKIPLUTILITY_API void	ipsdk::imaproc::util::eraseImg (const image::ImagePtr &pOutImg)
	wrapper function for image erasing algorithm More...
IPSDKIPLUTILITY_API void	ipsdk::imaproc::util::eraseImg (const image::ImagePtr &pOutImg, const ipReal64 inOptEraseValue)
	wrapper function for image erasing algorithm More...

Detailed Description

Algorithm allowing to erase values of an image.

This algorithm allows to erase values of an image with a given value .
On output image value are given by :

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InOptEraseValue	[Input optional] value used for image erasing operation	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	X

Global Rule description

Global rule description for algorithm :
ipsdk::processor::none ()

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLUtility as util

Code Example

    # image erasing with default 0 value
    img1 = PyIPSDK.createImage(PyIPSDK.eImageBufferType.eIBT_UInt8, 510, 509)
    util.eraseImg(img1)
    
    # image erasing with custom value
    img2 = PyIPSDK.createImage(img1.getGeometry())
    util.eraseImg(img2,  5)

Example of C++ code :

Example informations

Associated library

IPSDKIPLUtility

Header file

#include <IPSDKIPL/IPSDKIPLUtility/Processor/EraseImg/EraseImg.h>

Code Example

        // creation of an input image
        ImageGeometryPtr pImageGeometry = geometry2d(imageBufferType, sizeX, sizeY);
        boost::shared_ptr<MemoryImage> pInImg(boost::make_shared<MemoryImage>());
        pInImg->init(*pImageGeometry);
        
        // erase of image
        eraseImg(pInImg);

See also

EraseImgLvl1

EraseImgLvl2

EraseImgLvl3

Function Documentation

eraseImg() [1/2]

IPSDKIPLUTILITY_API void ipsdk::imaproc::util::eraseImg

(

const image::ImagePtr &

pOutImg

)

wrapper function for image erasing algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure

eraseImg() [2/2]

IPSDKIPLUTILITY_API void ipsdk::imaproc::util::eraseImg	(	const image::ImagePtr &	pOutImg,
		const ipReal64	inOptEraseValue
	)

wrapper function for image erasing algorithm

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

on failure