Documentation for vtkEncodedGradientEstimator

vtkEncodedGradientEstimator - Superclass for gradient estimation

Description:

vtkEncodedGradientEstimator is an abstract superclass for gradient estimation. It takes a scalar input of vtkStructuredPoints, 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

Methods:

	void vtkEncodedGradientEstimator ()
	void vtkEncodedGradientEstimator ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void SetScalarInput (vtkStructuredPoints *)
	vtkStructuredPoints *GetScalarInput ()
	void SetGradientMagnitudeScale (float )
	float GetGradientMagnitudeScale ()
	void SetGradientMagnitudeBias (float )
	float GetGradientMagnitudeBias ()
	void Update ()
	unsigned short *GetEncodedNormals ()
	int GetEncodedNormalIndex (int )
	int GetEncodedNormalIndex (int ,int ,int )
	unsigned char *GetGradientMagnitudes ()
	void SetNumberOfThreads (int )
	int GetNumberOfThreads ()
	void SetDirectionEncoder (vtkDirectionEncoder *)
	vtkDirectionEncoder *GetDirectionEncoder ()
	void UpdateNormals ()

Detailed Method Descriptions:

Set/Get the scalar input for which the normals will be calculated

	void SetScalarInput (vtkStructuredPoints *)
	vtkStructuredPoints *GetScalarInput ()

Set/Get the scale and bias for the gradient magnitude

	void SetGradientMagnitudeScale (float )
	float GetGradientMagnitudeScale ()
	void SetGradientMagnitudeBias (float )
	float GetGradientMagnitudeBias ()

Recompute the encoded normals and gradient magnitudes.

void Update ()

Get the encoded normals.

unsigned short *GetEncodedNormals ()

Get the encoded normal at an x,y,z location in the volume

	int GetEncodedNormalIndex (int )
	int GetEncodedNormalIndex (int ,int ,int )

Get the gradient magnitudes

unsigned char *GetGradientMagnitudes ()

Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine

	void SetNumberOfThreads (int )
	int GetNumberOfThreads ()

Set / Get the direction encoder used to encode normal directions to fit within two bytes

	void SetDirectionEncoder (vtkDirectionEncoder *)
	vtkDirectionEncoder *GetDirectionEncoder ()