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

vtkSampleFunction Class Reference

#include <vtkSampleFunction.h>

Inheritance diagram for vtkSampleFunction:

Inheritance graph
[legend]
Collaboration diagram for vtkSampleFunction:

Collaboration graph
[legend]
List of all members.

Detailed Description

sample an implicit function over a structured point set

vtkSampleFunction is a source object that evaluates an implicit function and normals at each point in a vtkStructuredPoints. The user can specify the sample dimensions and location in space to perform the sampling. To create closed surfaces (in conjunction with the vtkContourFilter), capping can be turned on to set a particular value on the boundaries of the sample space.

See also:
vtkImplicitModeller
Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (46%)
  • Martin, Ken (31%)
  • Lorensen, Bill (6%)
CVS logs (CVSweb):
  • .cxx (/Imaging/vtkSampleFunction.cxx)
  • .h (/Imaging/vtkSampleFunction.h)
Examples:
vtkSampleFunction (Examples)
Tests:
vtkSampleFunction (Tests)

Definition at line 55 of file vtkSampleFunction.h.

Public Types

typedef vtkImageSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetScalars (vtkDataArray *da)
void SetSampleDimensions (int i, int j, int k)
unsigned long GetMTime ()
virtual void SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetImplicitFunction ()
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToChar ()
void SetOutputScalarTypeToUnsignedChar ()
void SetSampleDimensions (int dim[3])
virtual int * GetSampleDimensions ()
virtual void GetSampleDimensions (int data[3])
virtual void SetModelBounds (double, double, double, double, double, double)
virtual void SetModelBounds (double[6])
virtual double * GetModelBounds ()
virtual void GetModelBounds (double data[6])
virtual void SetCapping (int)
virtual int GetCapping ()
virtual void CappingOn ()
virtual void CappingOff ()
virtual void SetCapValue (double)
virtual double GetCapValue ()
virtual void SetComputeNormals (int)
virtual int GetComputeNormals ()
virtual void ComputeNormalsOn ()
virtual void ComputeNormalsOff ()

Static Public Member Functions

int IsTypeOf (const char *type)
vtkSampleFunctionSafeDownCast (vtkObject *o)
vtkSampleFunctionNew ()

Protected Member Functions

 vtkSampleFunction ()
 ~vtkSampleFunction ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void RemoveReferences ()
void ExecuteData (vtkDataObject *)
void ExecuteInformation ()
void Cap (vtkDataArray *s)

Protected Attributes

int OutputScalarType
int SampleDimensions [3]
double ModelBounds [6]
int Capping
double CapValue
vtkImplicitFunctionImplicitFunction
int ComputeNormals


Member Typedef Documentation

typedef vtkImageSource vtkSampleFunction::Superclass
 

Reimplemented from vtkImageSource.

Definition at line 58 of file vtkSampleFunction.h.


Constructor & Destructor Documentation

vtkSampleFunction::vtkSampleFunction  )  [protected]
 

vtkSampleFunction::~vtkSampleFunction  )  [protected]
 


Member Function Documentation

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

Reimplemented from vtkImageSource.

int vtkSampleFunction::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 vtkImageSource.

virtual int vtkSampleFunction::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 vtkImageSource.

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

Reimplemented from vtkImageSource.

void vtkSampleFunction::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 vtkImageSource.

vtkSampleFunction* vtkSampleFunction::New  )  [static]
 

Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off, and normal generation on.

Reimplemented from vtkAlgorithm.

virtual void vtkSampleFunction::SetImplicitFunction vtkImplicitFunction  )  [virtual]
 

Specify the implicit function to use to generate data.

virtual vtkImplicitFunction* vtkSampleFunction::GetImplicitFunction  )  [virtual]
 

Specify the implicit function to use to generate data.

virtual void vtkSampleFunction::SetOutputScalarType int   )  [virtual]
 

Set what type of scalar data this source should generate.

virtual int vtkSampleFunction::GetOutputScalarType  )  [virtual]
 

Set what type of scalar data this source should generate.

void vtkSampleFunction::SetOutputScalarTypeToDouble  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 76 of file vtkSampleFunction.h.

References VTK_DOUBLE.

void vtkSampleFunction::SetOutputScalarTypeToFloat  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 78 of file vtkSampleFunction.h.

References VTK_FLOAT.

void vtkSampleFunction::SetOutputScalarTypeToLong  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 80 of file vtkSampleFunction.h.

References VTK_LONG.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedLong  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 82 of file vtkSampleFunction.h.

References VTK_UNSIGNED_LONG.

void vtkSampleFunction::SetOutputScalarTypeToInt  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 84 of file vtkSampleFunction.h.

