Superclass for gradient estimation. More...

#include <vtkEncodedGradientEstimator.h>

Inheritance diagram for vtkEncodedGradientEstimator:

Collaboration diagram for vtkEncodedGradientEstimator:

Public Types
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...

vtkEncodedGradientEstimator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Update (void)
	Recompute the encoded normals and gradient magnitudes. More...

unsigned short *	GetEncodedNormals (void)
	Get the encoded normals. More...

unsigned char *	GetGradientMagnitudes (void)
	Get the gradient magnitudes. More...

virtual int	GetUseCylinderClip ()

int *	GetCircleLimits ()

virtual int *	GetInputSize ()

virtual void	GetInputSize (int data[3])

virtual float *	GetInputAspect ()

virtual void	GetInputAspect (float data[3])


virtual void	SetInputData (vtkImageData *)
	Set/Get the scalar input for which the normals will be calculated. More...

virtual vtkImageData *	GetInputData ()
	Set/Get the scalar input for which the normals will be calculated. More...


virtual void	SetGradientMagnitudeScale (float)
	Set/Get the scale and bias for the gradient magnitude. More...

virtual float	GetGradientMagnitudeScale ()
	Set/Get the scale and bias for the gradient magnitude. More...

virtual void	SetGradientMagnitudeBias (float)
	Set/Get the scale and bias for the gradient magnitude. More...

virtual float	GetGradientMagnitudeBias ()
	Set/Get the scale and bias for the gradient magnitude. More...


virtual void	SetBoundsClip (vtkTypeBool)
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box. More...

virtual vtkTypeBool	GetBoundsClip ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box. More...

virtual void	BoundsClipOn ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box. More...

virtual void	BoundsClipOff ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box. More...


virtual void	SetBounds (int, int, int, int, int, int)
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. More...

virtual void	SetBounds (int[6])
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. More...

virtual int *	GetBounds ()
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. More...

virtual void	GetBounds (int data[6])
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax. More...


int	GetEncodedNormalIndex (vtkIdType xyz_index)
	Get the encoded normal at an x,y,z location in the volume. More...

int	GetEncodedNormalIndex (int x_index, int y_index, int z_index)
	Get the encoded normal at an x,y,z location in the volume. More...


virtual void	SetNumberOfThreads (int)
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine. More...

virtual int	GetNumberOfThreads ()
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine. More...


void	SetDirectionEncoder (vtkDirectionEncoder *direnc)
	Set / Get the direction encoder used to encode normal directions to fit within two bytes. More...

virtual vtkDirectionEncoder *	GetDirectionEncoder ()
	Set / Get the direction encoder used to encode normal directions to fit within two bytes. More...


virtual void	SetComputeGradientMagnitudes (vtkTypeBool)
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. More...

virtual vtkTypeBool	GetComputeGradientMagnitudes ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. More...

virtual void	ComputeGradientMagnitudesOn ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. More...

virtual void	ComputeGradientMagnitudesOff ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. More...


virtual void	SetCylinderClip (vtkTypeBool)
	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. More...

virtual vtkTypeBool	GetCylinderClip ()
	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. More...

virtual void	CylinderClipOn ()
	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. More...

virtual void	CylinderClipOff ()
	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. More...


virtual float	GetLastUpdateTimeInSeconds ()
	Get the time required for the last update in seconds or cpu seconds. More...

virtual float	GetLastUpdateTimeInCPUSeconds ()
	Get the time required for the last update in seconds or cpu seconds. More...


void	SetZeroNormalThreshold (float v)
	Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. More...

virtual float	GetZeroNormalThreshold ()
	Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. More...


virtual void	SetZeroPad (vtkTypeBool)
	Assume that the data value outside the volume is zero when computing normals. More...

virtual vtkTypeBool	GetZeroPad ()
	Assume that the data value outside the volume is zero when computing normals. More...

virtual void	ZeroPadOn ()
	Assume that the data value outside the volume is zero when computing normals. More...

