VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageStencilToImage Class Reference

Convert an image stencil into an image. More...

#include <vtkImageStencilToImage.h>

Inheritance diagram for vtkImageStencilToImage:
Inheritance graph
[legend]
Collaboration diagram for vtkImageStencilToImage:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkImageStencilToImageNewInstance () const
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 (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 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

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


Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Definition at line 40 of file vtkImageStencilToImage.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkAlgorithm.

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.

Reimplemented from vtkImageAlgorithm.

virtual vtkObjectBase* vtkImageStencilToImage::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

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.

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.

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.

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

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

Definition at line 59 of file vtkImageStencilToImage.h.

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

Definition at line 60 of file vtkImageStencilToImage.h.

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

Definition at line 61 of file vtkImageStencilToImage.h.

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

Definition at line 62 of file vtkImageStencilToImage.h.

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

Definition at line 64 of file vtkImageStencilToImage.h.

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

Definition at line 65 of file vtkImageStencilToImage.h.

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

Definition at line 67 of file vtkImageStencilToImage.h.

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

Definition at line 68 of file vtkImageStencilToImage.h.

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

Definition at line 70 of file vtkImageStencilToImage.h.

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

Definition at line 72 of file vtkImageStencilToImage.h.

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

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

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

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

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

These method should be reimplemented by subclasses that have more than a single input or single output. See vtkAlgorithm for more information.

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

Definition at line 88 of file vtkImageStencilToImage.h.

Definition at line 89 of file vtkImageStencilToImage.h.

Definition at line 90 of file vtkImageStencilToImage.h.


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