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

treat a volume as if it were an implicit function More...

#include <vtkImplicitVolume.h>

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

Public Types

typedef vtkImplicitFunction Superclass
 
- Public Types inherited from vtkImplicitFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImplicitVolumeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Returns the mtime also considering the volume. More...
 
void EvaluateGradient (double x[3], double n[3]) override
 Evaluate ImplicitVolume gradient. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate the ImplicitVolume. More...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate the ImplicitVolume. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate the ImplicitVolume. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate the ImplicitVolume. More...
 
virtual void SetVolume (vtkImageData *)
 Specify the volume for the implicit function. More...
 
virtual vtkImageDataGetVolume ()
 Specify the volume for the implicit function. More...
 
virtual void SetOutValue (double)
 Set the function value to use for points outside of the dataset. More...
 
virtual double GetOutValue ()
 Set the function value to use for points outside of the dataset. More...
 
virtual void SetOutGradient (double, double, double)
 Set the function gradient to use for points outside of the dataset. More...
 
virtual void SetOutGradient (double[3])
 Set the function gradient to use for points outside of the dataset. More...
 
virtual double * GetOutGradient ()
 Set the function gradient to use for points outside of the dataset. More...
 
virtual void GetOutGradient (double &, double &, double &)
 Set the function gradient to use for points outside of the dataset. More...
 
virtual void GetOutGradient (double[3])
 Set the function gradient to use for points outside of the dataset. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitVolumeSafeDownCast (vtkObjectBase *o)
 
static vtkImplicitVolumeNew ()
 Construct an vtkImplicitVolume with no initial volume; the OutValue set to a large negative number; and the OutGradient set to (0,0,1). More...
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitVolume ()
 
 ~vtkImplicitVolume () override
 
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkImageDataVolume
 
double OutValue
 
double OutGradient [3]
 
vtkIdListPointIds
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

treat a volume as if it were an implicit function

vtkImplicitVolume treats a volume (e.g., structured point dataset) as if it were an implicit function. This means it computes a function value and gradient. vtkImplicitVolume is a concrete implementation of vtkImplicitFunction.

vtkImplicitDataSet computes the function (at the point x) by performing cell interpolation. That is, it finds the cell containing x, and then uses the cell's interpolation functions to compute an interpolated scalar value at x. (A similar approach is used to find the gradient, if requested.) Points outside of the dataset are assigned the value of the ivar OutValue, and the gradient value OutGradient.

Warning
The input volume data is only updated when GetMTime() is called. Works for 3D structured points datasets, 0D-2D datasets won't work properly.
See also
vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter vtkImplicitWindowFunction
Online Examples:

Definition at line 68 of file vtkImplicitVolume.h.

Member Typedef Documentation

◆ Superclass

Definition at line 71 of file vtkImplicitVolume.h.

Constructor & Destructor Documentation

◆ vtkImplicitVolume()

vtkImplicitVolume::vtkImplicitVolume ( )
protected

◆ ~vtkImplicitVolume()

vtkImplicitVolume::~vtkImplicitVolume ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkImplicitVolume::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkImplicitVolume::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 vtkImplicitFunction.

◆ SafeDownCast()

static vtkImplicitVolume* vtkImplicitVolume::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitVolume::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkImplicitVolume* vtkImplicitVolume::NewInstance ( ) const

◆ PrintSelf()

void vtkImplicitVolume::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ New()

static vtkImplicitVolume* vtkImplicitVolume::New ( )
static

Construct an vtkImplicitVolume with no initial volume; the OutValue set to a large negative number; and the OutGradient set to (0,0,1).

◆ GetMTime()

vtkMTimeType vtkImplicitVolume::GetMTime ( )
overridevirtual

Returns the mtime also considering the volume.

This also calls Update on the volume, and it therefore must be called before the function is evaluated.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [1/4]

double vtkImplicitVolume::EvaluateFunction ( double  x[3])
overridevirtual

Evaluate the ImplicitVolume.

This returns the interpolated scalar value at x[3].

Implements vtkImplicitFunction.

◆ EvaluateGradient()

void vtkImplicitVolume::EvaluateGradient ( double  x[3],
double  n[3] 
)
overridevirtual

Evaluate ImplicitVolume gradient.

Implements vtkImplicitFunction.

◆ SetVolume()

virtual void vtkImplicitVolume::SetVolume ( vtkImageData )
virtual

Specify the volume for the implicit function.

◆ GetVolume()

virtual vtkImageData* vtkImplicitVolume::GetVolume ( )
virtual

Specify the volume for the implicit function.

◆ SetOutValue()

virtual void vtkImplicitVolume::SetOutValue ( double  )
virtual

Set the function value to use for points outside of the dataset.

◆ GetOutValue()

virtual double vtkImplicitVolume::GetOutValue ( )
virtual

Set the function value to use for points outside of the dataset.

◆ SetOutGradient() [1/2]

virtual void vtkImplicitVolume::SetOutGradient ( double  ,
double  ,
double   
)
virtual

Set the function gradient to use for points outside of the dataset.

◆ SetOutGradient() [2/2]

virtual void vtkImplicitVolume::SetOutGradient ( double  [3])
virtual

Set the function gradient to use for points outside of the dataset.

◆ GetOutGradient() [1/3]

virtual double* vtkImplicitVolume::GetOutGradient ( )
virtual

Set the function gradient to use for points outside of the dataset.

◆ GetOutGradient() [2/3]

virtual void vtkImplicitVolume::GetOutGradient ( double &  ,
double &  ,
double &   
)
virtual

Set the function gradient to use for points outside of the dataset.

◆ GetOutGradient() [3/3]

virtual void vtkImplicitVolume::GetOutGradient ( double  [3])
virtual

Set the function gradient to use for points outside of the dataset.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate the ImplicitVolume.

This returns the interpolated scalar value at x[3].

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate the ImplicitVolume.

This returns the interpolated scalar value at x[3].

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate the ImplicitVolume.

This returns the interpolated scalar value at x[3].

Definition at line 142 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Volume

vtkImageData* vtkImplicitVolume::Volume
protected

Definition at line 129 of file vtkImplicitVolume.h.

◆ OutValue

double vtkImplicitVolume::OutValue
protected

Definition at line 130 of file vtkImplicitVolume.h.

◆ OutGradient

double vtkImplicitVolume::OutGradient[3]
protected

Definition at line 131 of file vtkImplicitVolume.h.

◆ PointIds

vtkIdList* vtkImplicitVolume::PointIds
protected

Definition at line 133 of file vtkImplicitVolume.h.


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