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

BinaryThreshold projection. More...

#include <sitkBinaryThresholdProjectionImageFilter.h>

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

Public Types

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

Public Member Functions

 BinaryThresholdProjectionImageFilter ()
 
Image Execute (const Image &image1)
 
uint8_t GetBackgroundValue () const
 
uint8_t GetForegroundValue () const
 
std::string GetName () const
 
unsigned int GetProjectionDimension () const
 
double GetThresholdValue () const
 
SelfSetBackgroundValue (uint8_t BackgroundValue)
 
SelfSetForegroundValue (uint8_t ForegroundValue)
 
SelfSetProjectionDimension (unsigned int ProjectionDimension)
 
SelfSetThresholdValue (double ThresholdValue)
 
std::string ToString () const
 
virtual ~BinaryThresholdProjectionImageFilter ()
 
- 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

uint8_t m_BackgroundValue {0u}
 
uint8_t m_ForegroundValue {1u}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
unsigned int m_ProjectionDimension {0u}
 
double m_ThresholdValue {0.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

BinaryThreshold projection.

This class was contributed to the Insight Journal by Gaetan Lehmann. the original paper can be found at https://hdl.handle.net/1926/164

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
ProjectionImageFilter
MedianProjectionImageFilter
MeanProjectionImageFilter
MeanProjectionImageFilter
MaximumProjectionImageFilter
MinimumProjectionImageFilter
StandardDeviationProjectionImageFilter
SumProjectionImageFilter
itk::simple::BinaryThresholdProjection for the procedural interface
itk::BinaryThresholdProjectionImageFilter for the Doxygen on the original ITK class.

Definition at line 68 of file sitkBinaryThresholdProjectionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 136 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 80 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ Self

Definition at line 70 of file sitkBinaryThresholdProjectionImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryThresholdProjectionImageFilter()

virtual itk::simple::BinaryThresholdProjectionImageFilter::~BinaryThresholdProjectionImageFilter ( )
virtual

Destructor

◆ BinaryThresholdProjectionImageFilter()

itk::simple::BinaryThresholdProjectionImageFilter::BinaryThresholdProjectionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

uint8_t itk::simple::BinaryThresholdProjectionImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the output value used as "background". Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 119 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ GetForegroundValue()

uint8_t itk::simple::BinaryThresholdProjectionImageFilter::GetForegroundValue ( ) const
inline

Set/Get the output value used as "foreground". Defaults to maximum value of PixelType.

Definition at line 109 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ GetProjectionDimension()

unsigned int itk::simple::BinaryThresholdProjectionImageFilter::GetProjectionDimension ( ) const
inline

Definition at line 89 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ GetThresholdValue()

double itk::simple::BinaryThresholdProjectionImageFilter::GetThresholdValue ( ) const
inline

Set/Get the input value consider as "threshold". Defaults to NumericTraits<InputPixelType>::max()

Definition at line 99 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::BinaryThresholdProjectionImageFilter::SetBackgroundValue ( uint8_t  BackgroundValue)
inline

Set/Get the output value used as "background". Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 114 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::BinaryThresholdProjectionImageFilter::SetForegroundValue ( uint8_t  ForegroundValue)
inline

Set/Get the output value used as "foreground". Defaults to maximum value of PixelType.

Definition at line 104 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ SetProjectionDimension()

Self& itk::simple::BinaryThresholdProjectionImageFilter::SetProjectionDimension ( unsigned int  ProjectionDimension)
inline

Definition at line 85 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ SetThresholdValue()

Self& itk::simple::BinaryThresholdProjectionImageFilter::SetThresholdValue ( double  ThresholdValue)
inline

Set/Get the input value consider as "threshold". Defaults to NumericTraits<InputPixelType>::max()

Definition at line 94 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 140 of file sitkBinaryThresholdProjectionImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

uint8_t itk::simple::BinaryThresholdProjectionImageFilter::m_BackgroundValue {0u}
private

Definition at line 151 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ m_ForegroundValue

uint8_t itk::simple::BinaryThresholdProjectionImageFilter::m_ForegroundValue {1u}
private

Definition at line 149 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ m_MemberFactory

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

Definition at line 142 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ m_ProjectionDimension

unsigned int itk::simple::BinaryThresholdProjectionImageFilter::m_ProjectionDimension {0u}
private

Definition at line 145 of file sitkBinaryThresholdProjectionImageFilter.h.

◆ m_ThresholdValue

double itk::simple::BinaryThresholdProjectionImageFilter::m_ThresholdValue {0.0}
private

Definition at line 147 of file sitkBinaryThresholdProjectionImageFilter.h.


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