SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::DoubleThresholdImageFilter Class Reference

Binarize an input image using double thresholding. More...

#include <sitkDoubleThresholdImageFilter.h>

+ Inheritance diagram for itk::simple::DoubleThresholdImageFilter:
+ Collaboration diagram for itk::simple::DoubleThresholdImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = DoubleThresholdImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 DoubleThresholdImageFilter ()
 
Image Execute (const Image &image1)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
bool GetFullyConnected () const
 
uint8_t GetInsideValue () const
 
std::string GetName () const
 
uint8_t GetOutsideValue () const
 
double GetThreshold1 () const
 
double GetThreshold2 () const
 
double GetThreshold3 () const
 
double GetThreshold4 () const
 
SelfSetFullyConnected (bool FullyConnected)
 
SelfSetInsideValue (uint8_t InsideValue)
 
SelfSetOutsideValue (uint8_t OutsideValue)
 
SelfSetThreshold1 (double Threshold1)
 
SelfSetThreshold2 (double Threshold2)
 
SelfSetThreshold3 (double Threshold3)
 
SelfSetThreshold4 (double Threshold4)
 
std::string ToString () const
 
virtual ~DoubleThresholdImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

bool m_FullyConnected {false}
 
uint8_t m_InsideValue {1u}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint8_t m_OutsideValue {0u}
 
double m_Threshold1 {0.0}
 
double m_Threshold2 {1.0}
 
double m_Threshold3 {254.0}
 
double m_Threshold4 {255.0}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Binarize an input image using double thresholding.

Double threshold addresses the difficulty in selecting a threshold that will select the objects of interest without selecting extraneous objects. Double threshold considers two threshold ranges: a narrow range and a wide range (where the wide range encompasses the narrow range). If the wide range was used for a traditional threshold (where values inside the range map to the foreground and values outside the range map to the background), many extraneous pixels may survive the threshold operation. If the narrow range was used for a traditional threshold, then too few pixels may survive the threshold.

Double threshold uses the narrow threshold image as a marker image and the wide threshold image as a mask image in the geodesic dilation. Essentially, the marker image (narrow threshold) is dilated but constrained to lie within the mask image (wide threshold). Thus, only the objects of interest (those pixels that survived the narrow threshold) are extracted but the those objects appear in the final image as they would have if the wide threshold was used.

See also
GrayscaleGeodesicDilateImageFilter
MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter
itk::simple::DoubleThreshold for the procedural interface
itk::DoubleThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 49 of file sitkDoubleThresholdImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::DoubleThresholdImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 153 of file sitkDoubleThresholdImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkDoubleThresholdImageFilter.h.

◆ Self

Definition at line 51 of file sitkDoubleThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ ~DoubleThresholdImageFilter()

virtual itk::simple::DoubleThresholdImageFilter::~DoubleThresholdImageFilter ( )
virtual

Destructor

◆ DoubleThresholdImageFilter()

itk::simple::DoubleThresholdImageFilter::DoubleThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::DoubleThresholdImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::DoubleThresholdImageFilter::ExecuteInternal ( const Image image1)
private

◆ FullyConnectedOff()

Self& itk::simple::DoubleThresholdImageFilter::FullyConnectedOff ( )
inline

Definition at line 131 of file sitkDoubleThresholdImageFilter.h.

◆ FullyConnectedOn()

Self& itk::simple::DoubleThresholdImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 130 of file sitkDoubleThresholdImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::DoubleThresholdImageFilter::GetFullyConnected ( ) const
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 136 of file sitkDoubleThresholdImageFilter.h.

◆ GetInsideValue()

uint8_t itk::simple::DoubleThresholdImageFilter::GetInsideValue ( ) const
inline

Get the "inside" pixel value.

Definition at line 112 of file sitkDoubleThresholdImageFilter.h.

◆ GetName()

std::string itk::simple::DoubleThresholdImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 139 of file sitkDoubleThresholdImageFilter.h.

◆ GetOutsideValue()

uint8_t itk::simple::DoubleThresholdImageFilter::GetOutsideValue ( ) const
inline

Get the "outside" pixel value.

Definition at line 122 of file sitkDoubleThresholdImageFilter.h.

◆ GetThreshold1()

double itk::simple::DoubleThresholdImageFilter::GetThreshold1 ( ) const
inline

Get the threshold values.

Definition at line 72 of file sitkDoubleThresholdImageFilter.h.

◆ GetThreshold2()

double itk::simple::DoubleThresholdImageFilter::GetThreshold2 ( ) const
inline

Get the threshold values.

Definition at line 82 of file sitkDoubleThresholdImageFilter.h.

