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)
	Applies a threshold on a given single-channel image and returns a region with selected pixels whose gray values are in the range Interval.minimum <= gray value <= Interval.maximum.

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

Definition at line 16 of file threshold.py.

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

Definition at line 25 of file threshold.py.

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.

Parameters

image

An image of type Mono8, Mono10, Mono12 or Coord3D.

Returns

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

Since

ids_peak_icv 1.1

Definition at line 104 of file threshold.py.

interval() [1/2]

Interval interval

(

self

)

Returns the interval in which the threshold will be applied.

Since

ids_peak_icv 1.1

Definition at line 37 of file threshold.py.

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

Definition at line 47 of file threshold.py.

process()

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

Applies a threshold on a given single-channel image and returns a region with selected pixels whose gray values are in the range Interval.minimum <= gray value <= Interval.maximum.

Parameters

image

An image of type Mono8, Mono10, Mono12 or Coord3D.

Returns

Region: Returns a region with selected pixels.

Exceptions

OutOfRangeException	If the interval is out of bounds for the pixel format.
NotPossibleException	If the image is too big for processing.

Since

ids_peak_icv 1.1

Definition at line 60 of file threshold.py.

Field Documentation

_interval

Interval _interval = interval

protected

Definition at line 34 of file threshold.py.