vtkImageToImageStencil Class Reference

#include <vtkImageToImageStencil.h>

Inheritance diagram for vtkImageToImageStencil:

Inheritance graph
[legend]
Collaboration diagram for vtkImageToImageStencil:

Collaboration graph
[legend]

List of all members.


Detailed Description

clip an image with a mask image

vtkImageToImageStencil will convert a vtkImageData into an stencil that can be used with vtkImageStecil or other vtk classes that apply a stencil to an image.

See also:
vtkImageStencil vtkImplicitFunctionToImageStencil vtkPolyDataToImageStencil
Tests:
vtkImageToImageStencil (Tests)

Definition at line 36 of file vtkImageToImageStencil.h.


Public Types

typedef vtkImageStencilAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void ThresholdByUpper (double thresh)
void ThresholdByLower (double thresh)
void ThresholdBetween (double lower, double upper)
void SetInput (vtkImageData *input)
vtkImageDataGetInput ()
virtual void SetUpperThreshold (double)
virtual double GetUpperThreshold ()
virtual void SetLowerThreshold (double)
virtual double GetLowerThreshold ()

Static Public Member Functions

static vtkImageToImageStencilNew ()
static int IsTypeOf (const char *type)
static vtkImageToImageStencilSafeDownCast (vtkObject *o)

Protected Member Functions

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

Protected Attributes

double UpperThreshold
double LowerThreshold
double Threshold

Member Typedef Documentation

Reimplemented from vtkImageStencilAlgorithm.

Definition at line 40 of file vtkImageToImageStencil.h.


Constructor & Destructor Documentation

vtkImageToImageStencil::vtkImageToImageStencil (  )  [protected]

vtkImageToImageStencil::~vtkImageToImageStencil (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkImageStencilAlgorithm.

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

Reimplemented from vtkImageStencilAlgorithm.

static int vtkImageToImageStencil::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 vtkImageStencilAlgorithm.

virtual int vtkImageToImageStencil::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 vtkImageStencilAlgorithm.

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

Reimplemented from vtkImageStencilAlgorithm.

void vtkImageToImageStencil::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 vtkImageStencilAlgorithm.

void vtkImageToImageStencil::SetInput ( vtkImageData input  ) 

Specify the image data to convert into a stencil.

vtkImageData* vtkImageToImageStencil::GetInput (  ) 

Specify the image data to convert into a stencil.

void vtkImageToImageStencil::ThresholdByUpper ( double  thresh  ) 

The values greater than or equal to the value match.

void vtkImageToImageStencil::ThresholdByLower ( double  thresh  ) 

The values less than or equal to the value match.

void vtkImageToImageStencil::ThresholdBetween ( double  lower,
double  upper 
)

The values in a range (inclusive) match

virtual void vtkImageToImageStencil::SetUpperThreshold ( double   )  [virtual]

Get the Upper and Lower thresholds.

virtual double vtkImageToImageStencil::GetUpperThreshold (  )  [virtual]

Get the Upper and Lower thresholds.

virtual void vtkImageToImageStencil::SetLowerThreshold ( double   )  [virtual]

Get the Upper and Lower thresholds.

virtual double vtkImageToImageStencil::GetLowerThreshold (  )  [virtual]

Get the Upper and Lower thresholds.

virtual int vtkImageToImageStencil::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilAlgorithm.

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

Reimplemented from vtkImageStencilAlgorithm.

virtual int vtkImageToImageStencil::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilAlgorithm.

virtual int vtkImageToImageStencil::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 vtkAlgorithm.


Member Data Documentation

Definition at line 75 of file vtkImageToImageStencil.h.

Definition at line 76 of file vtkImageToImageStencil.h.

Definition at line 77 of file vtkImageToImageStencil.h.


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

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