SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::MaskedAssignImageFilter Class Reference

Mask an image with a mask. More...

#include <sitkMaskedAssignImageFilter.h>

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

Public Types

using PixelIDTypeList = NonLabelPixelIDTypeList
 
using Self = MaskedAssignImageFilter
 
- 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 (const Image &image, const Image &maskImage, const Image &assignImage)
 
Image Execute (Image &&image, const Image &maskImage)
 
Image Execute (Image &&image, const Image &maskImage, const Image &assignImage)
 
double GetAssignConstant () const
 
std::string GetName () const
 
 MaskedAssignImageFilter ()
 
SelfSetAssignConstant (double AssignConstant)
 
std::string ToString () const
 
virtual ~MaskedAssignImageFilter ()
 
- 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, const Image *assignImage)
 

Private Member Functions

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

Private Attributes

double m_AssignConstant {0}
 
bool m_InPlace {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< 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 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 != with zero. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != masking_value
pixel_output_image = pixel_input_image
else
pixel_output_image = outside_value

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
Any pixel value other than masking value (0 by default) will not be masked out.
See also
MaskNegatedImageFilter
itk::simple::MaskedAssign for the procedural interface
itk::MaskedAssignImageFilter for the Doxygen on the original ITK class.

Definition at line 64 of file sitkMaskedAssignImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 107 of file sitkMaskedAssignImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 76 of file sitkMaskedAssignImageFilter.h.

◆ Self

Definition at line 66 of file sitkMaskedAssignImageFilter.h.

Constructor & Destructor Documentation

◆ ~MaskedAssignImageFilter()

virtual itk::simple::MaskedAssignImageFilter::~MaskedAssignImageFilter ( )
virtual

Destructor

◆ MaskedAssignImageFilter()

itk::simple::MaskedAssignImageFilter::MaskedAssignImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/4]

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

◆ Execute() [2/4]

Image itk::simple::MaskedAssignImageFilter::Execute ( const Image image,
const Image maskImage,
const Image assignImage 
)

◆ Execute() [3/4]

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

◆ Execute() [4/4]

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::MaskedAssignImageFilter::ExecuteInternal ( const Image image,
const Image maskImage,
const Image assignImage 
)
private

◆ GetAssignConstant()

double itk::simple::MaskedAssignImageFilter::GetAssignConstant ( ) const
inline

Definition at line 86 of file sitkMaskedAssignImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 89 of file sitkMaskedAssignImageFilter.h.

◆ SetAssignConstant()

Self& itk::simple::MaskedAssignImageFilter::SetAssignConstant ( double  AssignConstant)
inline

Method to explicitly set the outside value of the mask when AssignImage is undefined. Defaults to 0

Definition at line 82 of file sitkMaskedAssignImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 111 of file sitkMaskedAssignImageFilter.h.

Member Data Documentation

◆ m_AssignConstant

double itk::simple::MaskedAssignImageFilter::m_AssignConstant {0}
private

Definition at line 116 of file sitkMaskedAssignImageFilter.h.

◆ m_InPlace

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

Definition at line 119 of file sitkMaskedAssignImageFilter.h.

◆ m_MemberFactory

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

Definition at line 113 of file sitkMaskedAssignImageFilter.h.


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