vtkEncodedGradientEstimator Class Reference
#include <vtkEncodedGradientEstimator.h>
Inheritance diagram for vtkEncodedGradientEstimator:
[legend]Collaboration diagram for vtkEncodedGradientEstimator:
[legend]List of all members.
Detailed Description
Superclass for gradient estimation.
vtkEncodedGradientEstimator is an abstract superclass for gradient estimation. It takes a scalar input of vtkImageData, computes a gradient value for every point, and encodes this value into a three byte value (2 for direction, 1 for magnitude) using the vtkDirectionEncoder. The direction encoder is defaulted to a vtkRecursiveSphereDirectionEncoder, but can be overridden with the SetDirectionEncoder method. The scale and the bias values for the gradient magnitude are used to convert it into a one byte value according to v = m*scale + bias where m is the magnitude and v is the resulting one byte value.
- See also:
- vtkFiniteDifferenceGradientEstimator vtkDirectionEncoder
- Created by:
-
- CVS contributions (if > 5%):
- Avila, Lisa (80%)
- Martin, Ken (6%)
- CVS logs (CVSweb):
/Rendering/vtkEncodedGradientEstimator.h)/Rendering/vtkEncodedGradientEstimator.cxx)
Definition at line 53 of file vtkEncodedGradientEstimator.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkEncodedGradientEstimator::vtkEncodedGradientEstimator |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkEncodedGradientEstimator::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkEncodedGradientEstimator::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 vtkObject.
Reimplemented in vtkFiniteDifferenceGradientEstimator. |
| virtual int vtkEncodedGradientEstimator::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 vtkObject.
Reimplemented in vtkFiniteDifferenceGradientEstimator. |
| void vtkEncodedGradientEstimator::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 vtkObject.
Reimplemented in vtkFiniteDifferenceGradientEstimator. |
| virtual void vtkEncodedGradientEstimator::SetInput |
( |
vtkImageData * |
|
) |
[virtual] |
|
|
|
Set/Get the scalar input for which the normals will be calculated |
| virtual vtkImageData* vtkEncodedGradientEstimator::GetInput |
( |
|
) |
[virtual] |
|
|
|
Set/Get the scalar input for which the normals will be calculated |
| virtual void vtkEncodedGradientEstimator::SetGradientMagnitudeScale |
( |
float |
|
) |
[virtual] |
|
|
|
Set/Get the scale and bias for the gradient magnitude |
| virtual float vtkEncodedGradientEstimator::GetGradientMagnitudeScale |
( |
|
) |
[virtual] |
|
|
|
Set/Get the scale and bias for the gradient magnitude |
| virtual void vtkEncodedGradientEstimator::SetGradientMagnitudeBias |
( |
float |
|
) |
[virtual] |
|
|
|
Set/Get the scale and bias for the gradient magnitude |
| virtual float vtkEncodedGradientEstimator::GetGradientMagnitudeBias |
( |
|
) |
[virtual] |
|
|
|
Set/Get the scale and bias for the gradient magnitude |
| virtual void vtkEncodedGradientEstimator::SetBoundsClip |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on / off the bounding of the normal computation by the this->Bounds bounding box |
| virtual int vtkEncodedGradientEstimator::GetBoundsClip |
( |
|
) |
[virtual] |
|
|
|
Turn on / off the bounding of the normal computation by the this->Bounds bounding box |
| virtual void vtkEncodedGradientEstimator::BoundsClipOn |
( |
|
) |
[virtual] |
|
|
|
Turn on / off the bounding of the normal computation by the this->Bounds bounding box |
| virtual void vtkEncodedGradientEstimator::BoundsClipOff |
( |
|
) |
[virtual] |
|
|
|
Turn on / off the bounding of the normal computation by the this->Bounds bounding box |
| virtual void vtkEncodedGradientEstimator::SetBounds |
( |
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
|
|
) |
[virtual] |
|
|
|
Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. |
| virtual void vtkEncodedGradientEstimator::SetBounds |
( |
int |
[6] |
) |
[virtual] |
|
|
|
Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. |
| virtual int* vtkEncodedGradientEstimator::GetBounds |
( |
|
) |
[virtual] |
|
|
|
Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. |
| virtual void vtkEncodedGradientEstimator::GetBounds |
( |
int |
data[6] |
) |
[virtual] |
|
|
|
Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. |
| void vtkEncodedGradientEstimator::Update |
( |
void |
|
) |
|
|
|
|
Recompute the encoded normals and gradient magnitudes. |
| unsigned short* vtkEncodedGradientEstimator::GetEncodedNormals |
( |
void |
|
) |
|
|
| int vtkEncodedGradientEstimator::GetEncodedNormalIndex |
( |
int |
xyz_index |
) |
|
|
|
|
Get the encoded normal at an x,y,z location in the volume |
| int vtkEncodedGradientEstimator::GetEncodedNormalIndex |
( |
int |
x_index, |
|
|
int |
y_index, |
|
|
int |
z_index |
|
) |
|
|
|
|
Get the encoded normal at an x,y,z location in the volume |
| unsigned char* vtkEncodedGradientEstimator::GetGradientMagnitudes |
( |
void |
|
) |
|
|
| virtual void vtkEncodedGradientEstimator::SetNumberOfThreads |
( |
int |
|
) |
[virtual] |
|
|
|
Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine |
| virtual int vtkEncodedGradientEstimator::GetNumberOfThreads |
( |
|
) |
[virtual] |
|
|
|
Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine |
|
|
Set / Get the direction encoder used to encode normal directions to fit within two bytes |
|
|
Set / Get the direction encoder used to encode normal directions to fit within two bytes |
| virtual void vtkEncodedGradientEstimator::SetComputeGradientMagnitudes |
( |
int |
|
) |
[virtual] |
|
|
|
If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash |
| virtual int vtkEncodedGradientEstimator::GetComputeGradientMagnitudes |
( |
|
) |
[virtual] |
|
|
|
If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash |
| virtual void vtkEncodedGradientEstimator::ComputeGradientMagnitudesOn |
( |
|
) |
[virtual] |
|
|
|
If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash |
| virtual void vtkEncodedGradientEstimator::ComputeGradientMagnitudesOff |
( |
|
) |
[virtual] |
|
|
|
If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash |
| virtual void vtkEncodedGradientEstimator::SetCylinderClip |
( |
int |
|
) |
[virtual] |
|
|
|
If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder. |
| virtual int vtkEncodedGradientEstimator::GetCylinderClip |
( |
|
) |
[virtual] |
|
|
|
If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder. |
| virtual void vtkEncodedGradientEstimator::CylinderClipOn |
( |
|
) |
[virtual] |
|
|
|
If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder. |
| virtual void vtkEncodedGradientEstimator::CylinderClipOff |
( |
|
) |
[virtual] |
|
|
|
If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder. |
| virtual float vtkEncodedGradientEstimator::GetLastUpdateTimeInSeconds |
( |
|
) |
[virtual] |
|
|
|
Get the time required for the last update in seconds or cpu seconds |
| virtual float vtkEncodedGradientEstimator::GetLastUpdateTimeInCPUSeconds |
( |
|
) |
[virtual] |
|
|
|
Get the time required for the last update in seconds or cpu seconds |
| virtual int vtkEncodedGradientEstimator::GetUseCylinderClip |
( |
|
) |
[virtual] |
|
| int* vtkEncodedGradientEstimator::GetCircleLimits |
( |
|
) |
[inline] |
|
| void vtkEncodedGradientEstimator::SetZeroNormalThreshold |
( |
float |
v |
) |
|
|
|
|
Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader. |
| virtual float vtkEncodedGradientEstimator::GetZeroNormalThreshold |
( |
|
) |
[virtual] |
|
|
|
Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader. |
| virtual void vtkEncodedGradientEstimator::SetZeroPad |
( |
int |
|
) |
[virtual] |
|
|
|
Assume that the data value outside the volume is zero when computing normals. |
| virtual int vtkEncodedGradientEstimator::GetZeroPad |
( |
|
) |
[virtual] |
|
|
|
Assume that the data value outside the volume is zero when computing normals. |
| virtual void vtkEncodedGradientEstimator::ZeroPadOn |
( |
|
) |
[virtual] |
|
|
|
Assume that the data value outside the volume is zero when computing normals. |
| virtual void vtkEncodedGradientEstimator::ZeroPadOff |
( |
|
) |
[virtual] |
|
|
|
Assume that the data value outside the volume is zero when computing normals. |
| virtual int* vtkEncodedGradientEstimator::GetInputSize |
( |
|
) |
[virtual] |
|
| virtual void vtkEncodedGradientEstimator::GetInputSize |
( |
int |
data[3] |
) |
[virtual] |
|
| virtual float* vtkEncodedGradientEstimator::GetInputAspect |
( |
|
) |
[virtual] |
|
| virtual void vtkEncodedGradientEstimator::GetInputAspect |
( |
float |
data[3] |
) |
[virtual] |
|
| virtual void vtkEncodedGradientEstimator::ReportReferences |
( |
vtkGarbageCollector * |
|
) |
[protected, virtual] |
|
| virtual void vtkEncodedGradientEstimator::RemoveReferences |
( |
|
) |
[protected, virtual] |
|
| virtual void vtkEncodedGradientEstimator::UpdateNormals |
( |
void |
|
) |
[protected, pure virtual] |
|
| void vtkEncodedGradientEstimator::ComputeCircleLimits |
( |
int |
size |
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: