VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageMask Class Reference

Combines a mask and an image. More...

#include <vtkImageMask.h>

Inherits vtkThreadedImageAlgorithm.

Public Types

typedef vtkThreadedImageAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageMaskNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetImageInputData (vtkImageData *in)
 
void SetMaskInputData (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 SetInput1Data (vtkDataObject *in)
 
virtual void SetInput2Data (vtkDataObject *in)
 

Static Public Member Functions

static vtkImageMaskNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageMaskSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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
 

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 39 of file vtkImageMask.h.

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageMask::Superclass

Definition at line 43 of file vtkImageMask.h.

Constructor & Destructor Documentation

vtkImageMask::vtkImageMask ( )
protected
vtkImageMask::~vtkImageMask ( )
protected

Member Function Documentation

static vtkImageMask* vtkImageMask::New ( )
static
static int vtkImageMask::IsTypeOf ( const char *  type)
static
virtual int vtkImageMask::IsA ( const char *  type)
virtual
static vtkImageMask* vtkImageMask::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageMask::NewInstanceInternal ( ) const
protectedvirtual
vtkImageMask* vtkImageMask::NewInstance ( ) const
void vtkImageMask::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 49 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 50 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 52 of file vtkImageMask.h.

double* vtkImageMask::GetMaskedOutputValue ( )
inline

SetGet the value of the output pixel replaced by mask.

Definition at line 54 of file vtkImageMask.h.

int vtkImageMask::GetMaskedOutputValueLength ( )
inline

SetGet the value of the output pixel replaced by mask.

Definition at line 55 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::SetImageInputData ( vtkImageData *  in)

Set the input to be masked.

void vtkImageMask::SetMaskInputData ( 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::SetInput1Data ( vtkDataObject *  in)
inlinevirtual

Set the two inputs to this filter

Definition at line 84 of file vtkImageMask.h.

virtual void vtkImageMask::SetInput2Data ( vtkDataObject *  in)
inlinevirtual

Set the two inputs to this filter

Definition at line 85 of file vtkImageMask.h.

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

Member Data Documentation

double* vtkImageMask::MaskedOutputValue
protected

Definition at line 92 of file vtkImageMask.h.

int vtkImageMask::MaskedOutputValueLength
protected

Definition at line 93 of file vtkImageMask.h.

int vtkImageMask::NotMask
protected

Definition at line 94 of file vtkImageMask.h.

double vtkImageMask::MaskAlpha
protected

Definition at line 95 of file vtkImageMask.h.


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