Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

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
Created by:
  • Gobbi, David
CVS contributions (if > 5%):
  • Gobbi, David (70%)
  • Martin, Ken (14%)
  • Schroeder, Will (6%)
CVS logs (CVSweb):
  • .h (/Imaging/vtkImageToImageStencil.h)
  • .cxx (/Imaging/vtkImageToImageStencil.cxx)
Tests:
vtkImageToImageStencil (Tests)

Definition at line 48 of file vtkImageToImageStencil.h.

Public Types

typedef vtkImageStencilSource 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

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

Protected Member Functions

 vtkImageToImageStencil ()
 ~vtkImageToImageStencil ()
void ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)
void ExecuteInformation ()
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

double UpperThreshold
double LowerThreshold
double Threshold


Member Typedef Documentation

typedef vtkImageStencilSource vtkImageToImageStencil::Superclass
 

Reimplemented from vtkImageStencilSource.

Definition at line 52 of file vtkImageToImageStencil.h.


Constructor & Destructor Documentation

vtkImageToImageStencil::vtkImageToImageStencil  )  [protected]
 

vtkImageToImageStencil::~vtkImageToImageStencil  )  [protected]
 


Member Function Documentation

vtkImageToImageStencil* vtkImageToImageStencil::New  )  [static]
 

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

int vtkImageToImageStencil::IsTypeOf const char *  type  )  [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 vtkImageStencilSource.

virtual int vtkImageToImageStencil::IsA const char *  type  )  [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 vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

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 vtkImageStencilSource.

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.

void vtkImageToImageStencil::ThreadedExecute vtkImageStencilData output,
int  extent[6],
int  threadId
[protected, virtual]
 

Override this method to support clipping with different kinds of objects. Eventually the extent could be split up and handled by multiple threads, but it isn't for now. But please ensure that all code inside this method is thread-safe.

Reimplemented from vtkImageStencilSource.

void vtkImageToImageStencil::ExecuteInformation  )  [protected, virtual]
 

Reimplemented from vtkSource.

virtual int vtkImageToImageStencil::FillInputPortInformation int  ,
vtkInformation
[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 vtkProcessObject.


Member Data Documentation

double vtkImageToImageStencil::UpperThreshold [protected]
 

Definition at line 87 of file vtkImageToImageStencil.h.

double vtkImageToImageStencil::LowerThreshold [protected]
 

Definition at line 88 of file vtkImageToImageStencil.h.

double vtkImageToImageStencil::Threshold [protected]
 

Definition at line 89 of file vtkImageToImageStencil.h.


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