---

vtkImageMask Class Reference

Combines a mask and an image. More...

#include <vtkImageMask.h>

Inheritance diagram for vtkImageMask:

[legend]Collaboration diagram for vtkImageMask:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetMaskedOutputValue (int num, float *v)
void	SetMaskedOutputValue (float v)
void	SetMaskedOutputValue (float v1, float v2)
void	SetMaskedOutputValue (float v1, float v2, float v3)
float *	GetMaskedOutputValue ()
int	GetMaskedOutputValueLength ()
void	SetImageInput (vtkImageData *in)
void	SetMaskInput (vtkImageData *in)
virtual void	SetNotMask (int)
virtual int	GetNotMask ()
virtual void	NotMaskOn ()
virtual void	NotMaskOff ()
Static Public Methods
vtkImageMask *	New ()
int	IsTypeOf (const char *type)
vtkImageMask *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageMask ()
	~vtkImageMask ()
	vtkImageMask (const vtkImageMask &)
void	operator= (const vtkImageMask &)
void	ExecuteInformation (vtkImageData **inDatas, vtkImageData *outData)
void	ExecuteInformation ()
void	ThreadedExecute (vtkImageData **inDatas, vtkImageData *outData, int extent[6], int id)
Protected Attributes
float *	MaskedOutputValue
int	MaskedOutputValueLength
int	NotMask

---

Detailed Description

Combines a mask and an image.

Date:

2000/12/10 20:09:08

Revision:

1.26

Thanks:

Thanks to C. Charles Law who developed this class.

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

Examples:

vtkImageMask (examples)

Definition at line 67 of file vtkImageMask.h.

---

Constructor & Destructor Documentation

vtkImageMask::vtkImageMask (    )  [protected]

vtkImageMask::~vtkImageMask (    )  [protected]

vtkImageMask::vtkImageMask (  const vtkImageMask &    )  [inline, protected]

Definition at line 101 of file vtkImageMask.h.

---

Member Function Documentation

vtkImageMask* vtkImageMask::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageTwoInputFilter.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

int vtkImageMask::IsTypeOf (  const char *    type )  [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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

virtual int vtkImageMask::IsA (  const char *    type )  [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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

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

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

SetGet the value of the output pixel replaced by mask.

void vtkImageMask::SetMaskedOutputValue (  float    v )  [inline]

Definition at line 76 of file vtkImageMask.h.

void vtkImageMask::SetMaskedOutputValue (  float    v1, float    v2 )  [inline]

Definition at line 77 of file vtkImageMask.h.

void vtkImageMask::SetMaskedOutputValue (  float    v1, float    v2, float    v3 )  [inline]

Definition at line 79 of file vtkImageMask.h.

float* vtkImageMask::GetMaskedOutputValue (    )  [inline]

Definition at line 81 of file vtkImageMask.h.

int vtkImageMask::GetMaskedOutputValueLength (    )  [inline]

Definition at line 82 of file vtkImageMask.h.

void vtkImageMask::SetImageInput (  vtkImageData *    in )  [inline]

Set the input to be masked. Definition at line 85 of file vtkImageMask.h.

void vtkImageMask::SetMaskInput (  vtkImageData *    in )  [inline]

Set the mask to be used. Definition at line 88 of file vtkImageMask.h.

virtual void vtkImageMask::SetNotMask (  int    )  [virtual]

When Not Mask is on, the mask is passed through a boolean not before it is used to mask the image. The effect is to pass the pixels where the input mask is zero, and replace the pixels where the input value is non zero.

virtual int vtkImageMask::GetNotMask (    )  [virtual]

virtual void vtkImageMask::NotMaskOn (    )  [virtual]

virtual void vtkImageMask::NotMaskOff (    )  [virtual]

void vtkImageMask::operator= (  const vtkImageMask &    )  [inline, protected]

Definition at line 102 of file vtkImageMask.h.

void vtkImageMask::ExecuteInformation (  vtkImageData **    inDatas, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageMultipleInputFilter.

void vtkImageMask::ExecuteInformation (    )  [inline, protected, virtual]

Reimplemented from vtkImageMultipleInputFilter. Definition at line 109 of file vtkImageMask.h.

void vtkImageMask::ThreadedExecute (  vtkImageData **    inDatas, vtkImageData *    outData, int    extent[6], int    id )  [protected, virtual]

The execute method created by the subclass. This is kept public instead of protected since it is called from a non-member thread function. Reimplemented from vtkImageMultipleInputFilter.

---

Member Data Documentation

float* vtkImageMask::MaskedOutputValue [protected]

Definition at line 104 of file vtkImageMask.h.

int vtkImageMask::MaskedOutputValueLength [protected]

Definition at line 105 of file vtkImageMask.h.

int vtkImageMask::NotMask [protected]

Definition at line 106 of file vtkImageMask.h.

---

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

• imaging/vtkImageMask.h

---