VTK  9.3.20240328
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkEncodedGradientEstimator Class Referenceabstract

Superclass for gradient estimation. More...

#include <vtkEncodedGradientEstimator.h>

Inheritance diagram for vtkEncodedGradientEstimator:
[legend]
Collaboration diagram for vtkEncodedGradientEstimator:
[legend]

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...
 
vtkEncodedGradientEstimatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Update ()
 Recompute the encoded normals and gradient magnitudes. More...
 
unsigned short * GetEncodedNormals ()
 Get the encoded normals. More...
 
unsigned char * GetGradientMagnitudes ()
 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 vtkImageDataGetInputData ()
 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 xyzIndex)
 Get the encoded normal at an x,y,z location in the volume. More...
 
int GetEncodedNormalIndex (int xIndex, int yIndex, int zIndex)
 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 vtkDirectionEncoderGetDirectionEncoder ()
 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEncodedGradientEstimatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (vtkTypeBool 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 vtkTypeBool 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Public Attributes

vtkImageDataInputData
 
unsigned short * EncodedNormals
 
int EncodedNormalsSize [3]
 
unsigned char * GradientMagnitudes
 
vtkTimeStamp BuildTime
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkEncodedGradientEstimator ()
 
 ~vtkEncodedGradientEstimator () override
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void UpdateNormals ()=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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfThreads
 
vtkMultiThreaderThreader
 
vtkDirectionEncoderDirectionEncoder
 
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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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 34 of file vtkEncodedGradientEstimator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkEncodedGradientEstimator.h.

Constructor & Destructor Documentation

◆ vtkEncodedGradientEstimator()

vtkEncodedGradientEstimator::vtkEncodedGradientEstimator ( )
protected

◆ ~vtkEncodedGradientEstimator()

vtkEncodedGradientEstimator::~vtkEncodedGradientEstimator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkEncodedGradientEstimator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkEncodedGradientEstimator* vtkEncodedGradientEstimator::NewInstance ( ) const

◆ PrintSelf()

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.

◆ SetInputData()

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.

◆ GetInputData()

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.

◆ SetGradientMagnitudeScale()

virtual void vtkEncodedGradientEstimator::SetGradientMagnitudeScale ( float  )
virtual

Set/Get the scale and bias for the gradient magnitude.

◆ GetGradientMagnitudeScale()

virtual float vtkEncodedGradientEstimator::GetGradientMagnitudeScale ( )
virtual

Set/Get the scale and bias for the gradient magnitude.

◆ SetGradientMagnitudeBias()

virtual void vtkEncodedGradientEstimator::SetGradientMagnitudeBias ( float  )
virtual

Set/Get the scale and bias for the gradient magnitude.

◆ GetGradientMagnitudeBias()

virtual float vtkEncodedGradientEstimator::GetGradientMagnitudeBias ( )
virtual

Set/Get the scale and bias for the gradient magnitude.

◆ SetBoundsClip()

virtual void vtkEncodedGradientEstimator::SetBoundsClip ( vtkTypeBool  )
virtual

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

◆ GetBoundsClip()

virtual vtkTypeBool vtkEncodedGradientEstimator::GetBoundsClip ( )
virtual

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

◆ BoundsClipOn()

virtual void vtkEncodedGradientEstimator::BoundsClipOn ( )
virtual

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

◆ BoundsClipOff()

virtual void vtkEncodedGradientEstimator::BoundsClipOff ( )
virtual

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

◆ SetBounds() [1/2]

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.

◆ SetBounds() [2/2]

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.

◆ GetBounds() [1/2]

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.

◆ GetBounds() [2/2]

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.

◆ Update()

void vtkEncodedGradientEstimator::Update ( )

Recompute the encoded normals and gradient magnitudes.

◆ GetEncodedNormals()

unsigned short* vtkEncodedGradientEstimator::GetEncodedNormals ( )

Get the encoded normals.

◆ GetEncodedNormalIndex() [1/2]

int vtkEncodedGradientEstimator::GetEncodedNormalIndex ( vtkIdType  xyzIndex)

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

◆ GetEncodedNormalIndex() [2/2]

int vtkEncodedGradientEstimator::GetEncodedNormalIndex ( int  xIndex,
int  yIndex,
int  zIndex 
)

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

◆ GetGradientMagnitudes()

unsigned char* vtkEncodedGradientEstimator::GetGradientMagnitudes ( )

Get the gradient magnitudes.

◆ SetNumberOfThreads()

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.

◆ GetNumberOfThreads()

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.

◆ SetDirectionEncoder()

void vtkEncodedGradientEstimator::SetDirectionEncoder ( vtkDirectionEncoder direnc)

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

◆ GetDirectionEncoder()

virtual vtkDirectionEncoder* vtkEncodedGradientEstimator::GetDirectionEncoder ( )
virtual

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

◆ SetComputeGradientMagnitudes()

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

◆ GetComputeGradientMagnitudes()

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

◆ ComputeGradientMagnitudesOn()

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

◆ ComputeGradientMagnitudesOff()

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

◆ SetCylinderClip()

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.

◆ GetCylinderClip()

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.

◆ CylinderClipOn()

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.

◆ CylinderClipOff()

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.

◆ GetLastUpdateTimeInSeconds()

virtual float vtkEncodedGradientEstimator::GetLastUpdateTimeInSeconds ( )
virtual

Get the time required for the last update in seconds or cpu seconds.

◆ GetLastUpdateTimeInCPUSeconds()

virtual float vtkEncodedGradientEstimator::GetLastUpdateTimeInCPUSeconds ( )
virtual

Get the time required for the last update in seconds or cpu seconds.

◆ GetUseCylinderClip()

virtual int vtkEncodedGradientEstimator::GetUseCylinderClip ( )
virtual

◆ GetCircleLimits()

int* vtkEncodedGradientEstimator::GetCircleLimits ( )
inline

Definition at line 156 of file vtkEncodedGradientEstimator.h.

◆ SetZeroNormalThreshold()

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.

◆ GetZeroNormalThreshold()

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.

◆ SetZeroPad()

virtual void vtkEncodedGradientEstimator::SetZeroPad ( vtkTypeBool  )
virtual

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

◆ GetZeroPad()

virtual vtkTypeBool vtkEncodedGradientEstimator::GetZeroPad ( )
virtual

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

◆ ZeroPadOn()

virtual void vtkEncodedGradientEstimator::ZeroPadOn ( )
virtual

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

◆ ZeroPadOff()

virtual void vtkEncodedGradientEstimator::ZeroPadOff ( )
virtual

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

◆ GetInputSize() [1/2]

virtual int* vtkEncodedGradientEstimator::GetInputSize ( )
virtual

◆ GetInputSize() [2/2]

virtual void vtkEncodedGradientEstimator::GetInputSize ( int  data[3])
virtual

◆ GetInputAspect() [1/2]

virtual float* vtkEncodedGradientEstimator::GetInputAspect ( )
virtual

◆ GetInputAspect() [2/2]

virtual void vtkEncodedGradientEstimator::GetInputAspect ( float  data[3])
virtual

◆ ReportReferences()

void vtkEncodedGradientEstimator::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

◆ UpdateNormals()

virtual void vtkEncodedGradientEstimator::UpdateNormals ( )
protectedpure virtual

◆ ComputeCircleLimits()

void vtkEncodedGradientEstimator::ComputeCircleLimits ( int  size)
protected

Member Data Documentation

◆ InputData

vtkImageData* vtkEncodedGradientEstimator::InputData

Definition at line 187 of file vtkEncodedGradientEstimator.h.

◆ EncodedNormals

unsigned short* vtkEncodedGradientEstimator::EncodedNormals

Definition at line 190 of file vtkEncodedGradientEstimator.h.

◆ EncodedNormalsSize

int vtkEncodedGradientEstimator::EncodedNormalsSize[3]

Definition at line 191 of file vtkEncodedGradientEstimator.h.

◆ GradientMagnitudes

unsigned char* vtkEncodedGradientEstimator::GradientMagnitudes

Definition at line 194 of file vtkEncodedGradientEstimator.h.

◆ BuildTime

vtkTimeStamp vtkEncodedGradientEstimator::BuildTime

Definition at line 197 of file vtkEncodedGradientEstimator.h.

◆ NumberOfThreads

int vtkEncodedGradientEstimator::NumberOfThreads
protected

Definition at line 209 of file vtkEncodedGradientEstimator.h.

◆ Threader

vtkMultiThreader* vtkEncodedGradientEstimator::Threader
protected

Definition at line 211 of file vtkEncodedGradientEstimator.h.

◆ DirectionEncoder

vtkDirectionEncoder* vtkEncodedGradientEstimator::DirectionEncoder
protected

Definition at line 213 of file vtkEncodedGradientEstimator.h.

◆ GradientMagnitudeScale

float vtkEncodedGradientEstimator::GradientMagnitudeScale
protected

Definition at line 217 of file vtkEncodedGradientEstimator.h.

◆ GradientMagnitudeBias

float vtkEncodedGradientEstimator::GradientMagnitudeBias
protected

Definition at line 218 of file vtkEncodedGradientEstimator.h.

◆ LastUpdateTimeInSeconds

float vtkEncodedGradientEstimator::LastUpdateTimeInSeconds
protected

Definition at line 220 of file vtkEncodedGradientEstimator.h.

◆ LastUpdateTimeInCPUSeconds

float vtkEncodedGradientEstimator::LastUpdateTimeInCPUSeconds
protected

Definition at line 221 of file vtkEncodedGradientEstimator.h.

◆ ZeroNormalThreshold

float vtkEncodedGradientEstimator::ZeroNormalThreshold
protected

Definition at line 223 of file vtkEncodedGradientEstimator.h.

◆ CylinderClip

vtkTypeBool vtkEncodedGradientEstimator::CylinderClip
protected

Definition at line 225 of file vtkEncodedGradientEstimator.h.

◆ CircleLimits

int* vtkEncodedGradientEstimator::CircleLimits
protected

Definition at line 226 of file vtkEncodedGradientEstimator.h.

◆ CircleLimitsSize

int vtkEncodedGradientEstimator::CircleLimitsSize
protected

Definition at line 227 of file vtkEncodedGradientEstimator.h.

◆ UseCylinderClip

int vtkEncodedGradientEstimator::UseCylinderClip
protected

Definition at line 228 of file vtkEncodedGradientEstimator.h.

◆ BoundsClip

vtkTypeBool vtkEncodedGradientEstimator::BoundsClip
protected

Definition at line 231 of file vtkEncodedGradientEstimator.h.

◆ Bounds

int vtkEncodedGradientEstimator::Bounds[6]
protected

Definition at line 232 of file vtkEncodedGradientEstimator.h.

◆ InputSize

int vtkEncodedGradientEstimator::InputSize[3]
protected

Definition at line 234 of file vtkEncodedGradientEstimator.h.

◆ InputAspect

float vtkEncodedGradientEstimator::InputAspect[3]
protected

Definition at line 235 of file vtkEncodedGradientEstimator.h.

◆ ComputeGradientMagnitudes

vtkTypeBool vtkEncodedGradientEstimator::ComputeGradientMagnitudes
protected

Definition at line 237 of file vtkEncodedGradientEstimator.h.

◆ ZeroPad

vtkTypeBool vtkEncodedGradientEstimator::ZeroPad
protected

Definition at line 239 of file vtkEncodedGradientEstimator.h.


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