itk::BinaryThresholdImageFunction< TInputImage, TCoordRep > Class Template Reference
[Image Functions]

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(). More...

#include <itkBinaryThresholdImageFunction.h>

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

[legend]Collaboration diagram for itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >:

[legend]List of all members.

Public Types
typedef BinaryThresholdImageFunction	Self
typedef ImageFunction< TInputImage, bool, TCoordRep >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageType	InputImageType
typedef TInputImage::PixelType	PixelType
typedef Superclass::PointType	PointType
typedef Superclass::IndexType	IndexType
typedef Superclass::ContinuousIndexType	ContinuousIndexType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual bool	Evaluate (const PointType &point) const
virtual bool	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const
virtual const PixelType &	GetLower ()
virtual const PixelType &	GetUpper ()
void	ThresholdAbove (PixelType thresh)
void	ThresholdBelow (PixelType thresh)
void	ThresholdBetween (PixelType lower, PixelType upper)
virtual bool	EvaluateAtIndex (const IndexType &index) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BinaryThresholdImageFunction ()
	~BinaryThresholdImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class 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 41 of file itkBinaryThresholdImageFunction.h.

---

Member Typedef Documentation

template<class TInputImage, class TCoordRep = float> typedef SmartPointer<const Self> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ConstPointer

Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 49 of file itkBinaryThresholdImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::ContinuousIndexType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support. Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 73 of file itkBinaryThresholdImageFunction.h. Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex().

template<class TInputImage, class TCoordRep = float> typedef Superclass::IndexType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support. Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 70 of file itkBinaryThresholdImageFunction.h. Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate(), itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex(), and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex().

template<class TInputImage, class TCoordRep = float> typedef Superclass::InputImageType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support. Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 58 of file itkBinaryThresholdImageFunction.h.

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

Typedef to describe the type of pixel. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 61 of file itkBinaryThresholdImageFunction.h. Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::~BinaryThresholdImageFunction().

template<class TInputImage, class TCoordRep = float> typedef SmartPointer<Self> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Pointer

Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 48 of file itkBinaryThresholdImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::PointType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support. Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 67 of file itkBinaryThresholdImageFunction.h. Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate().

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

Standard class typedefs. Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 46 of file itkBinaryThresholdImageFunction.h. Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::~BinaryThresholdImageFunction().

template<class TInputImage, class TCoordRep = float> typedef ImageFunction<TInputImage,bool,TCoordRep> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Superclass

Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 47 of file itkBinaryThresholdImageFunction.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TCoordRep = float> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::BinaryThresholdImageFunction (   )  [protected]

template<class TInputImage, class TCoordRep = float> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::~BinaryThresholdImageFunction (   )  [inline, protected]

Definition at line 140 of file itkBinaryThresholdImageFunction.h. References itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PixelType, and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Self.

---

Member Function Documentation

template<class TInputImage, class TCoordRep = float> virtual bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate (  const PointType &  point  )  const [inline, virtual]

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, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 84 of file itkBinaryThresholdImageFunction.h. References itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::IndexType, and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PointType.

template<class TInputImage, class TCoordRep = float> virtual bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex (  const ContinuousIndexType &  index  )  const [inline, virtual]

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, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 99 of file itkBinaryThresholdImageFunction.h. References itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ContinuousIndexType, and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::IndexType.

template<class TInputImage, class TCoordRep = float> virtual bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex (  const IndexType &  index  )  const [inline, virtual]

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, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 116 of file itkBinaryThresholdImageFunction.h. References itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::IndexType, and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PixelType.

template<class TInputImage, class TCoordRep = float> virtual const PixelType& itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetLower (   )  [virtual]

Get the lower threshold value.

template<class TInputImage, class TCoordRep = float> virtual const char* itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

template<class TInputImage, class TCoordRep = float> virtual const PixelType& itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetUpper (   )  [virtual]

Get the upper threshold value.

template<class TInputImage, class TCoordRep = float> itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::itkStaticConstMacro (  ImageDimension  , unsigned  int, Superclass::ImageDimension  )

Dimension underlying input image.

template<class TInputImage, class TCoordRep = float> Pointer itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

template<class TInputImage, class TCoordRep = float> void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::ImageFunction< TInputImage, bool, TCoordRep >. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

template<class TInputImage, class TCoordRep = float> void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdAbove (  PixelType  thresh  )

Values greater than or equal to the value are inside.

template<class TInputImage, class TCoordRep = float> void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBelow (  PixelType  thresh  )

Values less than or equal to the value are inside.

template<class TInputImage, class TCoordRep = float> void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBetween (  PixelType  lower, PixelType  upper )

Values that lie between lower and upper inclusive are inside.

---

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

• itkBinaryThresholdImageFunction.h

---