ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkBinaryThresholdImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
SimpleDataObjectDecorator
< InputPixelType
InputPixelObjectType
typedef TInputImage::PixelType InputPixelType
typedef TOutputImage::PixelType OutputPixelType
typedef SmartPointer< SelfPointer
typedef BinaryThresholdImageFilter Self
typedef
UnaryFunctorImageFilter
< TInputImage, TOutputImage,
Functor::BinaryThreshold
< typename
TInputImage::PixelType,
typename
TOutputImage::PixelType > > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const OutputPixelTypeGetInsideValue ()
virtual InputPixelType GetLowerThreshold () const
virtual InputPixelObjectTypeGetLowerThresholdInput ()
virtual const
InputPixelObjectType
GetLowerThresholdInput () const
virtual const char * GetNameOfClass () const
virtual const OutputPixelTypeGetOutsideValue ()
virtual InputPixelType GetUpperThreshold () const
virtual InputPixelObjectTypeGetUpperThresholdInput ()
virtual const
InputPixelObjectType
GetUpperThresholdInput () const
virtual void SetInsideValue (OutputPixelType _arg)
virtual void SetLowerThreshold (const InputPixelType threshold)
virtual void SetLowerThresholdInput (const InputPixelObjectType *)
virtual void SetOutsideValue (OutputPixelType _arg)
virtual void SetUpperThreshold (const InputPixelType threshold)
virtual void SetUpperThresholdInput (const InputPixelObjectType *)
 typedef (Concept::EqualityComparable< OutputPixelType >) OutputEqualityComparableCheck
 typedef (Concept::Comparable< InputPixelType >) InputPixelTypeComparable
 typedef (Concept::OStreamWritable< InputPixelType >) InputOStreamWritableCheck
 typedef (Concept::OStreamWritable< OutputPixelType >) OutputOStreamWritableCheck

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Private Member Functions

 BinaryThresholdImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

OutputPixelType m_InsideValue
OutputPixelType m_OutsideValue

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 the corresponding input image pixels lie between the two thresholds ( LowerThreshold and UpperThreshold ). Values equal to either threshold is considered to be between the thresholds.

More precisely

\[ Output(x_i) = \begin{cases} InsideValue & \text{if $LowerThreshold \leq x_i \leq UpperThreshold$} \\ OutsideValue & \text{otherwise} \end{cases} \]

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.

The default values for LowerThreshold and UpperThreshold are: LowerThreshold = NumericTraits<TInput>::NonpositiveMin(); UpperThreshold = NumericTraits<TInput>::max(); Therefore, generally only one of these needs to be set, depending on whether the user wants to threshold above or below the desired threshold.

Wiki Examples:

Definition at line 123 of file itkBinaryThresholdImageFilter.h.


Member Typedef Documentation

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

Type of DataObjects to use for scalar inputs

Definition at line 152 of file itkBinaryThresholdImageFilter.h.

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

Pixel types.

Definition at line 145 of file itkBinaryThresholdImageFilter.h.

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

Definition at line 149 of file itkBinaryThresholdImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 208 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::BinaryThresholdImageFilter ( const Self ) [private]

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::itk::LightObject::Pointer itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >.

template<class TInputImage , class TOutputImage >
virtual const 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]
template<class TInputImage , class TOutputImage >
virtual InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput ( ) [virtual]
template<class TInputImage , class TOutputImage >
virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput ( ) const [virtual]
template<class TInputImage , class TOutputImage >
virtual const char* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TOutputImage >
virtual const 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 InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput ( ) [virtual]
template<class TInputImage , class TOutputImage >
virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput ( ) const [virtual]
template<class TInputImage , class TOutputImage >
static Pointer itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::New ( ) [static]
template<class TInputImage , class TOutputImage >
void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >.

template<class TInputImage , class TOutputImage >
void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

End concept checking

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]
template<class TInputImage , class TOutputImage >
virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetLowerThresholdInput ( const InputPixelObjectType ) [virtual]
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]
template<class TInputImage , class TOutputImage >
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::typedef ( Concept::EqualityComparable< OutputPixelType )

Begin concept checking This class requires OutputEqualityComparableCheck in the form of ( Concept::EqualityComparable< OutputPixelType > )

template<class TInputImage , class TOutputImage >
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Comparable< InputPixelType )

This class requires InputPixelTypeComparable in the form of ( Concept::Comparable< InputPixelType > )

template<class TInputImage , class TOutputImage >
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::typedef ( Concept::OStreamWritable< InputPixelType )

This class requires InputOStreamWritableCheck in the form of ( Concept::OStreamWritable< InputPixelType > )

template<class TInputImage , class TOutputImage >
itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::typedef ( Concept::OStreamWritable< OutputPixelType )

This class requires OutputOStreamWritableCheck in the form of ( Concept::OStreamWritable< OutputPixelType > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::m_InsideValue [private]

Definition at line 220 of file itkBinaryThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::m_OutsideValue [private]

Definition at line 221 of file itkBinaryThresholdImageFilter.h.


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