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

#include <vtkAttributesErrorMetric.h>

Inheritance diagram for vtkAttributesErrorMetric:

Collaboration diagram for vtkAttributesErrorMetric:

Public Member Functions
void	SetAbsoluteAttributeTolerance (double value)
	Set the absolute attribute accuracy to ‘value’. More...

void	SetAttributeTolerance (double value)
	Set the relative attribute accuracy to ‘value’. More...

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’. More...

double	GetError (double leftPoint, double midPoint, double *rightPoint, double alpha) override
	Return the error at the mid-point. More...


virtual double	GetAbsoluteAttributeTolerance ()
	Absolute tolerance of the active scalar (attribute+component). More...


virtual double	GetAttributeTolerance ()
	Relative tolerance of the active scalar (attribute+component). More...

Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
void	SetGenericCell (vtkGenericAdaptorCell *cell)
	The cell that the edge belongs to. More...

virtual vtkGenericAdaptorCell *	GetGenericCell ()
	The cell that the edge belongs to. More...

void	SetDataSet (vtkGenericDataSet *ds)
	Set/Get the dataset to be tessellated. More...

virtual vtkGenericDataSet *	GetDataSet ()
	Set/Get the dataset to be tessellated. More...

vtkGenericSubdivisionErrorMetric *	NewInstance () const
	Standard VTK type and error macros. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard VTK type and error macros. 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...

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

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 vtkAttributesErrorMetric *	New ()
	Construct the error metric with a default relative attribute accuracy equal to 0.1. More...

Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static vtkTypeBool	IsTypeOf (const char *type)
	Standard VTK type and error macros. More...

static vtkGenericSubdivisionErrorMetric *	SafeDownCast (vtkObjectBase *o)
	Standard VTK type and error macros. More...

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 (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 vtkObjectBase *	New ()
	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...

Protected Member Functions
	vtkAttributesErrorMetric ()

	~vtkAttributesErrorMetric () override

void	ComputeSquareAbsoluteAttributeTolerance ()
	Compute the square absolute attribute tolerance, only if the cached value is obsolete. More...

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. 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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	AttributeTolerance

double	SquareAbsoluteAttributeTolerance

double	AbsoluteAttributeTolerance

int	DefinedByAbsolute

vtkTimeStamp	SquareAbsoluteAttributeToleranceComputeTime

double	Range

vtkGenericAttributeCollection *	AttributeCollection

Protected Attributes inherited from vtkGenericSubdivisionErrorMetric
vtkGenericAdaptorCell *	GenericCell

vtkGenericDataSet *	DataSet

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. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard VTK type and error macros. More...

static vtkAttributesErrorMetric *	SafeDownCast (vtkObjectBase *o)
	Standard VTK type and error macros. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard VTK type and error macros. More...

vtkAttributesErrorMetric *	NewInstance () const
	Standard VTK type and error macros. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard VTK type and error macros. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK type and error macros. More...

Additional Inherited Members
Public Types inherited from vtkGenericSubdivisionErrorMetric
typedef vtkObject	Superclass
	Standard VTK type and error macros. More...

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

typedef vtkGenericSubdivisionErrorMetric vtkAttributesErrorMetric::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 vtkObject.

◆ 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:

Common/DataModel/vtkAttributesErrorMetric.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAttributesErrorMetric()

◆ ~vtkAttributesErrorMetric()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetAbsoluteAttributeTolerance()

◆ SetAbsoluteAttributeTolerance()

◆ GetAttributeTolerance()

◆ SetAttributeTolerance()

◆ RequiresEdgeSubdivision()

◆ GetError()

◆ ComputeSquareAbsoluteAttributeTolerance()

Member Data Documentation

◆ AttributeTolerance

◆ SquareAbsoluteAttributeTolerance

◆ AbsoluteAttributeTolerance

◆ DefinedByAbsolute

◆ SquareAbsoluteAttributeToleranceComputeTime

◆ Range

◆ AttributeCollection