virtual void	ZeroPadOff ()
	Assume that the data value outside the volume is zero when computing normals. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. 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...

vtkCommand *	GetCommand (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 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...

void	PrintRevisions (ostream &)
	Legacy. 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 vtkEncodedGradientEstimator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Public Attributes
vtkImageData *	InputData

unsigned short *	EncodedNormals

int	EncodedNormalsSize [3]

unsigned char *	GradientMagnitudes

vtkTimeStamp	BuildTime

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkEncodedGradientEstimator ()

	~vtkEncodedGradientEstimator () override

void	ReportReferences (vtkGarbageCollector *) override

virtual void	UpdateNormals (void)=0

void	ComputeCircleLimits (int size)

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	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfThreads

vtkMultiThreader *	Threader

vtkDirectionEncoder *	DirectionEncoder

float	GradientMagnitudeScale

float	GradientMagnitudeBias

float	LastUpdateTimeInSeconds

float	LastUpdateTimeInCPUSeconds

float	ZeroNormalThreshold

vtkTypeBool	CylinderClip

int *	CircleLimits

int	CircleLimitsSize

int	UseCylinderClip

vtkTypeBool	BoundsClip

int	Bounds [6]

int	InputSize [3]

float	InputAspect [3]

vtkTypeBool	ComputeGradientMagnitudes

vtkTypeBool	ZeroPad

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Definition at line 44 of file vtkEncodedGradientEstimator.h.

Member Typedef Documentation

typedef vtkObject vtkEncodedGradientEstimator::Superclass

Definition at line 47 of file vtkEncodedGradientEstimator.h.

Constructor & Destructor Documentation

vtkEncodedGradientEstimator::vtkEncodedGradientEstimator ( )

protected

vtkEncodedGradientEstimator::~vtkEncodedGradientEstimator ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool vtkEncodedGradientEstimator::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 vtkObjectBase.

Reimplemented in vtkFiniteDifferenceGradientEstimator.

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

static

virtual vtkObjectBase* vtkEncodedGradientEstimator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkFiniteDifferenceGradientEstimator.

vtkEncodedGradientEstimator* vtkEncodedGradientEstimator::NewInstance ( ) const

void vtkEncodedGradientEstimator::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 vtkObject.

Reimplemented in vtkFiniteDifferenceGradientEstimator.

virtual void vtkEncodedGradientEstimator::SetInputData ( vtkImageData * )

virtual

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

Note that this call does not setup a pipeline connection. vtkEncodedGradientEstimator is not an algorithm and does not update its input. If you are directly using this class, you may need to manually update the algorithm that produces this data object.

virtual vtkImageData* vtkEncodedGradientEstimator::GetInputData ( )

virtual

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

Note that this call does not setup a pipeline connection. vtkEncodedGradientEstimator is not an algorithm and does not update its input. If you are directly using this class, you may need to manually update the algorithm that produces this data object.

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 ( vtkTypeBool )

virtual

Turn on / off the bounding of the normal computation by the this->Bounds bounding box.

virtual vtkTypeBool 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 )

Get the encoded normals.

int vtkEncodedGradientEstimator::GetEncodedNormalIndex ( vtkIdType 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 )

Get the gradient magnitudes.

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.

void vtkEncodedGradientEstimator::SetDirectionEncoder ( vtkDirectionEncoder * direnc )

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

virtual vtkDirectionEncoder* vtkEncodedGradientEstimator::GetDirectionEncoder ( )

virtual

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

virtual void vtkEncodedGradientEstimator::SetComputeGradientMagnitudes ( vtkTypeBool )

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 vtkTypeBool 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 ( vtkTypeBool )

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 vtkTypeBool 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

Definition at line 166 of file vtkEncodedGradientEstimator.h.

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 ( vtkTypeBool )

virtual

Assume that the data value outside the volume is zero when computing normals.

virtual vtkTypeBool 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.