#include <itkMaskImageFilter.h>

Detailed Description

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

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 Sphinx Examples:

<a href=
<a href=

Definition at line 148 of file itkMaskImageFilter.h.

Inheritance diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:

Collaboration diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FunctorType = Functor::MaskInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType >

using	MaskImageType = TMaskImage

using	Pointer = SmartPointer< Self >

using	Self = MaskImageFilter

using	Superclass = BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >

Public Types inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	ConstRefFunctionType = OutputImagePixelType(const Input1ImagePixelType &, const Input2ImagePixelType &)

using	DecoratedInput1ImagePixelType = SimpleDataObjectDecorator< Input1ImagePixelType >

using	DecoratedInput2ImagePixelType = SimpleDataObjectDecorator< Input2ImagePixelType >

using	FunctionType = OutputImagePixelType(*)(const Input1ImagePixelType &, const Input2ImagePixelType &)

using	Input1ImagePixelType = typename Input1ImageType::PixelType

using	Input1ImagePointer = typename Input1ImageType::ConstPointer

using	Input1ImageRegionType = typename Input1ImageType::RegionType

using	Input1ImageType = TInputImage

using	Input2ImagePixelType = typename Input2ImageType::PixelType

using	Input2ImagePointer = typename Input2ImageType::ConstPointer

using	Input2ImageRegionType = typename Input2ImageType::RegionType

using	Input2ImageType = TMaskImage

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = BinaryGeneratorImageFilter

using	Superclass = InPlaceImageFilter< TInputImage, TInputImage >

using	ValueFunctionType = OutputImagePixelType(Input1ImagePixelType, Input2ImagePixelType)

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TInputImage >

Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const TMaskImage::PixelType &	GetMaskingValue () const

const char *	GetNameOfClass () const override

const TOutputImage::PixelType &	GetOutsideValue () const


void	SetMaskImage (const MaskImageType *maskImage)

const MaskImageType *	GetMaskImage ()


void	SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)


void	SetMaskingValue (const typename TMaskImage::PixelType &maskingValue)

Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TInputImage >
virtual const Input1ImagePixelType &	GetConstant1 () const

virtual const Input2ImagePixelType &	GetConstant2 () const

const char *	GetNameOfClass () const override

virtual void	SetConstant1 (const Input1ImagePixelType &input1)

void	SetFunctor (const std::function< ValueFunctionType > &f)

void	SetFunctor (ValueFunctionType *funcPointer)

virtual void	SetInput1 (const TInputImage *image1)

virtual void	SetInput1 (const DecoratedInput1ImagePixelType *input1)

virtual void	SetInput1 (const Input1ImagePixelType &input1)

virtual void	SetInput2 (const TMaskImage *image2)

virtual void	SetInput2 (const DecoratedInput2ImagePixelType *input2)

virtual void	SetInput2 (const Input2ImagePixelType &input2)

virtual void	SetConstant2 (const Input2ImagePixelType &input2)

void	SetConstant (Input2ImagePixelType ct)

const Input2ImagePixelType &	GetConstant () const

void	SetFunctor (const std::function< ConstRefFunctionType > &f)

void	SetFunctor (ConstRefFunctionType *funcPointer)

void	SetFunctor (const TFunctor &functor)

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TInputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TInputImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	BeforeThreadedGenerateData () override

	MaskImageFilter ()=default

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

	~MaskImageFilter () override=default

Protected Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TInputImage >
	BinaryGeneratorImageFilter ()

void	GenerateOutputInformation () override

	~BinaryGeneratorImageFilter () override=default

void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	AfterThreadedGenerateData () override

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
template<typename TPixelType >
void	CheckOutsideValue (const TPixelType *)

template<typename TValue >
void	CheckOutsideValue (const VariableLengthVector< TValue > *)

FunctorType &	GetFunctor ()

virtual const FunctorType &	GetFunctor () const

Private Attributes
FunctorType	m_Functor {}

Additional Inherited Members
Static Public Attributes inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TInputImage >
static constexpr unsigned int	InputImage1Dimension

static constexpr unsigned int	InputImage2Dimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TInputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 162 of file itkMaskImageFilter.h.

◆ FunctorType

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::FunctorType = Functor:: MaskInput<typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType>

Definition at line 158 of file itkMaskImageFilter.h.

◆ MaskImageType

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType = TMaskImage

Typedefs

Definition at line 171 of file itkMaskImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 161 of file itkMaskImageFilter.h.

◆ Self

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Self = MaskImageFilter

Standard class type aliases.

Definition at line 155 of file itkMaskImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

using itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass = BinaryGeneratorImageFilter<TInputImage, TMaskImage, TOutputImage>

Definition at line 156 of file itkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ MaskImageFilter()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter ( )

protecteddefault

◆ ~MaskImageFilter()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::~MaskImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::BeforeThreadedGenerateData ( )

inlineoverrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TInputImage >.

Definition at line 247 of file itkMaskImageFilter.h.

◆ CheckOutsideValue() [1/2]

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

template<typename TPixelType >

void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const TPixelType * )

inlineprivate

Definition at line 267 of file itkMaskImageFilter.h.

◆ CheckOutsideValue() [2/2]

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

template<typename TValue >

void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const VariableLengthVector< TValue > * )

inlineprivate

Definition at line 272 of file itkMaskImageFilter.h.

◆ GetFunctor() [1/2]

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

FunctorType & itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetFunctor ( )

inlineprivate

Definition at line 258 of file itkMaskImageFilter.h.

◆ GetFunctor() [2/2]

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

virtual const FunctorType & itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetFunctor ( ) const

privatevirtual

◆ GetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

const MaskImageType * itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( )

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 184 of file itkMaskImageFilter.h.

References itk::ProcessObject::GetInput().

◆ GetMaskingValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

const TMaskImage::PixelType & itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskingValue ( ) const

inline

Method to get the masking value of the mask.

Definition at line 222 of file itkMaskImageFilter.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

const char * itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetOutsideValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

const TOutputImage::PixelType & itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const

inline

Definition at line 203 of file itkMaskImageFilter.h.

◆ New()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

static Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

Definition at line 240 of file itkMaskImageFilter.h.

◆ SetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

void itk::MaskImageFilter< 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 178 of file itkMaskImageFilter.h.

◆ SetMaskingValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

void itk::MaskImageFilter< 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 210 of file itkMaskImageFilter.h.

◆ SetOutsideValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

void itk::MaskImageFilter< 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 192 of file itkMaskImageFilter.h.

References itk::Math::NotExactlyEquals().

Member Data Documentation

◆ m_Functor

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>

FunctorType itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::m_Functor {}

private

Definition at line 263 of file itkMaskImageFilter.h.

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

itkMaskImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FunctorType

◆ MaskImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MaskImageFilter()

◆ ~MaskImageFilter()

Member Function Documentation

◆ BeforeThreadedGenerateData()

◆ CheckOutsideValue() [1/2]

◆ CheckOutsideValue() [2/2]

◆ GetFunctor() [1/2]

◆ GetFunctor() [2/2]

◆ GetMaskImage()

◆ GetMaskingValue()

◆ GetNameOfClass()

◆ GetOutsideValue()

◆ New()

◆ PrintSelf()

◆ SetMaskImage()

◆ SetMaskingValue()

◆ SetOutsideValue()

Member Data Documentation

◆ m_Functor