ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members

#include <itkLabelMapMaskImageFilter.h>

+ Inheritance diagram for itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename OutputImageType::IndexType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using LabelObjectType = typename InputImageType::LabelObjectType
 
using LabelType = typename LabelObjectType::LabelType
 
using LengthType = typename LabelObjectType::LengthType
 
using OutputImageConstPointer = typename OutputImageType::ConstPointer
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename OutputImageType::RegionType
 
using Self = LabelMapMaskImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using Superclass = LabelMapFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename Superclass::InputImageConstPointer
 
using InputImagePixelType = typename Superclass::InputImagePixelType
 
using InputImagePointer = typename Superclass::InputImagePointer
 
using InputImageRegionType = typename Superclass::InputImageRegionType
 
using InputImageType = typename Superclass::InputImageType
 
using LabelObjectType = typename InputImageType::LabelObjectType
 
using OutputImageConstPointer = typename OutputImageType::ConstPointer
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = LabelMapFilter
 
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 OutputImageTypeGetFeatureImage ()
 
virtual const char * GetNameOfClass () const
 
void SetFeatureImage (const TOutputImage *input)
 
void SetInput1 (const TInputImage *input)
 
void SetInput2 (const TOutputImage *input)
 
- 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 ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
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 const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
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
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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::LabelMapFilter< TInputImage, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::LabelMapFilter< 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
 
InputImagePixelType m_Label
 
OutputImagePixelType m_BackgroundValue
 
bool m_Negated { false }
 
bool m_Crop { false }
 
SizeType m_CropBorder
 
TimeStamp m_CropTimeStamp
 
virtual void SetBackgroundValue (OutputImagePixelType _arg)
 
virtual OutputImagePixelType GetBackgroundValue () const
 
virtual void SetLabel (InputImagePixelType _arg)
 
virtual InputImagePixelType GetLabel () const
 
virtual void SetNegated (bool _arg)
 
virtual const bool & GetNegated () const
 
virtual void NegatedOn ()
 
virtual void NegatedOff ()
 
virtual void SetCrop (bool _arg)
 
virtual const bool & GetCrop () const
 
virtual void CropOn ()
 
virtual void CropOff ()
 
virtual void SetCropBorder (SizeType _arg)
 
virtual const SizeTypeGetCropBorder () const
 
 LabelMapMaskImageFilter ()
 
 ~LabelMapMaskImageFilter () override=default
 
void GenerateInputRequestedRegion () override
 
void EnlargeOutputRequestedRegion (DataObject *) override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void SuperclassDynamicTGD (const OutputImageRegionType &outputRegion)
 
void ThreadedProcessLabelObject (LabelObjectType *labelObject) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
virtual InputImageTypeGetLabelMap ()
 
 LabelMapFilter ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override
 
 ~LabelMapFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void AllocateOutputs ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
std::mutex m_LabelObjectContainerLock
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >

Mask and image with a LabelMap.

LabelMapMaskImageFilter mask the content of an input image according to the content of the input LabelMap. The masked pixel of the input image are set to the BackgroundValue. LabelMapMaskImageFilter can keep the input image for one label only, with Negated = false (the default) or it can mask the input image for a single label, when Negated equals true. In Both cases, the label is set with SetLabel().

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

See also
LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter
Examples
SphinxExamples/src/Filtering/LabelMap/MaskOneImageGivenLabelMap/Code.cxx.

Definition at line 48 of file itkLabelMapMaskImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkLabelMapMaskImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 74 of file itkLabelMapMaskImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 63 of file itkLabelMapMaskImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 65 of file itkLabelMapMaskImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 62 of file itkLabelMapMaskImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 64 of file itkLabelMapMaskImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 60 of file itkLabelMapMaskImageFilter.h.

◆ LabelObjectType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelObjectType = typename InputImageType::LabelObjectType

Definition at line 66 of file itkLabelMapMaskImageFilter.h.

◆ LabelType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelType = typename LabelObjectType::LabelType

Definition at line 67 of file itkLabelMapMaskImageFilter.h.

◆ LengthType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LengthType = typename LabelObjectType::LengthType

Definition at line 68 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 71 of file itkLabelMapMaskImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 73 of file itkLabelMapMaskImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 70 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 72 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 61 of file itkLabelMapMaskImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 56 of file itkLabelMapMaskImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::RegionType = typename OutputImageType::RegionType

Definition at line 76 of file itkLabelMapMaskImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Self = LabelMapMaskImageFilter

