SimpleITK  1.3.0.dev210
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::MomentsThresholdImageFilter Class Reference

Threshold an image using the Moments Threshold. More...

#include <sitkMomentsThresholdImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef MomentsThresholdImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image, const Image &maskImage)
 
Image Execute (const Image &image)
 
Image Execute (const Image &image, const Image &maskImage, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue)
 
Image Execute (const Image &image, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue)
 
uint8_t GetInsideValue () const
 
bool GetMaskOutput () const
 
uint8_t GetMaskValue () const
 
std::string GetName () const
 
uint32_t GetNumberOfHistogramBins () const
 
uint8_t GetOutsideValue () const
 
double GetThreshold () const
 Get the computed threshold. More...
 
SelfMaskOutputOff ()
 
SelfMaskOutputOn ()
 
 MomentsThresholdImageFilter ()
 
SelfSetInsideValue (uint8_t InsideValue)
 
SelfSetMaskOutput (bool MaskOutput)
 
SelfSetMaskValue (uint8_t MaskValue)
 
SelfSetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)
 
SelfSetOutsideValue (uint8_t OutsideValue)
 
std::string ToString () const
 
virtual ~MomentsThresholdImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image *image, const Image *maskImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *maskImage)
 

Private Attributes

uint8_t m_InsideValue
 
bool m_MaskOutput
 
uint8_t m_MaskValue
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_NumberOfHistogramBins
 
uint8_t m_OutsideValue
 
double m_Threshold
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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

Threshold an image using the Moments Threshold.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the MomentsThresholdCalculator and applies that threshold 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: https://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811

See also
HistogramThresholdImageFilter
itk::simple::MomentsThreshold for the procedural interface
itk::MomentsThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkMomentsThresholdImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::MomentsThresholdImageFilter::MemberFunctionType) (const Image *image, const Image *maskImage)
private

Setup for member function dispatching

Definition at line 149 of file sitkMomentsThresholdImageFilter.h.

Define the pixels types supported by this filter

Definition at line 62 of file sitkMomentsThresholdImageFilter.h.

Definition at line 52 of file sitkMomentsThresholdImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::MomentsThresholdImageFilter::~MomentsThresholdImageFilter ( )
virtual

Destructor

itk::simple::MomentsThresholdImageFilter::MomentsThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::MomentsThresholdImageFilter::Execute ( const Image image,
const Image maskImage 
)

Execute the filter on the input image

Image itk::simple::MomentsThresholdImageFilter::Execute ( const Image image)
Image itk::simple::MomentsThresholdImageFilter::Execute ( const Image image,
const Image maskImage,
uint8_t  insideValue,
uint8_t  outsideValue,
uint32_t  numberOfHistogramBins,
bool  maskOutput,
uint8_t  maskValue 
)

Execute the filter on the input image with the given parameters

Image itk::simple::MomentsThresholdImageFilter::Execute ( const Image image,
uint8_t  insideValue,
uint8_t  outsideValue,
uint32_t  numberOfHistogramBins,
bool  maskOutput,
uint8_t  maskValue 
)
template<class TImageType >
Image itk::simple::MomentsThresholdImageFilter::ExecuteInternal ( const Image image,
const Image maskImage 
)
private
uint8_t itk::simple::MomentsThresholdImageFilter::GetInsideValue ( ) const
inline

Get the "inside" pixel value.

Definition at line 76 of file sitkMomentsThresholdImageFilter.h.

bool itk::simple::MomentsThresholdImageFilter::GetMaskOutput ( ) const
inline

Definition at line 111 of file sitkMomentsThresholdImageFilter.h.

uint8_t itk::simple::MomentsThresholdImageFilter::GetMaskValue ( ) const
inline

Definition at line 120 of file sitkMomentsThresholdImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 130 of file sitkMomentsThresholdImageFilter.h.

uint32_t itk::simple::MomentsThresholdImageFilter::GetNumberOfHistogramBins ( ) const
inline

Definition at line 98 of file sitkMomentsThresholdImageFilter.h.

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

Get the "outside" pixel value.

Definition at line 88 of file sitkMomentsThresholdImageFilter.h.

double itk::simple::MomentsThresholdImageFilter::GetThreshold ( ) const
inline

Get the computed threshold.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 127 of file sitkMomentsThresholdImageFilter.h.

Self& itk::simple::MomentsThresholdImageFilter::MaskOutputOff ( )
inline

Definition at line 107 of file sitkMomentsThresholdImageFilter.h.

Self& itk::simple::MomentsThresholdImageFilter::MaskOutputOn ( )
inline

Set the value of MaskOutput to true or false respectfully.

Definition at line 106 of file sitkMomentsThresholdImageFilter.h.

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

Set the "inside" pixel value.

Definition at line 70 of file sitkMomentsThresholdImageFilter.h.

Self& itk::simple::MomentsThresholdImageFilter::SetMaskOutput ( bool  MaskOutput)
inline

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use.

Definition at line 103 of file sitkMomentsThresholdImageFilter.h.

Self& itk::simple::MomentsThresholdImageFilter::SetMaskValue ( uint8_t  MaskValue)
inline

The value in the mask image, if used, indicating voxels that should be included. Default is the max of pixel type, as in the MaskedImageToHistogramFilter

Definition at line 116 of file sitkMomentsThresholdImageFilter.h.

Self& itk::simple::MomentsThresholdImageFilter::SetNumberOfHistogramBins ( uint32_t  NumberOfHistogramBins)
inline

Set/Get the number of histogram bins.

Definition at line 94 of file sitkMomentsThresholdImageFilter.h.

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

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

Definition at line 82 of file sitkMomentsThresholdImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 153 of file sitkMomentsThresholdImageFilter.h.

Member Data Documentation

uint8_t itk::simple::MomentsThresholdImageFilter::m_InsideValue
private

Definition at line 158 of file sitkMomentsThresholdImageFilter.h.

bool itk::simple::MomentsThresholdImageFilter::m_MaskOutput
private

Definition at line 161 of file sitkMomentsThresholdImageFilter.h.

uint8_t itk::simple::MomentsThresholdImageFilter::m_MaskValue
private

Definition at line 162 of file sitkMomentsThresholdImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::MomentsThresholdImageFilter::m_MemberFactory
private

Definition at line 155 of file sitkMomentsThresholdImageFilter.h.

uint32_t itk::simple::MomentsThresholdImageFilter::m_NumberOfHistogramBins
private

Definition at line 160 of file sitkMomentsThresholdImageFilter.h.

uint8_t itk::simple::MomentsThresholdImageFilter::m_OutsideValue
private

Definition at line 159 of file sitkMomentsThresholdImageFilter.h.

double itk::simple::MomentsThresholdImageFilter::m_Threshold
private

Definition at line 164 of file sitkMomentsThresholdImageFilter.h.


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