ITK  5.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference

#include <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, TOutputImage >
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 = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = BinaryGeneratorImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >
 
using ValueFunctionType = OutputImagePixelType(Input1ImagePixelType, Input2ImagePixelType)
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const TMaskImage::PixelType & GetMaskingValue () const
 
virtual const char * GetNameOfClass () const
 
const TOutputImage::PixelType & GetOutsideValue () const
 
void SetMaskImage (const MaskImageType *maskImage)
 
const MaskImageTypeGetMaskImage ()
 
void SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)
 
void SetMaskingValue (const typename TMaskImage::PixelType &maskingValue)
 
- Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const Input1ImagePixelTypeGetConstant1 () const
 
virtual const Input2ImagePixelTypeGetConstant2 () const
 
virtual void SetConstant1 (const Input1ImagePixelType &input1)
 
void SetFunctor (const std::function< ConstRefFunctionType > &f)
 
void SetFunctor (const std::function< ValueFunctionType > &f)
 
void SetFunctor (ConstRefFunctionType *funcPointer)
 
void SetFunctor (ValueFunctionType *funcPointer)
 
void SetFunctor (const TFunctor &functor)
 
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 Input2ImagePixelTypeGetConstant () const
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
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< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
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 flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 flag)
 
- 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, TOutputImage >
 BinaryGeneratorImageFilter ()
 
void GenerateOutputInformation () override
 
 ~BinaryGeneratorImageFilter () override=default
 
void DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
void AllocateOutputs () override
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- 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 GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 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 > *)
 
virtual const FunctorTypeGetFunctor () const
 
FunctorTypeGetFunctor ()
 

Private Attributes

FunctorType m_Functor
 

Additional Inherited Members

- Static Public Attributes inherited from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >
static constexpr unsigned int InputImage1Dimension
 
static constexpr unsigned int InputImage2Dimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
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
 

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:
\li All ITK Sphinx Examples
Examples
Examples/Filtering/FFTImageFilterFourierDomainFiltering.cxx, and SphinxExamples/src/Filtering/ImageIntensity/MaskImage/Code.cxx.

Definition at line 147 of file itkMaskImageFilter.h.

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 164 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 161 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 174 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 163 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 156 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 157 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< TOutputImage >.

Definition at line 244 of file itkMaskImageFilter.h.

References itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetFunctor(), and itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >::SetFunctor().

◆ CheckOutsideValue() [1/2]

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

◆ 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

◆ CreateAnother()

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetFunctor() [1/2]

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

◆ GetFunctor() [2/2]

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
FunctorType& itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetFunctor ( )
inlineprivate

◆ 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 185 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

◆ GetNameOfClass()

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

Runtime information support.

Reimplemented from itk::BinaryGeneratorImageFilter< TInputImage, TMaskImage, TOutputImage >.

◆ GetOutsideValue()

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

◆ 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::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 238 of file itkMaskImageFilter.h.

References itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue(), and itk::InPlaceImageFilter< TInputImage, TOutputImage >::PrintSelf().

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

References itk::ProcessObject::SetNthInput().

◆ SetMaskingValue()

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

◆ SetOutsideValue()

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

Member Data Documentation

◆ m_Functor

template<typename TInputImage , typename TMaskImage , typename TOutputImage = TInputImage>
FunctorType itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::m_Functor
private

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