VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSampleFunction Class Reference

sample an implicit function over a structured point set More...

#include <vtkSampleFunction.h>

Inheritance diagram for vtkSampleFunction:
[legend]
Collaboration diagram for vtkSampleFunction:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
virtual void SetScalarArrayName (const char *)
virtual char * GetScalarArrayName ()
virtual void SetNormalArrayName (const char *)
virtual char * GetNormalArrayName ()
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

 vtkSampleFunction ()
 ~vtkSampleFunction ()
virtual void ReportReferences (vtkGarbageCollector *)
void ExecuteData (vtkDataObject *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void Cap (vtkDataArray *s)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int OutputScalarType
int SampleDimensions [3]
double ModelBounds [6]
int Capping
double CapValue
vtkImplicitFunctionImplicitFunction
int ComputeNormals
char * ScalarArrayName
char * NormalArrayName

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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
Examples:
vtkSampleFunction (Examples)
Tests:
vtkSampleFunction (Tests)

Definition at line 43 of file vtkSampleFunction.h.

Member Typedef Documentation

Definition at line 46 of file vtkSampleFunction.h.

Constructor & Destructor Documentation

vtkSampleFunction::vtkSampleFunction ( )
protected

Default constructor. Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off, CapValue=VTK_DOUBLE_MAX, normal generation on, OutputScalarType set to VTK_DOUBLE, ImplicitFunction set to NULL, ScalarArrayName is "" and NormalArrayName is "".

vtkSampleFunction::~vtkSampleFunction ( )
protected

Member Function Documentation

virtual const char* vtkSampleFunction::GetClassName ( )
virtual

Reimplemented from vtkImageAlgorithm.

static int vtkSampleFunction::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 vtkSampleFunction::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 vtkSampleFunction* vtkSampleFunction::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImageAlgorithm.

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

static 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 64 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToFloat ( )
inline

Set what type of scalar data this source should generate.

Definition at line 66 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 68 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 70 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 72 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 74 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 76 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 78 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 80 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 82 of file vtkSampleFunction.h.

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 (normals are float values).

virtual int vtkSampleFunction::GetComputeNormals ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::ComputeNormalsOn ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::ComputeNormalsOff ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::SetScalarArrayName ( const char *  )
virtual

Set/get the scalar array name for this data set. Initial value is "scalars".

virtual char* vtkSampleFunction::GetScalarArrayName ( )
virtual

Set/get the scalar array name for this data set. Initial value is "scalars".

virtual void vtkSampleFunction::SetNormalArrayName ( const char *  )
virtual

Set/get the normal array name for this data set. Initial value is "normals".

virtual char* vtkSampleFunction::GetNormalArrayName ( )
virtual

Set/get the normal array name for this data set. Initial value is "normals".

unsigned long vtkSampleFunction::GetMTime ( )
virtual

Return the MTime also considering the implicit function.

Reimplemented from vtkObject.

virtual void vtkSampleFunction::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Reimplemented from vtkAlgorithm.

void vtkSampleFunction::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the old style execute method

Reimplemented from vtkImageAlgorithm.

virtual int vtkSampleFunction::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

void vtkSampleFunction::Cap ( vtkDataArray s)
protected

Member Data Documentation

int vtkSampleFunction::OutputScalarType
protected

Definition at line 164 of file vtkSampleFunction.h.

int vtkSampleFunction::SampleDimensions[3]
protected

Definition at line 165 of file vtkSampleFunction.h.

double vtkSampleFunction::ModelBounds[6]
protected

Definition at line 166 of file vtkSampleFunction.h.

int vtkSampleFunction::Capping
protected

Definition at line 167 of file vtkSampleFunction.h.

double vtkSampleFunction::CapValue
protected

Definition at line 168 of file vtkSampleFunction.h.

vtkImplicitFunction* vtkSampleFunction::ImplicitFunction
protected

Definition at line 169 of file vtkSampleFunction.h.

int vtkSampleFunction::ComputeNormals
protected

Definition at line 170 of file vtkSampleFunction.h.

char* vtkSampleFunction::ScalarArrayName
protected

Definition at line 171 of file vtkSampleFunction.h.

char* vtkSampleFunction::NormalArrayName
protected

Definition at line 172 of file vtkSampleFunction.h.


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