◆ GetThreshold3()

double itk::simple::DoubleThresholdImageFilter::GetThreshold3 ( ) const
inline

Get the threshold values.

Definition at line 92 of file sitkDoubleThresholdImageFilter.h.

◆ GetThreshold4()

double itk::simple::DoubleThresholdImageFilter::GetThreshold4 ( ) const
inline

Get the threshold values.

Definition at line 102 of file sitkDoubleThresholdImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::DoubleThresholdImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 127 of file sitkDoubleThresholdImageFilter.h.

◆ SetInsideValue()

Self& itk::simple::DoubleThresholdImageFilter::SetInsideValue ( uint8_t  InsideValue)
inline

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

Definition at line 107 of file sitkDoubleThresholdImageFilter.h.

◆ SetOutsideValue()

Self& itk::simple::DoubleThresholdImageFilter::SetOutsideValue ( uint8_t  OutsideValue)
inline

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::ZeroValue() .

Definition at line 117 of file sitkDoubleThresholdImageFilter.h.

◆ SetThreshold1()

Self& itk::simple::DoubleThresholdImageFilter::SetThreshold1 ( double  Threshold1)
inline

Set the thresholds. Four thresholds should be specified. The two lower thresholds default to NumericTraits<InputPixelType>::NonpositiveMin() . The two upper thresholds default NumericTraits<InputPixelType>::max . Threshold1 <= Threshold2 <= Threshold3 <= Threshold4.

Definition at line 67 of file sitkDoubleThresholdImageFilter.h.

◆ SetThreshold2()

Self& itk::simple::DoubleThresholdImageFilter::SetThreshold2 ( double  Threshold2)
inline

Set the thresholds. Four thresholds should be specified. The two lower thresholds default to NumericTraits<InputPixelType>::NonpositiveMin() . The two upper thresholds default NumericTraits<InputPixelType>::max . Threshold1 <= Threshold2 <= Threshold3 <= Threshold4.

Definition at line 77 of file sitkDoubleThresholdImageFilter.h.

◆ SetThreshold3()

Self& itk::simple::DoubleThresholdImageFilter::SetThreshold3 ( double  Threshold3)
inline

Set the thresholds. Four thresholds should be specified. The two lower thresholds default to NumericTraits<InputPixelType>::NonpositiveMin() . The two upper thresholds default NumericTraits<InputPixelType>::max . Threshold1 <= Threshold2 <= Threshold3 <= Threshold4.

Definition at line 87 of file sitkDoubleThresholdImageFilter.h.

◆ SetThreshold4()

Self& itk::simple::DoubleThresholdImageFilter::SetThreshold4 ( double  Threshold4)
inline

Set the thresholds. Four thresholds should be specified. The two lower thresholds default to NumericTraits<InputPixelType>::NonpositiveMin() . The two upper thresholds default NumericTraits<InputPixelType>::max . Threshold1 <= Threshold2 <= Threshold3 <= Threshold4.

Definition at line 97 of file sitkDoubleThresholdImageFilter.h.

◆ ToString()

std::string itk::simple::DoubleThresholdImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 157 of file sitkDoubleThresholdImageFilter.h.

Member Data Documentation

◆ m_FullyConnected

bool itk::simple::DoubleThresholdImageFilter::m_FullyConnected {false}
private

Definition at line 174 of file sitkDoubleThresholdImageFilter.h.

◆ m_InsideValue

uint8_t itk::simple::DoubleThresholdImageFilter::m_InsideValue {1u}
private

Definition at line 170 of file sitkDoubleThresholdImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::DoubleThresholdImageFilter::m_MemberFactory
private

Definition at line 159 of file sitkDoubleThresholdImageFilter.h.

◆ m_OutsideValue

uint8_t itk::simple::DoubleThresholdImageFilter::m_OutsideValue {0u}
private

Definition at line 172 of file sitkDoubleThresholdImageFilter.h.

◆ m_Threshold1

double itk::simple::DoubleThresholdImageFilter::m_Threshold1 {0.0}
private

Definition at line 162 of file sitkDoubleThresholdImageFilter.h.

◆ m_Threshold2

double itk::simple::DoubleThresholdImageFilter::m_Threshold2 {1.0}
private

Definition at line 164 of file sitkDoubleThresholdImageFilter.h.

◆ m_Threshold3

double itk::simple::DoubleThresholdImageFilter::m_Threshold3 {254.0}
private

Definition at line 166 of file sitkDoubleThresholdImageFilter.h.

◆ m_Threshold4

double itk::simple::DoubleThresholdImageFilter::m_Threshold4 {255.0}
private

Definition at line 168 of file sitkDoubleThresholdImageFilter.h.


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