Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage > Class Template Reference

#include <mitkitkMaskImageFilter.h>

Inheritance diagram for itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >:
Collaboration diagram for itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >:

Public Types

typedef MaskImageFilter2 Self
 
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput2< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef TMaskImage MaskImageType
 

Public Member Functions

virtual const char * GetClassName () const
 
void SetMaskImage (const MaskImageType *maskImage)
 
const MaskImageTypeGetMaskImage ()
 
void SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)
 
const TOutputImage::PixelType & GetOutsideValue () const
 
void SetMaskingValue (const typename TMaskImage::PixelType &maskingValue)
 
const TMaskImage::PixelType & GetMaskingValue () const
 
void BeforeThreadedGenerateData () override
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 MaskImageFilter2 ()
 
 ~MaskImageFilter2 () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Detailed Description

template<typename TInputImage, typename TMaskImage, typename TOutputImage = TInputImage>
class itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >

Definition at line 137 of file mitkitkMaskImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::ConstPointer

Definition at line 157 of file mitkitkMaskImageFilter.h.

◆ MaskImageType

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
typedef TMaskImage itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::MaskImageType

Typedefs

Definition at line 164 of file mitkitkMaskImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::Pointer

Definition at line 156 of file mitkitkMaskImageFilter.h.

◆ Self

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
typedef MaskImageFilter2 itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 148 of file mitkitkMaskImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput2< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::Superclass

Definition at line 154 of file mitkitkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ MaskImageFilter2()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter2 ( )
inlineprotected

Definition at line 231 of file mitkitkMaskImageFilter.h.

◆ ~MaskImageFilter2()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::~MaskImageFilter2 ( )
inlineoverrideprotected

Definition at line 232 of file mitkitkMaskImageFilter.h.

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
void itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::BeforeThreadedGenerateData ( )
inlineoverride

Definition at line 214 of file mitkitkMaskImageFilter.h.

◆ GetClassName()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
virtual const char* itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::GetClassName ( ) const
virtual

Runtime information support.

◆ GetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
const MaskImageType* itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( )
inline

Definition at line 178 of file mitkitkMaskImageFilter.h.

◆ GetMaskingValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
const TMaskImage::PixelType& itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::GetMaskingValue ( ) const
inline

Method to get the masking value of the mask.

Definition at line 209 of file mitkitkMaskImageFilter.h.

◆ GetOutsideValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
const TOutputImage::PixelType& itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const
inline

Definition at line 193 of file mitkitkMaskImageFilter.h.

◆ New()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
static Pointer itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
void itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotected

Definition at line 234 of file mitkitkMaskImageFilter.h.

◆ SetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
void itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::SetMaskImage ( const MaskImageType maskImage)
inline

Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".

Definition at line 173 of file mitkitkMaskImageFilter.h.

◆ SetMaskingValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
void itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue ( const typename TMaskImage::PixelType &  maskingValue)
inline

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

Definition at line 199 of file mitkitkMaskImageFilter.h.

◆ SetOutsideValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
void itk::MaskImageFilter2< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue ( const typename TOutputImage::PixelType &  outsideValue)
inline

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

Definition at line 184 of file mitkitkMaskImageFilter.h.


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