vtkVoxelModeller Class Reference

#include <vtkVoxelModeller.h>

Inheritance diagram for vtkVoxelModeller:

Inheritance graph
[legend]
Collaboration diagram for vtkVoxelModeller:

Collaboration graph
[legend]

List of all members.


Detailed Description

convert an arbitrary dataset to a voxel representation

vtkVoxelModeller is a filter that converts an arbitrary data set to a structured point (i.e., voxel) representation. It is very similar to vtkImplicitModeller, except that it doesn't record distance; instead it records occupancy. By default it supports a compact output of 0/1 VTK_BIT. Other vtk scalar types can be specified. The Foreground and Background values of the output can also be specified. NOTE: Not all vtk filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

See also:
vtkImplicitModeller
Tests:
vtkVoxelModeller (Tests)

Definition at line 38 of file vtkVoxelModeller.h.

virtual void SetForegroundValue (double)
virtual double GetForegroundValue ()
virtual void SetBackgroundValue (double)
virtual double GetBackgroundValue ()
 vtkVoxelModeller ()
 ~vtkVoxelModeller ()

Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
double ComputeModelBounds (double origin[3], double ar[3])
void SetSampleDimensions (int i, int j, int k)
void SetSampleDimensions (int dim[3])
virtual int * GetSampleDimensions ()
virtual void GetSampleDimensions (int data[3])
virtual void SetMaximumDistance (double)
virtual double GetMaximumDistance ()
void SetModelBounds (double bounds[6])
void SetModelBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
virtual double * GetModelBounds ()
virtual void GetModelBounds (double data[6])
virtual void SetScalarType (int)
void SetScalarTypeToFloat ()
void SetScalarTypeToDouble ()
void SetScalarTypeToInt ()
void SetScalarTypeToUnsignedInt ()
void SetScalarTypeToLong ()
void SetScalarTypeToUnsignedLong ()
void SetScalarTypeToShort ()
void SetScalarTypeToUnsignedShort ()
void SetScalarTypeToUnsignedChar ()
void SetScalarTypeToChar ()
void SetScalarTypeToBit ()
virtual int GetScalarType ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkVoxelModellerSafeDownCast (vtkObject *o)
static vtkVoxelModellerNew ()

Protected Member Functions

virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillInputPortInformation (int port, vtkInformation *info)

Protected Attributes

int SampleDimensions [3]
double MaximumDistance
double ModelBounds [6]
double ForegroundValue
double BackgroundValue
int ScalarType

Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Definition at line 41 of file vtkVoxelModeller.h.


Constructor & Destructor Documentation

vtkVoxelModeller::vtkVoxelModeller (  )  [protected]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

vtkVoxelModeller::~vtkVoxelModeller (  )  [inline, protected]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

Definition at line 113 of file vtkVoxelModeller.h.


Member Function Documentation

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

Reimplemented from vtkImageAlgorithm.

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

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

Reimplemented from vtkImageAlgorithm.

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

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

Construct an instance of vtkVoxelModeller with its sample dimensions set to (50,50,50), and so that the model bounds are automatically computed from its input. The maximum distance is set to examine the whole grid. This could be made much faster, and probably will be in the future.

Reimplemented from vtkAlgorithm.

double vtkVoxelModeller::ComputeModelBounds ( double  origin[3],
double  ar[3] 
)

Compute the ModelBounds based on the input geometry.

void vtkVoxelModeller::SetSampleDimensions ( int  i,
int  j,
int  k 
)

Set the i-j-k dimensions on which to sample the distance function. Default is (50, 50, 50)

void vtkVoxelModeller::SetSampleDimensions ( int  dim[3]  ) 

Set the i-j-k dimensions on which to sample the distance function. Default is (50, 50, 50)

virtual int* vtkVoxelModeller::GetSampleDimensions (  )  [virtual]

Set the i-j-k dimensions on which to sample the distance function. Default is (50, 50, 50)

virtual void vtkVoxelModeller::GetSampleDimensions ( int  data[3]  )  [virtual]

Set the i-j-k dimensions on which to sample the distance function. Default is (50, 50, 50)

virtual void vtkVoxelModeller::SetMaximumDistance ( double   )  [virtual]

Specify distance away from surface of input geometry to sample. Smaller values make large increases in performance. Default is 1.0.

virtual double vtkVoxelModeller::GetMaximumDistance (  )  [virtual]

Specify distance away from surface of input geometry to sample. Smaller values make large increases in performance. Default is 1.0.

void vtkVoxelModeller::SetModelBounds ( double  bounds[6]  ) 

Specify the position in space to perform the voxelization. Default is (0, 0, 0, 0, 0, 0)

void vtkVoxelModeller::SetModelBounds ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

Specify the position in space to perform the voxelization. Default is (0, 0, 0, 0, 0, 0)

virtual double* vtkVoxelModeller::GetModelBounds (  )  [virtual]

Specify the position in space to perform the voxelization. Default is (0, 0, 0, 0, 0, 0)

virtual void vtkVoxelModeller::GetModelBounds ( double  data[6]  )  [virtual]

Specify the position in space to perform the voxelization. Default is (0, 0, 0, 0, 0, 0)

virtual void vtkVoxelModeller::SetScalarType ( int   )  [virtual]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

void vtkVoxelModeller::SetScalarTypeToFloat (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 82 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToDouble (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 83 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToInt (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 84 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToUnsignedInt (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 85 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToLong (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 87 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToUnsignedLong (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 88 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToShort (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 90 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToUnsignedShort (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 91 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToUnsignedChar (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 93 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToChar (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 95 of file vtkVoxelModeller.h.

void vtkVoxelModeller::SetScalarTypeToBit (  )  [inline]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

Definition at line 97 of file vtkVoxelModeller.h.

virtual int vtkVoxelModeller::GetScalarType (  )  [virtual]

Control the scalar type of the output image. The default is VTK_BIT. NOTE: Not all filters/readers/writers support the VTK_BIT scalar type. You may want to use VTK_CHAR as an alternative.

virtual void vtkVoxelModeller::SetForegroundValue ( double   )  [virtual]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

virtual double vtkVoxelModeller::GetForegroundValue (  )  [virtual]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

virtual void vtkVoxelModeller::SetBackgroundValue ( double   )  [virtual]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

virtual double vtkVoxelModeller::GetBackgroundValue (  )  [virtual]

Set the Foreground/Background values of the output. The Foreground value is set when a voxel is occupied. The Background value is set when a voxel is not occupied. The default ForegroundValue is 1. The default BackgroundValue is 0.

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

Reimplemented from vtkImageAlgorithm.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

virtual int vtkVoxelModeller::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 vtkImageAlgorithm.


Member Data Documentation

Definition at line 128 of file vtkVoxelModeller.h.

Definition at line 129 of file vtkVoxelModeller.h.

double vtkVoxelModeller::ModelBounds[6] [protected]

Definition at line 130 of file vtkVoxelModeller.h.

Definition at line 131 of file vtkVoxelModeller.h.

Definition at line 132 of file vtkVoxelModeller.h.

Definition at line 133 of file vtkVoxelModeller.h.


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

Generated on Wed Aug 24 12:19:18 2011 for VTK by  doxygen 1.5.6