Threshold Class Reference

Public Member Functions
None	__init__ (self, Interval interval)
	Creates an instance of class Threshold.
Interval	interval (self)
	Returns the interval in which the threshold will be applied.
None	interval (self, Interval interval)
	Sets the thresholding interval.
Region	process (self, Union[Image, ids_peak_ipl.Image] image)

Static Public Member Functions
Interval	get_range (Union[Image, ids_peak_ipl.Image] image)
	Queries the minimum and maximum value of a given image and provides it as an interval.

Protected Attributes
Interval	_interval = interval

Detailed Description

Class for thresholding an image.

Since

ids_peak_icv 1.1

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Interval	interval )

Creates an instance of class Threshold.

Parameters

interval

The interval to be used.

Since

ids_peak_icv 1.1

Member Function Documentation

get_range()

Interval get_range ( Union[Image, ids_peak_ipl.Image] image )

static

Queries the minimum and maximum value of a given image and provides it as an interval.

Supported pixel formats

BayerGR8 BayerGR10 BayerGR12 BayerRG8 BayerRG10 BayerRG12 BayerGB8 BayerGB10 BayerGB12 BayerBG8

BayerBG10 BayerBG12 Mono8 Mono10 Mono12 Mono16 Confidence8 Confidence16 Coord3D_C8 Coord3D_C16

Coord3D_C32f Mono32fIDS Mono32f Mono8_I_A_B BayerRG8_I_A_B BayerBG8_I_A_B BayerGR8_I_A_B BayerGB8_I_A_B Mono10_I_A_B BayerRG10_I_A_B

BayerBG10_I_A_B BayerGR10_I_A_B BayerGB10_I_A_B Mono12_I_A_B BayerRG12_I_A_B BayerBG12_I_A_B BayerGR12_I_A_B BayerGB12_I_A_B Mono8_I_AB_CD Mono10_I_AB_CD

Mono12_I_AB_CD

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Parameters

image

An image to be thresholded.

Returns

Interval: Returns the maximum possible range of the given image.

Since

ids_peak_icv 1.1

interval() [1/2]

Interval interval

(

self

)

Returns the interval in which the threshold will be applied.

Since

ids_peak_icv 1.1

interval() [2/2]

None interval	(		self,
		Interval	interval )

Sets the thresholding interval.

Parameters

interval

The interval to be used.

Exceptions

OutOfRangeException

If the interval is out of range.

Since

ids_peak_icv 1.1

process()

Region process	(		self,
		Union[Image, ids_peak_ipl.Image]	image )

Field Documentation

_interval

Interval _interval = interval

protected