Standard class type aliases.

Definition at line 54 of file itkLabelMapMaskImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 75 of file itkLabelMapMaskImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Superclass = LabelMapFilter<TInputImage, TOutputImage>

Definition at line 55 of file itkLabelMapMaskImageFilter.h.

Constructor & Destructor Documentation

◆ LabelMapMaskImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelMapMaskImageFilter ( )
protected

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ ~LabelMapMaskImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::~LabelMapMaskImageFilter ( )
overrideprotecteddefault

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::LabelMapMaskImageFilter< TInputImage, 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::LabelMapFilter< TInputImage, TOutputImage >.

◆ CropOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOff ( )
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ CropOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOn ( )
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject )
overrideprotectedvirtual

LabelMapMaskImageFilter will produce the entire output.

Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

LabelMapMaskImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Reimplemented from itk::ProcessObject.

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage >
virtual OutputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetBackgroundValue ( ) const
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ GetCrop()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCrop ( ) const
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ GetCropBorder()

template<typename TInputImage , typename TOutputImage >
virtual const SizeType& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCropBorder ( ) const
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ GetFeatureImage()

template<typename TInputImage , typename TOutputImage >
const OutputImageType* itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetFeatureImage ( )
inline

Get the feature image

Definition at line 100 of file itkLabelMapMaskImageFilter.h.

References itk::ProcessObject::GetInput().

◆ GetLabel()

template<typename TInputImage , typename TOutputImage >
virtual InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetLabel ( ) const
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ GetNameOfClass()

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

Runtime information support.

Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.

◆ GetNegated()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetNegated ( ) const
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ NegatedOff()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOff ( )
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ NegatedOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOn ( )
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::New ( )
static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetBackgroundValue ( OutputImagePixelType  _arg)
virtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

◆ SetCrop()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCrop ( bool  _arg)
virtual

Set/Get whether the image size should be adjusted to the masked image or not.

◆ SetCropBorder()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCropBorder ( SizeType  _arg)
virtual

Set/Get the boder added to the mask before the crop. The default is 0 on all the axes.

◆ SetFeatureImage()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetFeatureImage ( const TOutputImage *  input)
inline

Set the feature image

Definition at line 92 of file itkLabelMapMaskImageFilter.h.

◆ SetInput1()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetInput1 ( const TInputImage *  input)
inline

Set the input image

Definition at line 107 of file itkLabelMapMaskImageFilter.h.

◆ SetInput2()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetInput2 ( const TOutputImage *  input)
inline

Set the feature image

Definition at line 114 of file itkLabelMapMaskImageFilter.h.

◆ SetLabel()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetLabel ( InputImagePixelType  _arg)
virtual

The label to mask or to not mask, depending on the value of the Negated ivar.

◆ SetNegated()

template<typename TInputImage , typename TOutputImage >
virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetNegated ( bool  _arg)
virtual

Set/Get whether the Label should be masked or not.

◆ SuperclassDynamicTGD()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SuperclassDynamicTGD ( const OutputImageRegionType outputRegion)
inlineprotected

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 183 of file itkLabelMapMaskImageFilter.h.

◆ ThreadedProcessLabelObject()

template<typename TInputImage , typename TOutputImage >
void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ThreadedProcessLabelObject ( LabelObjectType labelObject)
overrideprotectedvirtual

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Reimplemented from itk::LabelMapFilter< TInputImage, TOutputImage >.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 82 of file itkLabelMapMaskImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 80 of file itkLabelMapMaskImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage >
OutputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_BackgroundValue
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 196 of file itkLabelMapMaskImageFilter.h.

◆ m_Crop

template<typename TInputImage , typename TOutputImage >
bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Crop { false }
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 198 of file itkLabelMapMaskImageFilter.h.

◆ m_CropBorder

template<typename TInputImage , typename TOutputImage >
SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropBorder
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 199 of file itkLabelMapMaskImageFilter.h.

◆ m_CropTimeStamp

template<typename TInputImage , typename TOutputImage >
TimeStamp itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropTimeStamp
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 201 of file itkLabelMapMaskImageFilter.h.

◆ m_Label

template<typename TInputImage , typename TOutputImage >
InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Label
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 195 of file itkLabelMapMaskImageFilter.h.

◆ m_Negated

template<typename TInputImage , typename TOutputImage >
bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Negated { false }
private

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue().

Definition at line 197 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 81 of file itkLabelMapMaskImageFilter.h.


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