#include <itkBinaryThresholdImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >

Returns true is the value of an image lies within a range of thresholds This ImageFunction returns true (or false) if the pixel value lies within (outside) a lower and upper threshold value. The threshold range can be set with the ThresholdBelow, ThresholdBetween or ThresholdAbove methods. The input image is set via method SetInputImage().

Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluate the function at an geometric point, image index and continuous image index.

Definition at line 44 of file itkBinaryThresholdImageFunction.h.

Inheritance diagram for itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	PixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = BinaryThresholdImageFunction

using	Superclass = ImageFunction< TInputImage, bool, TCoordRep >

Public Types inherited from itk::ImageFunction< TInputImage, bool, float >
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< float, Self::ImageDimension >

using	CoordRepType = float

using	IndexType = typename InputImageType::IndexType

using	IndexValueType = typename InputImageType::IndexValueType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OutputType = bool

using	Pointer = SmartPointer< Self >

using	PointType = Point< float, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< float, Self::ImageDimension >, bool >

Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, bool >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< float, TInputImage::ImageDimension >

using	OutputType = bool

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
bool	Evaluate (const PointType &point) const override

bool	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override

bool	EvaluateAtIndex (const IndexType &index) const override

virtual const PixelType &	GetLower () const

const char *	GetNameOfClass () const override

virtual const PixelType &	GetUpper () const

void	ThresholdAbove (PixelType thresh)

void	ThresholdBelow (PixelType thresh)

void	ThresholdBetween (PixelType lower, PixelType upper)

Public Member Functions inherited from itk::ImageFunction< TInputImage, bool, float >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

OutputType	Evaluate (const PointType &point) const override=0

virtual bool	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0

virtual bool	EvaluateAtIndex (const IndexType &index) const=0

virtual const ContinuousIndexType &	GetEndContinuousIndex () const

virtual const IndexType &	GetEndIndex () const

const InputImageType *	GetInputImage () const

const char *	GetNameOfClass () const override

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const IndexType &	GetStartIndex () const

virtual void	SetInputImage (const InputImageType *ptr)

virtual bool	IsInsideBuffer (const IndexType &index) const

virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool	IsInsideBuffer (const PointType &point) const

void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

virtual OutputType	Evaluate (const InputType &input) const=0

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, bool, float >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	BinaryThresholdImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~BinaryThresholdImageFunction () override=default

Protected Member Functions inherited from itk::ImageFunction< TInputImage, bool, float >
	ImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, bool >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
PixelType	m_Lower {}

PixelType	m_Upper {}

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, bool, float >
ContinuousIndexType	m_EndContinuousIndex

IndexType	m_EndIndex

InputImageConstPointer	m_Image

ContinuousIndexType	m_StartContinuousIndex

IndexType	m_StartIndex

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = float>

using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkBinaryThresholdImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = float>

using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PixelType = typename TInputImage::PixelType

Typedef to describe the type of pixel.

Definition at line 65 of file itkBinaryThresholdImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>

using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkBinaryThresholdImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>

using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Self = BinaryThresholdImageFunction

Standard class type aliases.

Definition at line 50 of file itkBinaryThresholdImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>

using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, bool, TCoordRep>

Definition at line 51 of file itkBinaryThresholdImageFunction.h.

Constructor & Destructor Documentation

◆ BinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::BinaryThresholdImageFunction ( )

protected

◆ ~BinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::~BinaryThresholdImageFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>

bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType & point ) const

inlineoverridevirtual

BinaryThreshold the image at a point position

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, bool, float >.

Definition at line 89 of file itkBinaryThresholdImageFunction.h.

References itk::point().

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>

bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

inlineoverridevirtual

BinaryThreshold the image at a continuous index position

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, bool, float >.

Definition at line 106 of file itkBinaryThresholdImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>

bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType & index ) const

inlineoverridevirtual

BinaryThreshold the image at an index position.

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, bool, float >.

Definition at line 123 of file itkBinaryThresholdImageFunction.h.

◆ GetLower()

template<typename TInputImage , typename TCoordRep = float>

virtual const PixelType & itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetLower ( ) const

virtual

Get the lower threshold value.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

const char * itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetUpper()

template<typename TInputImage , typename TCoordRep = float>

virtual const PixelType & itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetUpper ( ) const

virtual

Get the upper threshold value.

◆ New()

template<typename TInputImage , typename TCoordRep = float>

static Pointer itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>

void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ ThresholdAbove()

template<typename TInputImage , typename TCoordRep = float>

void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdAbove ( PixelType thresh )

Values greater than or equal to the value are inside.

◆ ThresholdBelow()

template<typename TInputImage , typename TCoordRep = float>

void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBelow ( PixelType thresh )

Values less than or equal to the value are inside.

◆ ThresholdBetween()

template<typename TInputImage , typename TCoordRep = float>

void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBetween	(	PixelType	lower,
		PixelType	upper
	)

Values that lie between lower and upper inclusive are inside.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float>

constexpr unsigned int itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 68 of file itkBinaryThresholdImageFunction.h.

◆ m_Lower

template<typename TInputImage , typename TCoordRep = float>

PixelType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Lower {}

private

Definition at line 155 of file itkBinaryThresholdImageFunction.h.

◆ m_Upper

template<typename TInputImage , typename TCoordRep = float>

PixelType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Upper {}

private

Definition at line 156 of file itkBinaryThresholdImageFunction.h.

The documentation for this class was generated from the following file:

itkBinaryThresholdImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ PixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BinaryThresholdImageFunction()

◆ ~BinaryThresholdImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetLower()

◆ GetNameOfClass()

◆ GetUpper()

◆ New()

◆ PrintSelf()

◆ ThresholdAbove()

◆ ThresholdBelow()

◆ ThresholdBetween()

Member Data Documentation

◆ ImageDimension

◆ m_Lower

◆ m_Upper