itk::BinaryThresholdImageFilter< TInputImage, TOutputImage > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Binarize an input image by thresholding. More...

#include <itkBinaryThresholdImageFilter.h>

Inheritance diagram for itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef BinaryThresholdImageFilter	Self
typedef UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< typename TInputImage::PixelType, typename TOutputImage::PixelType > >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::PixelType	InputPixelType
typedef TOutputImage::PixelType	OutputPixelType
typedef SimpleDataObjectDecorator< InputPixelType >	InputPixelObjectType
enum	{ PixelTypeComparable = 0 }
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetOutsideValue (OutputPixelType _arg)
virtual OutputPixelType	GetOutsideValue ()
virtual void	SetInsideValue (OutputPixelType _arg)
virtual OutputPixelType	GetInsideValue ()
virtual void	SetUpperThreshold (const InputPixelType threshold)
virtual void	SetUpperThresholdInput (const InputPixelObjectType *)
virtual void	SetLowerThreshold (const InputPixelType threshold)
virtual void	SetLowerThresholdInput (const InputPixelObjectType *)
virtual InputPixelType	GetUpperThreshold () const
virtual InputPixelObjectType *	GetUpperThresholdInput ()
virtual const InputPixelObjectType *	GetUpperThresholdInput () const
virtual InputPixelType	GetLowerThreshold () const
virtual InputPixelObjectType *	GetLowerThresholdInput ()
virtual const InputPixelObjectType *	GetLowerThresholdInput () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BinaryThresholdImageFilter ()
virtual	~BinaryThresholdImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	BeforeThreadedGenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >

Binarize an input image by thresholding.

This filter produces an output image whose pixels are either one of two values ( OutsideValue or InsideValue ), depending on whether of not the corresponding input image pixel lie between the two thresholds ( LowerThreshold and UpperThreshold ). Values equal to either threshold is considered to be between the thresholds.

This filter is templated over the input image type and the output image type.

The filter expect both images to have the same number of dimensions.

Definition at line 81 of file itkBinaryThresholdImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >. Definition at line 97 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SimpleDataObjectDecorator<InputPixelType> itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::InputPixelObjectType

Type of DataObjects to use for scalar inputs Definition at line 113 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::PixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::InputPixelType

Pixel types. Definition at line 106 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 107 of file itkBinaryThresholdImageFilter.h. Referenced by itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::~BinaryThresholdImageFilter().

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >. Definition at line 96 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef BinaryThresholdImageFilter itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >. Definition at line 90 of file itkBinaryThresholdImageFilter.h. Referenced by itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::~BinaryThresholdImageFilter().

template<class TInputImage, class TOutputImage> typedef UnaryFunctorImageFilter<TInputImage,TOutputImage, Functor::BinaryThreshold< typename TInputImage::PixelType, typename TOutputImage::PixelType> > itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >. Definition at line 95 of file itkBinaryThresholdImageFilter.h.

---

Member Enumeration Documentation

template<class TInputImage, class TOutputImage> anonymous enum

The input pixel type must support comparison operators. Enumeration values: PixelTypeComparable  Definition at line 110 of file itkBinaryThresholdImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::BinaryThresholdImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage> virtual itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::~BinaryThresholdImageFilter (   )  [inline, protected, virtual]

Definition at line 150 of file itkBinaryThresholdImageFilter.h. References itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType, and itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData (   )  [protected, virtual]

This method is used to set the state of the filter before multi-threading. Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> virtual OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetInsideValue (   )  [virtual]

Get the "inside" pixel value.

template<class TInputImage, class TOutputImage> virtual InputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThreshold (   )  const [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput (   )  const [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> virtual InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput (   )  [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> virtual const char* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >.

template<class TInputImage, class TOutputImage> virtual OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetOutsideValue (   )  [virtual]

Get the "outside" pixel value.

template<class TInputImage, class TOutputImage> virtual InputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThreshold (   )  const [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput (   )  const [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> virtual InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput (   )  [virtual]

Get the threshold values.

template<class TInputImage, class TOutputImage> Pointer itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >.

template<class TInputImage, class TOutputImage> void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::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::InPlaceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetInsideValue (  OutputPixelType  _arg  )  [virtual]

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetLowerThreshold (  const InputPixelType  threshold  )  [virtual]

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin(). The default upper threshold is NumericTraits<InputPixelType>::max. An execption is thrown if the lower threshold is greater than the upper threshold.

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetLowerThresholdInput (  const InputPixelObjectType *   )  [virtual]

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin(). The default upper threshold is NumericTraits<InputPixelType>::max. An execption is thrown if the lower threshold is greater than the upper threshold.

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetOutsideValue (  OutputPixelType  _arg  )  [virtual]

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::Zero.

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetUpperThreshold (  const InputPixelType  threshold  )  [virtual]

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin(). The default upper threshold is NumericTraits<InputPixelType>::max. An execption is thrown if the lower threshold is greater than the upper threshold.

template<class TInputImage, class TOutputImage> virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetUpperThresholdInput (  const InputPixelObjectType *   )  [virtual]

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin(). The default upper threshold is NumericTraits<InputPixelType>::max. An execption is thrown if the lower threshold is greater than the upper threshold.

---

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

• itkBinaryThresholdImageFilter.h

---