CheckPresence_PixelAmount_Deprecated

Module:	FoundationPro

Verifies object presence by analysing the amount of pixels that meet the specified criteria.

Quick and easy presence verification, e.g. for missing caps, screws, labels.

Name	Type	Range	Description
inImage	Image		Input image
inRoi	ShapeRegionDeprecated		Location at which object presence is being checked
inRoiAlignment	CoordinateSystem2D *		Adjusts the region of interest to the position of the inspected object
inColorModel	HSxColorModel		Selected color model
inBeginHue	Integer	0 - 255	Begin of the range of acceptable hue
inEndHue	Integer	0 - 255	End of the range of acceptable hue
inMinSaturation	Integer	0 - 255	Lowest acceptable saturation
inMaxSaturation	Integer *	0 - 255	Highest acceptable saturation
inMinBrightness	Real *	0.0 -	Lowest acceptable brightness
inMaxBrightness	Real *	0.0 -	Highest acceptable brightness
inMinAmount	Real	0.0 - 1.0	Lowest acceptable fraction of pixels meeting the criteria
inMaxAmount	Real	0.0 - 1.0	Highest acceptable fraction of pixels meeting the criteria
outIsPresent	Bool		Flag indicating whether the object is present or not
outAmount	Real		Fraction of pixels meeting the criteria
outForeground	Region		Region of pixels meeting the criteria
outAlignedRoi	ShapeRegionDeprecated		Input ROI after transformation (in the image coordinates)
diagHsxImage	Image		Image represented in chosen color model

For input inImage only pixel formats are supported: 3⨯uint8, 1⨯uint8, 1⨯int8, 1⨯uint16, 1⨯int16, 1⨯int32, 1⨯real.

Read more about pixel formats in Image documentation.

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
DomainError	Not supported inImage pixel format in CheckPresence_PixelAmount_Deprecated. Supported formats: 3xUInt8, 1xUInt8, 1xInt8, 1xUInt16, 1xInt16, 1xInt32, 1xReal.

This filter is available on Basic Complexity Level.