vtkImageMask Class Reference

#include <vtkImageMask.h>

Inheritance diagram for vtkImageMask:

Inheritance graph
[legend]
Collaboration diagram for vtkImageMask:

Collaboration graph
[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 vtkImageMaskNew ()
static int IsTypeOf (const char *type)
static vtkImageMaskSafeDownCast (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

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 vtkTypeMacro 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 vtkTypeMacro 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 
)

SetGet the value of the output pixel replaced by mask.

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

SetGet the value of the output pixel replaced by mask.

Definition at line 48 of file vtkImageMask.h.

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

SetGet the value of the output pixel replaced by mask.

Definition at line 49 of file vtkImageMask.h.

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

SetGet the value of the output pixel replaced by mask.

Definition at line 51 of file vtkImageMask.h.

double* vtkImageMask::GetMaskedOutputValue (  )  [inline]

SetGet the value of the output pixel replaced by mask.

Definition at line 53 of file vtkImageMask.h.

int vtkImageMask::GetMaskedOutputValueLength (  )  [inline]

SetGet the value of the output pixel replaced by mask.

Definition at line 54 of file vtkImageMask.h.

virtual void vtkImageMask::SetMaskAlpha ( double   )  [virtual]

Set/Get the alpha blending value for the mask The input image is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over operator.

virtual double vtkImageMask::GetMaskAlpha (  )  [virtual]

Set/Get the alpha blending value for the mask The input image is assumed to be at alpha = 1.0 and the mask image uses this alpha to blend using an over operator.

void vtkImageMask::SetImageInput ( vtkImageData in  ) 

Set the input to be masked.

void vtkImageMask::SetMaskInput ( vtkImageData in  ) 

Set the mask to be used.

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]

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 void vtkImageMask::NotMaskOn (  )  [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 void vtkImageMask::NotMaskOff (  )  [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 void vtkImageMask::SetInput1 ( vtkDataObject in  )  [inline, virtual]

Set the two inputs to this filter

Definition at line 83 of file vtkImageMask.h.

virtual void vtkImageMask::SetInput2 ( vtkDataObject in  )  [inline, virtual]

Set the two inputs to this filter

Definition at line 84 of file vtkImageMask.h.

virtual int vtkImageMask::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageMask::ThreadedRequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector,
vtkImageData ***  inData,
vtkImageData **  outData,
int  extent[6],
int  threadId 
) [protected, virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.


Member Data Documentation

double* vtkImageMask::MaskedOutputValue [protected]

Definition at line 91 of file vtkImageMask.h.

Definition at line 92 of file vtkImageMask.h.

int vtkImageMask::NotMask [protected]

Definition at line 93 of file vtkImageMask.h.

double vtkImageMask::MaskAlpha [protected]

Definition at line 94 of file vtkImageMask.h.


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

Generated on Wed Aug 24 11:41:27 2011 for VTK by  doxygen 1.5.6