Documentation for vtkImageMask

vtkImageMask - Combines a mask and an image.

Description:

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.

Methods:

	void vtkImageMask ()
	void vtkImageMask ()
	static vtkImageMask *New ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetMaskedOutputValue (int ,float *)
	void SetMaskedOutputValue (float )
	void SetMaskedOutputValue (float ,float )
	void SetMaskedOutputValue (float ,float ,float )
	float *GetMaskedOutputValue ()
	int GetMaskedOutputValueLength ()
	void SetImageInput (vtkImageCache *)
	void SetImageInput (vtkStructuredPoints *)
	void SetMaskInput (vtkImageCache *)
	void SetMaskInput (vtkStructuredPoints *)
	void SetNotMask (int )
	int GetNotMask ()
	void NotMaskOn ()
	void NotMaskOff ()
	void ThreadedExecute (vtkImageData ,vtkImageData * ,int ,int )

Detailed Method Descriptions:

SetGet the value of the output pixel replaced by mask.

	void SetMaskedOutputValue (int ,float *)
	void SetMaskedOutputValue (float )
	void SetMaskedOutputValue (float ,float )
	void SetMaskedOutputValue (float ,float ,float )
	float *GetMaskedOutputValue ()

Set the input to be masked.

	int GetMaskedOutputValueLength ()
	void SetImageInput (vtkImageCache *)

Set the mask to be used.

	void SetImageInput (vtkStructuredPoints *)
	void SetMaskInput (vtkImageCache *)

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.

	void SetMaskInput (vtkStructuredPoints *)
	void SetNotMask (int )
	int GetNotMask ()
	void NotMaskOn ()
	void NotMaskOff ()