vtkImplicitSum Class Reference

implicit sum of other implicit functions More...

#include <vtkImplicitSum.h>

Inheritance diagram for vtkImplicitSum:

Collaboration diagram for vtkImplicitSum:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkImplicitSum *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	EvaluateGradient (double x[3], double g[3])
unsigned long	GetMTime ()
void	AddFunction (vtkImplicitFunction *in, double weight)
void	AddFunction (vtkImplicitFunction *in)
void	RemoveAllFunctions ()
void	SetFunctionWeight (vtkImplicitFunction *f, double weight)
double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)
virtual void	SetNormalizeByWeight (int)
virtual int	GetNormalizeByWeight ()
virtual void	NormalizeByWeightOn ()
virtual void	NormalizeByWeightOff ()
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const
double	FunctionValue (const double x[3])
double	FunctionValue (double x, double y, double z)
void	FunctionGradient (const double x[3], double g[3])
double *	FunctionGradient (const double x[3])
double *	FunctionGradient (double x, double y, double z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual void	SetTransform (const double elements[16])
virtual vtkAbstractTransform *	GetTransform ()
double	EvaluateFunction (double x, double y, double z)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkImplicitSum *	New ()
static int	IsTypeOf (const char *type)
static vtkImplicitSum *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)
static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImplicitSum ()
	~vtkImplicitSum ()
void	CalculateTotalWeight (void)
Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()
	~vtkImplicitFunction ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImplicitFunctionCollection *	FunctionList
vtkDoubleArray *	Weights
double	TotalWeight
int	NormalizeByWeight
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

implicit sum of other implicit functions

vtkImplicitSum produces a linear combination of other implicit functions. The contribution of each function is weighted by a scalar coefficient. The NormalizeByWeight option normalizes the output so that the scalar weights add up to 1. Note that this function gives accurate sums and gradients only if the input functions are linear.

Examples:

vtkImplicitSum (Examples)

Tests:

vtkImplicitSum (Tests)

Definition at line 40 of file vtkImplicitSum.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitSum::Superclass

Definition at line 45 of file vtkImplicitSum.h.

Constructor & Destructor Documentation

vtkImplicitSum::vtkImplicitSum ( )

protected

vtkImplicitSum::~vtkImplicitSum ( )

protected

Member Function Documentation

static vtkImplicitSum* vtkImplicitSum::New ( )

static

static int vtkImplicitSum::IsTypeOf ( const char *  type )

static

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

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

static

virtual vtkObjectBase* vtkImplicitSum::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkImplicitSum* vtkImplicitSum::NewInstance

(

)

const

void vtkImplicitSum::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 vtkImplicitFunction.

double vtkImplicitSum::EvaluateFunction ( double  x[3] )

virtual

Evaluate implicit function using current functions and weights.

Implements vtkImplicitFunction.

double vtkImplicitSum::EvaluateFunction ( double  x, double  y, double  z  )

inline

Evaluate implicit function using current functions and weights.

Definition at line 51 of file vtkImplicitSum.h.

void vtkImplicitSum::EvaluateGradient ( double  x[3], double  g[3]  )

virtual

Evaluate gradient of the weighted sum of functions. Input functions should be linear.

Implements vtkImplicitFunction.

unsigned long vtkImplicitSum::GetMTime ( )

virtual

Override modified time retrieval because of object dependencies.

Reimplemented from vtkImplicitFunction.

void vtkImplicitSum::AddFunction	(	vtkImplicitFunction *	in,
		double	weight
	)

Add another implicit function to the list of functions, along with a weighting factor.

void vtkImplicitSum::AddFunction ( vtkImplicitFunction *  in )

inline

Add another implicit function to the list of functions, weighting it by a factor of 1.

Definition at line 68 of file vtkImplicitSum.h.

void vtkImplicitSum::RemoveAllFunctions

(

)

Remove all functions from the list.

void vtkImplicitSum::SetFunctionWeight	(	vtkImplicitFunction *	f,
		double	weight
	)

Set the weight (coefficient) of the given function to be weight.

virtual void vtkImplicitSum::SetNormalizeByWeight ( int  )

virtual

When calculating the function and gradient values of the composite function, setting NormalizeByWeight on will divide the final result by the total weight of the component functions. This process does not otherwise normalize the gradient vector. By default, NormalizeByWeight is off.

virtual int vtkImplicitSum::GetNormalizeByWeight ( )

virtual

When calculating the function and gradient values of the composite function, setting NormalizeByWeight on will divide the final result by the total weight of the component functions. This process does not otherwise normalize the gradient vector. By default, NormalizeByWeight is off.

virtual void vtkImplicitSum::NormalizeByWeightOn ( )

virtual

When calculating the function and gradient values of the composite function, setting NormalizeByWeight on will divide the final result by the total weight of the component functions. This process does not otherwise normalize the gradient vector. By default, NormalizeByWeight is off.

virtual void vtkImplicitSum::NormalizeByWeightOff ( )

virtual

When calculating the function and gradient values of the composite function, setting NormalizeByWeight on will divide the final result by the total weight of the component functions. This process does not otherwise normalize the gradient vector. By default, NormalizeByWeight is off.

void vtkImplicitSum::CalculateTotalWeight ( void  )

protected

Member Data Documentation

vtkImplicitFunctionCollection* vtkImplicitSum::FunctionList

protected

Definition at line 91 of file vtkImplicitSum.h.

vtkDoubleArray* vtkImplicitSum::Weights

protected

Definition at line 92 of file vtkImplicitSum.h.

double vtkImplicitSum::TotalWeight

protected

Definition at line 93 of file vtkImplicitSum.h.

int vtkImplicitSum::NormalizeByWeight

protected

Definition at line 96 of file vtkImplicitSum.h.

---

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

• dox/Common/DataModel/vtkImplicitSum.h