itk::LabelMapMaskImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkLabelMapMaskImageFilter.h>

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

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

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: http://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 47 of file itkLabelMapMaskImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OutputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef InputImageType::LabelObjectType	LabelObjectType
typedef LabelObjectType::LabelType	LabelType
typedef LabelObjectType::LengthType	LengthType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef OutputImageType::RegionType	RegionType
typedef LabelMapMaskImageFilter	Self
typedef OutputImageType::SizeType	SizeType
typedef LabelMapFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageType	InputImageType
typedef InputImageType::LabelObjectType	LabelObjectType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef LabelMapFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
const OutputImageType *	GetFeatureImage ()
virtual const char *	GetNameOfClass () const
void	SetFeatureImage (const TOutputImage *input)
void	SetInput1 (const TInputImage *input)
void	SetInput2 (const TOutputImage *input)
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 SizeType &	GetCropBorder () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput () override
virtual void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
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 >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual 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 ()
MultiThreader *	GetMultiThreader () 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)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (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	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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::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 const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int	ImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
virtual void	BeforeThreadedGenerateData () override
void	EnlargeOutputRequestedRegion (DataObject *) override
void	GenerateInputRequestedRegion () override
virtual void	GenerateOutputInformation () override
	LabelMapMaskImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject) override
	~LabelMapMaskImageFilter ()
Protected Member Functions inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
virtual void	AfterThreadedGenerateData () override
virtual InputImageType *	GetLabelMap ()
	LabelMapFilter ()
	~LabelMapFilter ()
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)
	ImageToImageFilter ()
virtual void	VerifyInputInformation () override
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AllocateOutputs ()
virtual void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
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
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
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	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 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 ()
	~ProcessObject ()
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 (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
	LabelMapMaskImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
OutputImagePixelType	m_BackgroundValue
Barrier::Pointer	m_Barrier
bool	m_Crop
SizeType	m_CropBorder
TimeStamp	m_CropTimeStamp
InputImagePixelType	m_Label
bool	m_Negated

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
FastMutexLock::Pointer	m_LabelObjectContainerLock
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >

typedef SmartPointer<const Self> itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 55 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::IndexType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 72 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef InputImageType::ConstPointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Definition at line 61 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef InputImageType::PixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 63 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef InputImageType::Pointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 60 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef InputImageType::RegionType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 62 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef TInputImage itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 58 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef InputImageType::LabelObjectType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelObjectType

Definition at line 64 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef LabelObjectType::LabelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelType

Definition at line 65 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef LabelObjectType::LengthType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LengthType

Definition at line 66 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::ConstPointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

Definition at line 69 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::PixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 71 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::Pointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 68 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::RegionType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 70 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef TOutputImage itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 59 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef SmartPointer<Self> itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 54 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::RegionType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 74 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef LabelMapMaskImageFilter itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 52 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef OutputImageType::SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 73 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

typedef LabelMapFilter<TInputImage, TOutputImage> itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 53 of file itkLabelMapMaskImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >

itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelMapMaskImageFilter ( )

protected

template<typename TInputImage , typename TOutputImage >

itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::~LabelMapMaskImageFilter ( )

inlineprotected

Definition at line 159 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelMapMaskImageFilter ( const Self &  )

private

Member Function Documentation

template<typename TInputImage , typename TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )

overrideprotectedvirtual

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

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 >.

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

virtual

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

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 >.

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 >.

template<typename TInputImage , typename TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

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().

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

inline

Get the feature image

Definition at line 101 of file itkLabelMapMaskImageFilter.h.

References itk::ProcessObject::GetInput().

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

virtual

Runtime information support.

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

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

virtual

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

template<typename TInputImage , typename TOutputImage >

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

static

Standard New method.

template<typename TInputImage , typename TOutputImage >

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

private

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

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

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().

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.

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.

template<typename TInputImage , typename TOutputImage >

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

inline

Set the feature image

Definition at line 94 of file itkLabelMapMaskImageFilter.h.

References itk::ProcessObject::SetNthInput().

Referenced by itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetInput2().

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.

References itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput().

template<typename TInputImage , typename TOutputImage >

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

inline

Set the feature image

Definition at line 113 of file itkLabelMapMaskImageFilter.h.

References itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetFeatureImage().

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.

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.

template<typename TInputImage , typename TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See Also

GenerateData(), SplitRequestedRegion()

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

template<typename TInputImage , typename TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ThreadedProcessLabelObject ( LabelObjectType *  labelObject )

overrideprotectedvirtual

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

Member Data Documentation

template<typename TInputImage , typename TOutputImage >

const unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

static

ImageDimension constants

Definition at line 83 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

const unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

ImageDimension constants

Definition at line 79 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

OutputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_BackgroundValue

private

Definition at line 184 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

Barrier::Pointer itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Barrier

private

Definition at line 191 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Crop

private

Definition at line 186 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropBorder

private

Definition at line 187 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

TimeStamp itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropTimeStamp

private

Definition at line 189 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Label

private

Definition at line 183 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Negated

private

Definition at line 185 of file itkLabelMapMaskImageFilter.h.

template<typename TInputImage , typename TOutputImage >

const unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension constants

Definition at line 81 of file itkLabelMapMaskImageFilter.h.

---

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

• itkLabelMapMaskImageFilter.h