VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkVoxelModeller Class Reference

convert an arbitrary dataset to a voxel representation More...

#include <vtkVoxelModeller.h>

Inherits vtkImageAlgorithm.

Public Types

typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkVoxelModellerNewInstance () const
 
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 (vtkObjectBase *o)
 
static vtkVoxelModellerNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
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
 
virtual void SetForegroundValue (double)
 
virtual double GetForegroundValue ()
 
virtual void SetBackgroundValue (double)
 
virtual double GetBackgroundValue ()
 
 vtkVoxelModeller ()
 
 ~vtkVoxelModeller ()
 

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 39 of file vtkVoxelModeller.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkVoxelModeller::Superclass

Definition at line 42 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 ( )
inlineprotected

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 114 of file vtkVoxelModeller.h.

Member Function Documentation

static int vtkVoxelModeller::IsTypeOf ( const char *  type)
static
virtual int vtkVoxelModeller::IsA ( const char *  type)
virtual
static vtkVoxelModeller* vtkVoxelModeller::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkVoxelModeller::NewInstanceInternal ( ) const
protectedvirtual
vtkVoxelModeller* vtkVoxelModeller::NewInstance ( ) const
void vtkVoxelModeller::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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 83 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 84 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 85 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 86 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 88 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 89 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 91 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 92 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 94 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 96 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 98 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 *   
)
protectedvirtual
virtual int vtkVoxelModeller::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual int vtkVoxelModeller::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Member Data Documentation

int vtkVoxelModeller::SampleDimensions[3]
protected

Definition at line 129 of file vtkVoxelModeller.h.

double vtkVoxelModeller::MaximumDistance
protected

Definition at line 130 of file vtkVoxelModeller.h.

double vtkVoxelModeller::ModelBounds[6]
protected

Definition at line 131 of file vtkVoxelModeller.h.

double vtkVoxelModeller::ForegroundValue
protected

Definition at line 132 of file vtkVoxelModeller.h.

double vtkVoxelModeller::BackgroundValue
protected

Definition at line 133 of file vtkVoxelModeller.h.

int vtkVoxelModeller::ScalarType
protected

Definition at line 134 of file vtkVoxelModeller.h.


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