References VTK_INT.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedInt  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 86 of file vtkSampleFunction.h.

References VTK_UNSIGNED_INT.

void vtkSampleFunction::SetOutputScalarTypeToShort  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 88 of file vtkSampleFunction.h.

References VTK_SHORT.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedShort  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 90 of file vtkSampleFunction.h.

References VTK_UNSIGNED_SHORT.

void vtkSampleFunction::SetOutputScalarTypeToChar  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 92 of file vtkSampleFunction.h.

References VTK_CHAR.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedChar  )  [inline]
 

Set what type of scalar data this source should generate.

Definition at line 94 of file vtkSampleFunction.h.

References VTK_UNSIGNED_CHAR.

virtual void vtkSampleFunction::SetScalars vtkDataArray da  )  [virtual]
 

Control the type of the scalars object by explicitly providing a scalar object. THIS IS DEPRECATED, although it still works!!! Please use SetOutputScalarType instead.

void vtkSampleFunction::SetSampleDimensions int  i,
int  j,
int  k
 

Specify the dimensions of the data on which to sample.

void vtkSampleFunction::SetSampleDimensions int  dim[3]  ) 
 

Specify the dimensions of the data on which to sample.

virtual int* vtkSampleFunction::GetSampleDimensions  )  [virtual]
 

Specify the dimensions of the data on which to sample.

virtual void vtkSampleFunction::GetSampleDimensions int  data[3]  )  [virtual]
 

Specify the dimensions of the data on which to sample.

virtual void vtkSampleFunction::SetModelBounds double  ,
double  ,
double  ,
double  ,
double  ,
double 
[virtual]
 

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

virtual void vtkSampleFunction::SetModelBounds double  [6]  )  [virtual]
 

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

virtual double* vtkSampleFunction::GetModelBounds  )  [virtual]
 

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

virtual void vtkSampleFunction::GetModelBounds double  data[6]  )  [virtual]
 

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

virtual void vtkSampleFunction::SetCapping int   )  [virtual]
 

Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.

virtual int vtkSampleFunction::GetCapping  )  [virtual]
 

Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.

virtual void vtkSampleFunction::CappingOn  )  [virtual]
 

Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.

virtual void vtkSampleFunction::CappingOff  )  [virtual]
 

Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.

virtual void vtkSampleFunction::SetCapValue double   )  [virtual]
 

Set the cap value.

virtual double vtkSampleFunction::GetCapValue  )  [virtual]
 

Set the cap value.

virtual void vtkSampleFunction::SetComputeNormals int   )  [virtual]
 

Turn on/off the computation of normals.

virtual int vtkSampleFunction::GetComputeNormals  )  [virtual]
 

Turn on/off the computation of normals.

virtual void vtkSampleFunction::ComputeNormalsOn  )  [virtual]
 

Turn on/off the computation of normals.

virtual void vtkSampleFunction::ComputeNormalsOff  )  [virtual]
 

Turn on/off the computation of normals.

unsigned long vtkSampleFunction::GetMTime  )  [virtual]
 

Return the MTime also considering the implicit function.

Reimplemented from vtkObject.

virtual void vtkSampleFunction::ReportReferences vtkGarbageCollector  )  [protected, virtual]
 

Reimplemented from vtkSource.

virtual void vtkSampleFunction::RemoveReferences  )  [protected, virtual]
 

Reimplemented from vtkSource.

void vtkSampleFunction::ExecuteData vtkDataObject  )  [protected, virtual]
 

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method

Reimplemented from vtkSource.

void vtkSampleFunction::ExecuteInformation  )  [protected, virtual]
 

Reimplemented from vtkSource.

void vtkSampleFunction::Cap vtkDataArray s  )  [protected]
 


Member Data Documentation

int vtkSampleFunction::OutputScalarType [protected]
 

Definition at line 155 of file vtkSampleFunction.h.

int vtkSampleFunction::SampleDimensions[3] [protected]
 

Definition at line 156 of file vtkSampleFunction.h.

double vtkSampleFunction::ModelBounds[6] [protected]
 

Definition at line 157 of file vtkSampleFunction.h.

int vtkSampleFunction::Capping [protected]
 

Definition at line 158 of file vtkSampleFunction.h.

double vtkSampleFunction::CapValue [protected]
 

Definition at line 159 of file vtkSampleFunction.h.

vtkImplicitFunction* vtkSampleFunction::ImplicitFunction [protected]
 

Definition at line 160 of file vtkSampleFunction.h.

int vtkSampleFunction::ComputeNormals [protected]
 

Definition at line 161 of file vtkSampleFunction.h.


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