vtkImageMask Class Reference

#include <vtkImageMask.h>

Inheritance diagram for vtkImageMask:

[legend]

Collaboration diagram for vtkImageMask:

[legend]

List of all members.

Detailed Description

Combines a mask and an image.

vtkImageMask combines a mask with an image. Non zero mask implies the output pixel will be the same as the image. If a mask pixel is zero, then the output pixel is set to "MaskedValue". The filter also has the option to pass the mask through a boolean not operation before processing the image. This reverses the passed and replaced pixels. The two inputs should have the same "WholeExtent". The mask input should be unsigned char, and the image scalar type is the same as the output scalar type.

Tests:: vtkImageMask (Tests)

Definition at line 38 of file vtkImageMask.h.


Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetImageInput (vtkImageData *in)
void	SetMaskInput (vtkImageData *in)

void	SetMaskedOutputValue (int num, double *v)
void	SetMaskedOutputValue (double v)
void	SetMaskedOutputValue (double v1, double v2)
void	SetMaskedOutputValue (double v1, double v2, double v3)
double *	GetMaskedOutputValue ()
int	GetMaskedOutputValueLength ()

virtual void	SetMaskAlpha (double)
virtual double	GetMaskAlpha ()

virtual void	SetNotMask (int)
virtual int	GetNotMask ()
virtual void	NotMaskOn ()
virtual void	NotMaskOff ()

virtual void	SetInput1 (vtkDataObject *in)
virtual void	SetInput2 (vtkDataObject *in)
Static Public Member Functions
static vtkImageMask *	New ()
static int	IsTypeOf (const char *type)
static vtkImageMask *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageMask ()
	~vtkImageMask ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual void	ThreadedRequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector, vtkImageData *inData, vtkImageData outData, int extent[6], int threadId)
Protected Attributes
double *	MaskedOutputValue
int	MaskedOutputValueLength
int	NotMask
double	MaskAlpha

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageMask::Superclass

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 42 of file vtkImageMask.h.

Constructor & Destructor Documentation

vtkImageMask::vtkImageMask ( ) [protected]

vtkImageMask::~vtkImageMask ( ) [protected]

Member Function Documentation

static vtkImageMask* vtkImageMask::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageMask::GetClassName ( ) [virtual]

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageMask::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkImageMask::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkThreadedImageAlgorithm.

static vtkImageMask* vtkImageMask::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageMask::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[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 vtkThreadedImageAlgorithm.

void vtkImageMask::SetMaskedOutputValue	(	int	num,
		double *	v
	)