VTK  9.4.20241222
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAttributesErrorMetric Class Reference

Objects that compute attribute-based error during cell tessellation. More...

#include <vtkAttributesErrorMetric.h>

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

Public Member Functions

void SetAbsoluteAttributeTolerance (double value)
 Set the absolute attribute accuracy to ‘value’.
 
void SetAttributeTolerance (double value)
 Set the relative attribute accuracy to ‘value’.
 
int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha) override
 Does the edge need to be subdivided according to the distance between the value of the active attribute/component at the midpoint and the mean value between the endpoints? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’.
 
double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha) override
 Return the error at the mid-point.
 
virtual double GetAbsoluteAttributeTolerance ()
 Absolute tolerance of the active scalar (attribute+component).
 
virtual double GetAttributeTolerance ()
 Relative tolerance of the active scalar (attribute+component).
 
- Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
virtual int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha)=0
 Does the edge need to be subdivided according to the implemented computation? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’.
 
virtual double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha)=0
 Return the error at the mid-point.
 
void SetGenericCell (vtkGenericAdaptorCell *cell)
 The cell that the edge belongs to.
 
virtual vtkGenericAdaptorCellGetGenericCell ()
 The cell that the edge belongs to.
 
void SetDataSet (vtkGenericDataSet *ds)
 Set/Get the dataset to be tessellated.
 
virtual vtkGenericDataSetGetDataSet ()
 Set/Get the dataset to be tessellated.
 
vtkGenericSubdivisionErrorMetricNewInstance () const
 Standard VTK type and error macros.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK type and error macros.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkAttributesErrorMetricNew ()
 Construct the error metric with a default relative attribute accuracy equal to 0.1.
 
- Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK type and error macros.
 
static vtkGenericSubdivisionErrorMetricSafeDownCast (vtkObjectBase *o)
 Standard VTK type and error macros.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

 vtkAttributesErrorMetric ()
 
 ~vtkAttributesErrorMetric () override
 
void ComputeSquareAbsoluteAttributeTolerance ()
 Compute the square absolute attribute tolerance, only if the cached value is obsolete.
 
- Protected Member Functions inherited from vtkGenericSubdivisionErrorMetric
 vtkGenericSubdivisionErrorMetric ()
 
 ~vtkGenericSubdivisionErrorMetric () override
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double AttributeTolerance
 
double SquareAbsoluteAttributeTolerance
 
double AbsoluteAttributeTolerance
 
int DefinedByAbsolute
 
vtkTimeStamp SquareAbsoluteAttributeToleranceComputeTime
 
double Range
 
vtkGenericAttributeCollectionAttributeCollection
 
- Protected Attributes inherited from vtkGenericSubdivisionErrorMetric
vtkGenericAdaptorCellGenericCell
 
vtkGenericDataSetDataSet
 
- 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
 
typedef vtkGenericSubdivisionErrorMetric Superclass
 Standard VTK type and error macros.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK type and error macros.
 
static vtkAttributesErrorMetricSafeDownCast (vtkObjectBase *o)
 Standard VTK type and error macros.
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK type and error macros.
 
vtkAttributesErrorMetricNewInstance () const
 Standard VTK type and error macros.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK type and error macros.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK type and error macros.
 

Additional Inherited Members

- Public Types inherited from vtkGenericSubdivisionErrorMetric
typedef vtkObject Superclass
 Standard VTK type and error macros.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Objects that compute attribute-based error during cell tessellation.

It is a concrete error metric, based on an attribute criterium: the variation of the active attribute/component value from a linear ramp

See also
vtkGenericCellTessellator vtkGenericSubdivisionErrorMetric
Tests:
vtkAttributesErrorMetric (Tests)

Definition at line 29 of file vtkAttributesErrorMetric.h.

Member Typedef Documentation

◆ Superclass

Standard VTK type and error macros.

Definition at line 42 of file vtkAttributesErrorMetric.h.

Constructor & Destructor Documentation

◆ vtkAttributesErrorMetric()

vtkAttributesErrorMetric::vtkAttributesErrorMetric ( )
protected

◆ ~vtkAttributesErrorMetric()

vtkAttributesErrorMetric::~vtkAttributesErrorMetric ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkAttributesErrorMetric * vtkAttributesErrorMetric::New ( )
static

Construct the error metric with a default relative attribute accuracy equal to 0.1.

◆ IsTypeOf()

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

Standard VTK type and error macros.

◆ IsA()

