Threshold< IntervalType > Class Template Reference

#include <peak_icv/algorithms/thresholds/peak_icv_threshold.hpp>

Public Member Functions
	Threshold (const IntervalType &interval)
	Creates an instance of class Threshold.
	Threshold (typename IntervalType::type minimum, typename IntervalType::type maximum)
	Creates an instance of class Threshold.
peak::icv::experimental::Region	Process (const Image &image) const
	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
static IntervalType	GetRange (const Image &image)
	Queries the minimum and maximum value of a given image and provides it as an interval.

Detailed Description

template<typename IntervalType>
class peak::icv::detail::Threshold< IntervalType >

Class for thresholding an image.

Template Parameters

Interval

shall only be interval types

Warning

This function is still in development and not released.

Definition at line 37 of file peak_icv_threshold.hpp.

Constructor & Destructor Documentation

Threshold() [1/2]

template<typename IntervalType >

Threshold ( const IntervalType & interval )

explicit

Creates an instance of class Threshold.

Parameters

[in]

interval

Interval with lower and upper threshold value.

Warning

This function is still in development and not released.

Definition at line 118 of file peak_icv_threshold.hpp.

Threshold() [2/2]

template<typename IntervalType >

Threshold ( typename IntervalType::type minimum, typename IntervalType::type maximum )

explicit

Creates an instance of class Threshold.

Parameters

[in]	minimum	Lower threshold value.
[in]	maximum	Upper threshold value.

Warning

This function is still in development and not released.

Definition at line 123 of file peak_icv_threshold.hpp.

Member Function Documentation

GetRange()

template<typename IntervalType >

IntervalType GetRange ( const Image & image )

static

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

Parameters

[in]

image

This is the image for which the range is calculated.

Returns

Returns the maximum possible range of the given image.

Warning

This function is still in development and not released.

Definition at line 143 of file peak_icv_threshold.hpp.

Process()

template<typename IntervalType >

peak::icv::experimental::Region Process

(

const Image &

image

)

const

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

[in]

image

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

Returns

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.

Warning

This function is still in development and not released.

Definition at line 128 of file peak_icv_threshold.hpp.