vtkImplicitFunctionToImageStencil Class Reference

#include <vtkImplicitFunctionToImageStencil.h>

Inheritance diagram for vtkImplicitFunctionToImageStencil:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitFunctionToImageStencil:

Collaboration graph
[legend]

List of all members.


Detailed Description

clip an image with a function

vtkImplicitFunctionToImageStencil will convert a vtkImplicitFunction into a stencil that can be used with vtkImageStencil or with other classes that apply a stencil to an image.

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

Definition at line 37 of file vtkImplicitFunctionToImageStencil.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)
virtual void SetInput (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetInput ()
virtual void SetInformationInput (vtkImageData *)
virtual vtkImageDataGetInformationInput ()
virtual void SetOutputOrigin (double, double, double)
virtual void SetOutputOrigin (double[3])
virtual double * GetOutputOrigin ()
virtual void GetOutputOrigin (double &, double &, double &)
virtual void GetOutputOrigin (double[3])
virtual void SetOutputSpacing (double, double, double)
virtual void SetOutputSpacing (double[3])
virtual double * GetOutputSpacing ()
virtual void GetOutputSpacing (double &, double &, double &)
virtual void GetOutputSpacing (double[3])
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
virtual void SetOutputWholeExtent (int[6])
virtual int * GetOutputWholeExtent ()
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void GetOutputWholeExtent (int[6])
virtual void SetThreshold (double)
virtual double GetThreshold ()

Static Public Member Functions

static
vtkImplicitFunctionToImageStencil
New ()
static int IsTypeOf (const char *type)
static
vtkImplicitFunctionToImageStencil
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImplicitFunctionToImageStencil ()
 ~vtkImplicitFunctionToImageStencil ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkImplicitFunctionInput
double Threshold
vtkImageDataInformationInput
int OutputWholeExtent [6]
double OutputOrigin [3]
double OutputSpacing [3]

Member Typedef Documentation

Reimplemented from vtkImageStencilSource.

Definition at line 41 of file vtkImplicitFunctionToImageStencil.h.


Constructor & Destructor Documentation

vtkImplicitFunctionToImageStencil::vtkImplicitFunctionToImageStencil (  )  [protected]

vtkImplicitFunctionToImageStencil::~vtkImplicitFunctionToImageStencil (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

static int vtkImplicitFunctionToImageStencil::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 vtkImageStencilSource.

virtual int vtkImplicitFunctionToImageStencil::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 vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

void vtkImplicitFunctionToImageStencil::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.

virtual void vtkImplicitFunctionToImageStencil::SetInput ( vtkImplicitFunction  )  [virtual]

Specify the implicit function to convert into a stencil.

virtual vtkImplicitFunction* vtkImplicitFunctionToImageStencil::GetInput (  )  [virtual]

Specify the implicit function to convert into a stencil.

virtual void vtkImplicitFunctionToImageStencil::SetInformationInput ( vtkImageData  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual vtkImageData* vtkImplicitFunctionToImageStencil::GetInformationInput (  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual void vtkImplicitFunctionToImageStencil::SetOutputOrigin ( double  ,
double  ,
double   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImplicitFunctionToImageStencil::SetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual double* vtkImplicitFunctionToImageStencil::GetOutputOrigin (  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImplicitFunctionToImageStencil::GetOutputOrigin ( double &  ,
double &  ,
double &   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImplicitFunctionToImageStencil::GetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImplicitFunctionToImageStencil::SetOutputSpacing ( double  ,
double  ,
double   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImplicitFunctionToImageStencil::SetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual double* vtkImplicitFunctionToImageStencil::GetOutputSpacing (  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImplicitFunctionToImageStencil::GetOutputSpacing ( double &  ,
double &  ,
double &   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImplicitFunctionToImageStencil::GetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImplicitFunctionToImageStencil::SetOutputWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkImplicitFunctionToImageStencil::SetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual int* vtkImplicitFunctionToImageStencil::GetOutputWholeExtent (  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkImplicitFunctionToImageStencil::GetOutputWholeExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkImplicitFunctionToImageStencil::GetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkImplicitFunctionToImageStencil::SetThreshold ( double   )  [virtual]

Set the threshold value for the implicit function.

virtual double vtkImplicitFunctionToImageStencil::GetThreshold (  )  [virtual]

Set the threshold value for the implicit function.

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.


Member Data Documentation

Definition at line 100 of file vtkImplicitFunctionToImageStencil.h.

Definition at line 101 of file vtkImplicitFunctionToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 104 of file vtkImplicitFunctionToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 108 of file vtkImplicitFunctionToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 109 of file vtkImplicitFunctionToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 110 of file vtkImplicitFunctionToImageStencil.h.


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

Generated on Mon Sep 27 18:29:58 2010 for VTK by  doxygen 1.5.6