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

Threshold an image using a HistogramThresholdCalculator. More...

#include <itkHistogramThresholdImageFilter.h>

Inheritance diagram for itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef CalculatorType::Pointer CalculatorPointer
typedef
HistogramThresholdCalculator
< HistogramType,
InputPixelType
CalculatorType
typedef SmartPointer< const SelfConstPointer
typedef HistogramType::ConstPointer HistogramConstPointer
typedef
HistogramType::MeasurementType 
HistogramMeasurementType
typedef
HistogramType::MeasurementVectorType 
HistogramMeasurementVectorType
typedef HistogramType::Pointer HistogramPointer
typedef HistogramType::SizeType HistogramSizeType
typedef Statistics::Histogram
< ValueRealType
HistogramType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef InputImageType::IndexType InputIndexType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::SizeType InputSizeType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef OutputImageType::IndexType OutputIndexType
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::SizeType OutputSizeType
typedef SmartPointer< SelfPointer
typedef
HistogramThresholdImageFilter 
Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
typedef NumericTraits
< ValueType >::RealType 
ValueRealType
typedef NumericTraits
< InputPixelType >::ValueType 
ValueType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual OutputPixelType GetInsideValue () const
virtual const char * GetNameOfClass () const
virtual OutputPixelType GetOutsideValue () const
virtual InputPixelType GetThreshold () const
virtual void SetInsideValue (OutputPixelType _arg)
virtual void SetOutsideValue (OutputPixelType _arg)
 typedef (Concept::OStreamWritable< InputPixelType >) InputOStreamWritableCheck
 typedef (Concept::EqualityComparable< OutputPixelType >) OutputEqualityComparableCheck
 typedef (Concept::OStreamWritable< OutputPixelType >) OutputOStreamWritableCheck
virtual void SetNumberOfHistogramBins (unsigned int _arg)
virtual unsigned int GetNumberOfHistogramBins () const
virtual void SetAutoMinimumMaximum (bool _arg)
virtual bool GetAutoMinimumMaximum () const
virtual void AutoMinimumMaximumOn ()
virtual void AutoMinimumMaximumOff ()
virtual void SetCalculator (CalculatorType *_arg)
virtual CalculatorTypeGetCalculator ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = InputImageType::ImageDimension
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension

Protected Member Functions

void GenerateData ()
void GenerateInputRequestedRegion ()
 HistogramThresholdImageFilter ()
 ~HistogramThresholdImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Private Member Functions

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

Private Attributes

bool m_AutoMinimumMaximum
CalculatorPointer m_Calculator
OutputPixelType m_InsideValue
unsigned m_NumberOfHistogramBins
OutputPixelType m_OutsideValue
InputPixelType m_Threshold

Detailed Description

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

Threshold an image using a HistogramThresholdCalculator.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using a user provided HistogramThresholdCalculator and applies that theshold to the input image using the BinaryThresholdImageFilter.

Author:
Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811

Definition at line 50 of file itkHistogramThresholdImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef CalculatorType::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::CalculatorPointer

Definition at line 94 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef HistogramThresholdCalculator<HistogramType, InputPixelType> itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::CalculatorType
template<class TInputImage , class TOutputImage >
typedef SmartPointer<const Self> itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef HistogramType::ConstPointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramConstPointer

Definition at line 88 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef HistogramType::MeasurementType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramMeasurementType

Definition at line 90 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef HistogramType::MeasurementVectorType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramMeasurementVectorType

Definition at line 91 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef HistogramType::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramPointer

Definition at line 87 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef HistogramType::SizeType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramSizeType

Definition at line 89 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Statistics::Histogram< ValueRealType > itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::HistogramType
template<class TInputImage , class TOutputImage >
typedef InputImageType::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputImageType
template<class TInputImage , class TOutputImage >
typedef InputImageType::IndexType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputIndexType
template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputPixelType
template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputSizeType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputImagePointer
template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputImageType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::IndexType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputIndexType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::SizeType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputSizeType
template<class TInputImage , class TOutputImage >
typedef SmartPointer<Self> itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef HistogramThresholdImageFilter itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::Self
template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter<TInputImage,TOutputImage> itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::Superclass
template<class TInputImage , class TOutputImage >
typedef NumericTraits< ValueType >::RealType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::ValueRealType

Definition at line 85 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef NumericTraits< InputPixelType >::ValueType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::ValueType

Definition at line 84 of file itkHistogramThresholdImageFilter.h.


Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 150 of file itkHistogramThresholdImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::AutoMinimumMaximumOff ( ) [virtual]

Does histogram generator compute min and max from data? Default is false for all but char types

template<class TInputImage , class TOutputImage >
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::AutoMinimumMaximumOn ( ) [virtual]

Does histogram generator compute min and max from data? Default is false for all but char types

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]
template<class TInputImage , class TOutputImage >
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

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

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::GetAutoMinimumMaximum ( ) const [virtual]

Does histogram generator compute min and max from data? Default is false for all but char types

template<class TInputImage , class TOutputImage >
virtual CalculatorType* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::GetCalculator ( ) [virtual]

Set/Get the calculator to use to compute the threshold

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

Get the "inside" pixel value.

template<class TInputImage , class TOutputImage >
virtual const char* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TOutputImage >
virtual unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::GetNumberOfHistogramBins ( ) const [virtual]

Set the number of histogram bins

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

Get the "outside" pixel value.

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

Get the computed threshold.

template<class TInputImage , class TOutputImage >
static Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::New ( ) [static]
template<class TInputImage , class TOutputImage >
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]
template<class TInputImage , class TOutputImage >
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
template<class TInputImage , class TOutputImage >
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::SetAutoMinimumMaximum ( bool  _arg) [virtual]

Does histogram generator compute min and max from data? Default is false for all but char types

template<class TInputImage , class TOutputImage >
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::SetCalculator ( CalculatorType _arg) [virtual]

Set/Get the calculator to use to compute the threshold

template<class TInputImage , class TOutputImage >
virtual void itk::HistogramThresholdImageFilter< 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::HistogramThresholdImageFilter< TInputImage, TOutputImage >::SetNumberOfHistogramBins ( unsigned int  _arg) [virtual]

Set the number of histogram bins

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

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

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

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

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

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

template<class TInputImage , class TOutputImage >
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::typedef ( Concept::EqualityComparable< OutputPixelType )

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


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::InputImageDimension = InputImageType::ImageDimension [static]
template<class TInputImage , class TOutputImage >
bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::m_AutoMinimumMaximum [private]

Definition at line 166 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
CalculatorPointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::m_Calculator [private]

Definition at line 164 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 161 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::m_NumberOfHistogramBins [private]

Definition at line 165 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 162 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
InputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::m_Threshold [private]

Definition at line 163 of file itkHistogramThresholdImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage >::OutputImageDimension = OutputImageType::ImageDimension [static]

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