vtkImplicitSum Class Reference
#include <vtkImplicitSum.h>
Inheritance diagram for vtkImplicitSum:
[legend]Collaboration diagram for vtkImplicitSum:
[legend]List of all members.
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.
- Created by:
-
- CVS contributions (if > 5%):
- Halle, Michael (73%)
- Martin, Ken (10%)
- Schroeder, Will (6%)
- King, Brad (5%)
- CVS logs (CVSweb):
/Filtering/vtkImplicitSum.h)/Filtering/vtkImplicitSum.cxx)
- Examples:
- vtkImplicitSum (Examples)
- Tests:
- vtkImplicitSum (Tests)
Definition at line 52 of file vtkImplicitSum.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkImplicitSum::vtkImplicitSum |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject. |
| virtual const char* vtkImplicitSum::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkImplicitSum::IsTypeOf |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction. |
| virtual int vtkImplicitSum::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction. |
| 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] |
|
| 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. |
|
|
Add another implicit function to the list of functions, along with a weighting factor. |
|
|
Add another implicit function to the list of functions, weighting it by a factor of 1.
Definition at line 80 of file vtkImplicitSum.h. |
| void vtkImplicitSum::RemoveAllFunctions |
( |
|
) |
|
|
|
|
Remove all functions from the list. |
|
|
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
The documentation for this class was generated from the following file: