itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference

ITK 4.1.0

Insight Segmentation and Registration Toolkit

#include <itkMaskNegatedImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TMaskImage	MaskImageType
typedef SmartPointer< Self >	Pointer
typedef MaskNegatedImageFilter	Self
typedef BinaryFunctorImageFilter < TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput < typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const MaskImageType *	GetMaskImage ()
virtual const char *	GetNameOfClass () const
const TOutputImage::PixelType &	GetOutsideValue () const
void	SetMaskImage (const MaskImageType *maskImage)
	typedef (Concept::EqualityComparable< typename TMaskImage::PixelType >) MaskEqualityComparableCheck
	typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck

void	SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const

	MaskNegatedImageFilter ()
virtual	~MaskNegatedImageFilter ()
Private Member Functions
	MaskNegatedImageFilter (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TInputImage, class TMaskImage, class TOutputImage = TInputImage>
class itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >

Mask an image with the negative of 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 defintion of the operator != with zero. This condition is required because internally this filter will perform the operation

        if pixel_from_mask_image != 0
             pixel_output_image = output_value
        else
             pixel_output_image = pixel_input_image

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 0 will not be masked out.

See also:: MaskImageFilter

Wiki Examples:

All Examples

Apply the inverse of a mask to an image

Definition at line 113 of file itkMaskNegatedImageFilter.h.

Member Typedef Documentation

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

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

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 133 of file itkMaskNegatedImageFilter.h.

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

typedef TMaskImage itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType

Typedefs

Definition at line 140 of file itkMaskNegatedImageFilter.h.

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

typedef SmartPointer< Self > itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 132 of file itkMaskNegatedImageFilter.h.

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

typedef MaskNegatedImageFilter itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 124 of file itkMaskNegatedImageFilter.h.

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

typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 130 of file itkMaskNegatedImageFilter.h.

Constructor & Destructor Documentation

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

itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskNegatedImageFilter ( ) [inline, protected]

End concept checking

Definition at line 187 of file itkMaskNegatedImageFilter.h.

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

virtual itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::~MaskNegatedImageFilter ( ) [inline, protected, virtual]

End concept checking

Definition at line 188 of file itkMaskNegatedImageFilter.h.

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

itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskNegatedImageFilter ( const Self & ) [private]

Member Function Documentation

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

virtual::itk::LightObject::Pointer itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::CreateAnother ( void ) 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::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

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

const MaskImageType* itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( ) [inline]

Definition at line 171 of file itkMaskNegatedImageFilter.h.

References itk::ProcessObject::GetInput().

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

virtual const char* itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

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

const TOutputImage::PixelType& itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const [inline]

Definition at line 156 of file itkMaskNegatedImageFilter.h.

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

static Pointer itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

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

void itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::operator= ( const Self & ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

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

void itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[inline, protected, virtual]`

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 191 of file itkMaskNegatedImageFilter.h.

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

void itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskImage ( const MaskImageType * maskImage ) [inline]

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

Definition at line 165 of file itkMaskNegatedImageFilter.h.

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

void itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue ( const typename TOutputImage::PixelType & outsideValue ) [inline]

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

Definition at line 146 of file itkMaskNegatedImageFilter.h.

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

itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::EqualityComparable< typename TMaskImage::PixelType > )

Begin concept checking This class requires MaskEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TMaskImage::PixelType > )

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

itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )

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

itkMaskNegatedImageFilter.h