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

Mask an image with the negation (or logical compliment) of a mask. More...

#include <sitkMaskNegatedImageFilter.h>

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

Public Types

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

Public Member Functions

Image Execute (const Image &image, const Image &maskImage)
 
Image Execute (Image &&image, const Image &maskImage)
 
double GetMaskingValue () const
 
std::string GetName () const
 
double GetOutsideValue () const
 
 MaskNegatedImageFilter ()
 
SelfSetMaskingValue (double MaskingValue)
 
SelfSetOutsideValue (double OutsideValue)
 
std::string ToString () const
 
virtual ~MaskNegatedImageFilter ()
 
- 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 *image, const Image *maskImage)
 

Private Member Functions

template<class TImageType1 , class TImageType2 >
Image DualExecuteInternal (const Image *image, const Image *maskImage)
 

Private Attributes

std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
bool m_InPlace {false}
 
double m_MaskingValue {0}
 
double m_OutsideValue {0}
 

Friends

struct detail::DualExecuteInternalAddressor< 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

Mask an image with the negation (or logical compliment) of a mask.

This class is templated over the types of the input image type, the mask image type and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

The pixel type of the input 2 image must have a valid definition of the operator!=. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != mask_value
pixel_output_image = output_value
else
pixel_output_image = pixel_input_image

The pixel from the input 1 is cast to the pixel type of the output image.

Note that the input and the mask images must be of the same size.

Warning
Only pixel value with mask_value ( defaults to 0 ) will be preserved.
See also
MaskImageFilter
itk::simple::MaskNegated for the procedural interface
itk::MaskNegatedImageFilter for the Doxygen on the original ITK class.

Definition at line 66 of file sitkMaskNegatedImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::MaskNegatedImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )
private

Setup for member function dispatching

Definition at line 117 of file sitkMaskNegatedImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 78 of file sitkMaskNegatedImageFilter.h.

◆ Self

Definition at line 68 of file sitkMaskNegatedImageFilter.h.

Constructor & Destructor Documentation

◆ ~MaskNegatedImageFilter()

virtual itk::simple::MaskNegatedImageFilter::~MaskNegatedImageFilter ( )
virtual

Destructor

◆ MaskNegatedImageFilter()

itk::simple::MaskNegatedImageFilter::MaskNegatedImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

template<class TImageType1 , class TImageType2 >
Image itk::simple::MaskNegatedImageFilter::DualExecuteInternal ( const Image image,
const Image maskImage 
)
private

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::MaskNegatedImageFilter::Execute ( Image &&  image,
const Image maskImage 
)

Execute the filter on the input image

◆ GetMaskingValue()

double itk::simple::MaskNegatedImageFilter::GetMaskingValue ( ) const
inline

Method to get the masking value of the mask.

Definition at line 99 of file sitkMaskNegatedImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkMaskNegatedImageFilter.h.

◆ GetOutsideValue()

double itk::simple::MaskNegatedImageFilter::GetOutsideValue ( ) const
inline

Definition at line 89 of file sitkMaskNegatedImageFilter.h.

◆ SetMaskingValue()

Self& itk::simple::MaskNegatedImageFilter::SetMaskingValue ( double  MaskingValue)
inline

Method to explicitly set the masking value of the mask. Defaults to 0

Definition at line 94 of file sitkMaskNegatedImageFilter.h.

◆ SetOutsideValue()

Self& itk::simple::MaskNegatedImageFilter::SetOutsideValue ( double  OutsideValue)
inline

Method to explicitly set the outside value of the mask. Defaults to 0

Definition at line 85 of file sitkMaskNegatedImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 119 of file sitkMaskNegatedImageFilter.h.

Member Data Documentation

◆ m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::MaskNegatedImageFilter::m_DualMemberFactory
private

Definition at line 123 of file sitkMaskNegatedImageFilter.h.

◆ m_InPlace

bool itk::simple::MaskNegatedImageFilter::m_InPlace {false}
private

Definition at line 132 of file sitkMaskNegatedImageFilter.h.

◆ m_MaskingValue

double itk::simple::MaskNegatedImageFilter::m_MaskingValue {0}
private

Definition at line 129 of file sitkMaskNegatedImageFilter.h.

◆ m_OutsideValue

double itk::simple::MaskNegatedImageFilter::m_OutsideValue {0}
private

Definition at line 127 of file sitkMaskNegatedImageFilter.h.


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