virtual vtkTypeBool vtkAttributesErrorMetric::IsA ( const char *  type)
virtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

◆ SafeDownCast()

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

Standard VTK type and error macros.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAttributesErrorMetric::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

◆ NewInstance()

vtkAttributesErrorMetric * vtkAttributesErrorMetric::NewInstance ( ) const

Standard VTK type and error macros.

◆ PrintSelf()

void vtkAttributesErrorMetric::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard VTK type and error macros.

Reimplemented from vtkObjectBase.

◆ GetAbsoluteAttributeTolerance()

virtual double vtkAttributesErrorMetric::GetAbsoluteAttributeTolerance ( )
virtual

Absolute tolerance of the active scalar (attribute+component).

Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AbsoluteAttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.

◆ SetAbsoluteAttributeTolerance()

void vtkAttributesErrorMetric::SetAbsoluteAttributeTolerance ( double  value)

Set the absolute attribute accuracy to ‘value’.

See GetAbsoluteAttributeTolerance() for details. It is particularly useful when some concrete implementation of vtkGenericAttribute does not support GetRange() request, called internally in SetAttributeTolerance(). It may happen when the implementation support higher order attributes but cannot compute the range.

Precondition
valid_range_value: value>0

◆ GetAttributeTolerance()

virtual double vtkAttributesErrorMetric::GetAttributeTolerance ( )
virtual

Relative tolerance of the active scalar (attribute+component).

Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.

◆ SetAttributeTolerance()

void vtkAttributesErrorMetric::SetAttributeTolerance ( double  value)

Set the relative attribute accuracy to ‘value’.

See GetAttributeTolerance() for details.

Precondition
valid_range_value: value>0 && value<1

◆ RequiresEdgeSubdivision()

int vtkAttributesErrorMetric::RequiresEdgeSubdivision ( double *  leftPoint,
double *  midPoint,
double *  rightPoint,
double  alpha 
)
overridevirtual

Does the edge need to be subdivided according to the distance between the value of the active attribute/component at the midpoint and the mean value between the endpoints? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’.

‘leftPoint’, ‘midPoint’ and ‘rightPoint’ have to be initialized before calling RequiresEdgeSubdivision(). Their format is global coordinates, parametric coordinates and point centered attributes: xyx rst abc de... ‘alpha’ is the normalized abscissa of the midpoint along the edge. (close to 0 means close to the left point, close to 1 means close to the right point)

Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6

Implements vtkGenericSubdivisionErrorMetric.

◆ GetError()

double vtkAttributesErrorMetric::GetError ( double *  leftPoint,
double *  midPoint,
double *  rightPoint,
double  alpha 
)
overridevirtual

Return the error at the mid-point.

The type of error depends on the state of the concrete error metric. For instance, it can return an absolute or relative error metric. See RequiresEdgeSubdivision() for a description of the arguments.

Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0

Implements vtkGenericSubdivisionErrorMetric.

◆ ComputeSquareAbsoluteAttributeTolerance()

void vtkAttributesErrorMetric::ComputeSquareAbsoluteAttributeTolerance ( )
protected

Compute the square absolute attribute tolerance, only if the cached value is obsolete.

Member Data Documentation

◆ AttributeTolerance

double vtkAttributesErrorMetric::AttributeTolerance
protected

Definition at line 136 of file vtkAttributesErrorMetric.h.

◆ SquareAbsoluteAttributeTolerance

double vtkAttributesErrorMetric::SquareAbsoluteAttributeTolerance
protected

Definition at line 138 of file vtkAttributesErrorMetric.h.

◆ AbsoluteAttributeTolerance

double vtkAttributesErrorMetric::AbsoluteAttributeTolerance
protected

Definition at line 141 of file vtkAttributesErrorMetric.h.

◆ DefinedByAbsolute

int vtkAttributesErrorMetric::DefinedByAbsolute
protected

Definition at line 142 of file vtkAttributesErrorMetric.h.

◆ SquareAbsoluteAttributeToleranceComputeTime

vtkTimeStamp vtkAttributesErrorMetric::SquareAbsoluteAttributeToleranceComputeTime
protected

Definition at line 144 of file vtkAttributesErrorMetric.h.

◆ Range

double vtkAttributesErrorMetric::Range
protected

Definition at line 146 of file vtkAttributesErrorMetric.h.

◆ AttributeCollection

vtkGenericAttributeCollection* vtkAttributesErrorMetric::AttributeCollection
protected

Definition at line 148 of file vtkAttributesErrorMetric.h.


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