vtkImageStencil Class Reference

#include <vtkImageStencil.h>

Inheritance diagram for vtkImageStencil:

[legend]

Collaboration diagram for vtkImageStencil:

[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)
vtkImageStencilData *	GetStencil ()

virtual void	SetReverseStencil (int)
virtual void	ReverseStencilOn ()
virtual void	ReverseStencilOff ()
virtual int	GetReverseStencil ()

virtual void	SetBackgroundInput (vtkImageData *input)
vtkImageData *	GetBackgroundInput ()

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 vtkImageStencil *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencil *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencil ()
	~vtkImageStencil ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
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

typedef vtkThreadedImageAlgorithm vtkImageStencil::Superclass

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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro 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]

NOTE: Not yet implemented, use SetBackgroundValue instead. 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 ( )

NOTE: Not yet implemented, use SetBackgroundValue instead. 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 67 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 69 of file vtkImageStencil.h.

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