vtkImageStencilToImage Class Reference

#include <vtkImageStencilToImage.h>

Inheritance diagram for vtkImageStencilToImage:

Inheritance graph
[legend]
Collaboration diagram for vtkImageStencilToImage:

Collaboration graph
[legend]

List of all members.


Detailed Description

Convert an image stencil into an image.

vtkImageStencilToImage will convert an image stencil into a binary image. The default output will be an 8-bit image with a value of 1 inside the stencil and 0 outside. When used in combination with vtkPolyDataToImageStencil or vtkImplicitFunctionToImageStencil, this can be used to create a binary image from a mesh or a function.

See also:
vtkImplicitModeller
Tests:
vtkImageStencilToImage (Tests)

Definition at line 35 of file vtkImageStencilToImage.h.


Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOutsideValue (double)
virtual double GetOutsideValue ()
virtual void SetInsideValue (double)
virtual double GetInsideValue ()
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToUnsignedChar ()
void SetOutputScalarTypeToChar ()

Static Public Member Functions

static vtkImageStencilToImageNew ()
static int IsTypeOf (const char *type)
static vtkImageStencilToImageSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageStencilToImage ()
 ~vtkImageStencilToImage ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

double OutsideValue
double InsideValue
int OutputScalarType

Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Definition at line 39 of file vtkImageStencilToImage.h.


Constructor & Destructor Documentation

vtkImageStencilToImage::vtkImageStencilToImage (  )  [protected]

vtkImageStencilToImage::~vtkImageStencilToImage (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

static int vtkImageStencilToImage::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 vtkImageAlgorithm.

virtual int vtkImageStencilToImage::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 vtkImageAlgorithm.

static vtkImageStencilToImage* vtkImageStencilToImage::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImageAlgorithm.

void vtkImageStencilToImage::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 vtkImageAlgorithm.

virtual void vtkImageStencilToImage::SetOutsideValue ( double   )  [virtual]

The value to use outside the stencil. The default is 0.

virtual double vtkImageStencilToImage::GetOutsideValue (  )  [virtual]

The value to use outside the stencil. The default is 0.

virtual void vtkImageStencilToImage::SetInsideValue ( double   )  [virtual]

The value to use inside the stencil. The default is 1.

virtual double vtkImageStencilToImage::GetInsideValue (  )  [virtual]

The value to use inside the stencil. The default is 1.

virtual void vtkImageStencilToImage::SetOutputScalarType ( int   )  [virtual]

The desired output scalar type. The default is unsigned char.

virtual int vtkImageStencilToImage::GetOutputScalarType (  )  [virtual]

The desired output scalar type. The default is unsigned char.

void vtkImageStencilToImage::SetOutputScalarTypeToFloat (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 58 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToDouble (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 59 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToInt (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 60 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedInt (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 61 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToLong (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 63 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedLong (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 64 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToShort (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 66 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedShort (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 67 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToUnsignedChar (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 69 of file vtkImageStencilToImage.h.

void vtkImageStencilToImage::SetOutputScalarTypeToChar (  )  [inline]

The desired output scalar type. The default is unsigned char.

Definition at line 71 of file vtkImageStencilToImage.h.

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

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageStencilToImage::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageStencilToImage::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 87 of file vtkImageStencilToImage.h.

Definition at line 88 of file vtkImageStencilToImage.h.

Definition at line 89 of file vtkImageStencilToImage.h.


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

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