VTK
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)
 
void SetAttributeTolerance (double value)
 
virtual double GetAbsoluteAttributeTolerance ()
 
virtual double GetAttributeTolerance ()
 
int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha)
 
double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha)
 
- Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
void SetGenericCell (vtkGenericAdaptorCell *cell)
 
virtual vtkGenericAdaptorCellGetGenericCell ()
 
void SetDataSet (vtkGenericDataSet *ds)
 
virtual vtkGenericDataSetGetDataSet ()
 
vtkGenericSubdivisionErrorMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkAttributesErrorMetricNew ()
 
- Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static int IsTypeOf (const char *type)
 
static vtkGenericSubdivisionErrorMetricSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkAttributesErrorMetric ()
 
virtual ~vtkAttributesErrorMetric ()
 
void ComputeSquareAbsoluteAttributeTolerance ()
 
- Protected Member Functions inherited from vtkGenericSubdivisionErrorMetric
 vtkGenericSubdivisionErrorMetric ()
 
 ~vtkGenericSubdivisionErrorMetric ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
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
 
vtkGenericAttributeCollectionAttributeCollection
 
- Protected Attributes inherited from vtkGenericSubdivisionErrorMetric
vtkGenericAdaptorCellGenericCell
 
vtkGenericDataSetDataSet
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkGenericSubdivisionErrorMetric Superclass
 
static int IsTypeOf (const char *type)
 
static vtkAttributesErrorMetricSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkAttributesErrorMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBaseNewInstanceInternal () const
 

Additional Inherited Members

- Public Types inherited from vtkGenericSubdivisionErrorMetric
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

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 39 of file vtkAttributesErrorMetric.h.

Member Typedef Documentation

Standard VTK type and error macros.

Definition at line 48 of file vtkAttributesErrorMetric.h.

Constructor & Destructor Documentation

vtkAttributesErrorMetric::vtkAttributesErrorMetric ( )
protected
virtual vtkAttributesErrorMetric::~vtkAttributesErrorMetric ( )
protectedvirtual

Member Function Documentation

static vtkAttributesErrorMetric* vtkAttributesErrorMetric::New ( )
static

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

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

Standard VTK type and error macros.

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

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

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

Standard VTK type and error macros.

virtual vtkObjectBase* vtkAttributesErrorMetric::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

vtkAttributesErrorMetric* vtkAttributesErrorMetric::NewInstance ( ) const

Standard VTK type and error macros.

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

Standard VTK type and error macros.

Reimplemented from vtkObject.

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.

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

void vtkAttributesErrorMetric::SetAttributeTolerance ( double  value)

Set the relative attribute accuracy to `value'. See GetAttributeTolerance() for details.

Precondition
valid_range_value: value>0 && value<1
int vtkAttributesErrorMetric::RequiresEdgeSubdivision ( double leftPoint,
double midPoint,
double rightPoint,
double  alpha 
)
virtual

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.

double vtkAttributesErrorMetric::GetError ( double leftPoint,
double midPoint,
double rightPoint,
double  alpha 
)
virtual

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.

void vtkAttributesErrorMetric::ComputeSquareAbsoluteAttributeTolerance ( )
protected

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

Member Data Documentation

double vtkAttributesErrorMetric::AttributeTolerance
protected

Definition at line 125 of file vtkAttributesErrorMetric.h.

double vtkAttributesErrorMetric::SquareAbsoluteAttributeTolerance
protected

Definition at line 127 of file vtkAttributesErrorMetric.h.

double vtkAttributesErrorMetric::AbsoluteAttributeTolerance
protected

Definition at line 130 of file vtkAttributesErrorMetric.h.

int vtkAttributesErrorMetric::DefinedByAbsolute
protected

Definition at line 131 of file vtkAttributesErrorMetric.h.

vtkTimeStamp vtkAttributesErrorMetric::SquareAbsoluteAttributeToleranceComputeTime
protected

Definition at line 133 of file vtkAttributesErrorMetric.h.

double vtkAttributesErrorMetric::Range
protected

Definition at line 135 of file vtkAttributesErrorMetric.h.

vtkGenericAttributeCollection* vtkAttributesErrorMetric::AttributeCollection
protected

Definition at line 137 of file vtkAttributesErrorMetric.h.


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