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
vtkImageStencil Class Reference

combine images via a cookie-cutter operation More...

#include <vtkImageStencil.h>

Inherits vtkThreadedImageAlgorithm.

Public Types

typedef vtkThreadedImageAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageStencilNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetStencilData (vtkImageStencilData *stencil)
 
vtkImageStencilDataGetStencil ()
 
void SetStencilConnection (vtkAlgorithmOutput *outputPort)
 
virtual void SetReverseStencil (int)
 
virtual void ReverseStencilOn ()
 
virtual void ReverseStencilOff ()
 
virtual int GetReverseStencil ()
 
virtual void SetBackgroundInputData (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 vtkImageStencilNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

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

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 36 of file vtkImageStencil.h.

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageStencil::Superclass

Definition at line 40 of file vtkImageStencil.h.

Constructor & Destructor Documentation

vtkImageStencil::vtkImageStencil ( )
protected
vtkImageStencil::~vtkImageStencil ( )
protected

Member Function Documentation

static vtkImageStencil* vtkImageStencil::New ( )
static
static int vtkImageStencil::IsTypeOf ( const char *  type)
static
virtual int vtkImageStencil::IsA ( const char *  type)
virtual
static vtkImageStencil* vtkImageStencil::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageStencil::NewInstanceInternal ( ) const
protectedvirtual
vtkImageStencil* vtkImageStencil::NewInstance ( ) const
void vtkImageStencil::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkImageStencil::SetStencilData ( vtkImageStencilData stencil)
virtual

Specify the stencil to use. The stencil can be created from a vtkImplicitFunction or a vtkPolyData. This function does not setup a pipeline connection.

vtkImageStencilData* vtkImageStencil::GetStencil ( )

Specify the stencil to use. The stencil can be created from a vtkImplicitFunction or a vtkPolyData. This function does not setup a pipeline connection.

void vtkImageStencil::SetStencilConnection ( vtkAlgorithmOutput *  outputPort)
inline

Specify the stencil to use. This sets up a pipeline connection.

Definition at line 53 of file vtkImageStencil.h.

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::SetBackgroundInputData ( 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 76 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 78 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  id 
)
protected
virtual int vtkImageStencil::FillInputPortInformation ( int  ,
vtkInformation *   
)
protectedvirtual

Member Data Documentation

int vtkImageStencil::ReverseStencil
protected

Definition at line 99 of file vtkImageStencil.h.

double vtkImageStencil::BackgroundColor[4]
protected

Definition at line 100 of file vtkImageStencil.h.


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