vtkImageStencil Class Reference

#include <vtkImageStencil.h>

Inheritance diagram for vtkImageStencil:

Inheritance graph
[legend]
Collaboration diagram for vtkImageStencil:

Collaboration graph
[legend]

List of all members.


Detailed Description

combine images via a cookie-cutter operation

vtkImageStencil will combine two images together using a stencil. The stencil should be provided in the form of a vtkImageStencilData,

Examples:
vtkImageStencil (Examples)
Tests:
vtkImageStencil (Tests)

Definition at line 35 of file vtkImageStencil.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)
virtual void SetStencil (vtkImageStencilData *stencil)
vtkImageStencilDataGetStencil ()
virtual void SetReverseStencil (int)
virtual void ReverseStencilOn ()
virtual void ReverseStencilOff ()
virtual int GetReverseStencil ()
virtual void SetBackgroundInput (vtkImageData *input)
vtkImageDataGetBackgroundInput ()
void SetBackgroundValue (double val)
double GetBackgroundValue ()
virtual void SetBackgroundColor (double, double, double, double)
virtual void SetBackgroundColor (double[4])
virtual double * GetBackgroundColor ()
virtual void GetBackgroundColor (double &, double &, double &, double &)
virtual void GetBackgroundColor (double[4])

Static Public Member Functions

static vtkImageStencilNew ()
static int IsTypeOf (const char *type)
static vtkImageStencilSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageStencil ()
 ~vtkImageStencil ()
void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id)
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

int ReverseStencil
double BackgroundColor [4]

Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 39 of file vtkImageStencil.h.


Constructor & Destructor Documentation

vtkImageStencil::vtkImageStencil (  )  [protected]

vtkImageStencil::~vtkImageStencil (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageStencil::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 vtkImageStencil::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 vtkImageStencil* vtkImageStencil::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageStencil::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.

virtual void vtkImageStencil::SetStencil ( vtkImageStencilData stencil  )  [virtual]

Specify the stencil to use. The stencil can be created from a vtkImplicitFunction or a vtkPolyData.

vtkImageStencilData* vtkImageStencil::GetStencil (  ) 

Specify the stencil to use. The stencil can be created from a vtkImplicitFunction or a vtkPolyData.

virtual void vtkImageStencil::SetReverseStencil ( int   )  [virtual]

Reverse the stencil.

virtual void vtkImageStencil::ReverseStencilOn (  )  [virtual]

Reverse the stencil.

virtual void vtkImageStencil::ReverseStencilOff (  )  [virtual]

Reverse the stencil.

virtual int vtkImageStencil::GetReverseStencil (  )  [virtual]

Reverse the stencil.

virtual void vtkImageStencil::SetBackgroundInput ( vtkImageData input  )  [virtual]

Set the second input. This image will be used for the 'outside' of the stencil. If not set, the output voxels will be filled with BackgroundValue instead.

vtkImageData* vtkImageStencil::GetBackgroundInput (  ) 

Set the second input. This image will be used for the 'outside' of the stencil. If not set, the output voxels will be filled with BackgroundValue instead.

void vtkImageStencil::SetBackgroundValue ( double  val  )  [inline]

Set the default output value to use when the second input is not set.

Definition at line 66 of file vtkImageStencil.h.

double vtkImageStencil::GetBackgroundValue (  )  [inline]

Set the default output value to use when the second input is not set.

Definition at line 68 of file vtkImageStencil.h.

virtual void vtkImageStencil::SetBackgroundColor ( double  ,
double  ,
double  ,
double   
) [virtual]

Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.

virtual void vtkImageStencil::SetBackgroundColor ( double  [4]  )  [virtual]

Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.

virtual double* vtkImageStencil::GetBackgroundColor (  )  [virtual]

Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.

virtual void vtkImageStencil::GetBackgroundColor ( double &  ,
double &  ,
double &  ,
double &   
) [virtual]

Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.

virtual void vtkImageStencil::GetBackgroundColor ( double  [4]  )  [virtual]

Set the default color to use when the second input is not set. This is like SetBackgroundValue, but for multi-component images.

void vtkImageStencil::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.

virtual int vtkImageStencil::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

Definition at line 89 of file vtkImageStencil.h.

double vtkImageStencil::BackgroundColor[4] [protected]

Definition at line 90 of file vtkImageStencil.h.


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

Generated on Wed Aug 24 11:42:21 2011 for VTK by  doxygen 1.5.6