VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkReebGraphSimplificationMetric Class Reference

abstract class for custom Reeb graph simplification metric design. More...

#include <vtkReebGraphSimplificationMetric.h>

Inheritance diagram for vtkReebGraphSimplificationMetric:
[legend]
Collaboration diagram for vtkReebGraphSimplificationMetric:
[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.
 
vtkReebGraphSimplificationMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual double ComputeMetric (vtkDataSet *mesh, vtkDataArray *field, vtkIdType startCriticalPoint, vtkAbstractArray *vertexList, vtkIdType endCriticalPoint)
 Function to implement in your simplification metric algorithm.
 
virtual void SetLowerBound (double)
 Set the lowest possible value for the custom metric space.
 
virtual double GetLowerBound ()
 Set the lowest possible value for the custom metric space.
 
virtual void SetUpperBound (double)
 Set the highest possible value for the custom metric space.
 
virtual double GetUpperBound ()
 Set the highest possible value for the custom metric space.
 
- 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)
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

Static Public Member Functions

static vtkReebGraphSimplificationMetricNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkReebGraphSimplificationMetricSafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int 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 int 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

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkReebGraphSimplificationMetric ()
 
 ~vtkReebGraphSimplificationMetric () 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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double LowerBound
 
double UpperBound
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

abstract class for custom Reeb graph simplification metric design.

This class makes it possible to design customized simplification metric evaluation algorithms, enabling the user to control the definition of what should be considered as noise or signal in the topological filtering process.

References: "Topological persistence and simplification", H. Edelsbrunner, D. Letscher, and A. Zomorodian, Discrete Computational Geometry, 28:511-533, 2002.

"Extreme elevation on a 2-manifold", P.K. Agarwal, H. Edelsbrunner, J. Harer, and Y. Wang, ACM Symposium on Computational Geometry, pp. 357-365, 2004.

"Simplifying flexible isosurfaces using local geometric measures", H. Carr, J. Snoeyink, M van de Panne, IEEE Visualization, 497-504, 2004

"Loop surgery for volumetric meshes: Reeb graphs reduced to contour trees", J. Tierny, A. Gyulassy, E. Simon, V. Pascucci, IEEE Trans. on Vis. and Comp. Graph. (Proc of IEEE VIS), 15:1177-1184, 2009.

See Graphics/Testing/Cxx/TestReebGraph.cxx for an example of concrete implementation.

Definition at line 56 of file vtkReebGraphSimplificationMetric.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkReebGraphSimplificationMetric.h.

Constructor & Destructor Documentation

◆ vtkReebGraphSimplificationMetric()

vtkReebGraphSimplificationMetric::vtkReebGraphSimplificationMetric ( )
protected

◆ ~vtkReebGraphSimplificationMetric()

vtkReebGraphSimplificationMetric::~vtkReebGraphSimplificationMetric ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkReebGraphSimplificationMetric * vtkReebGraphSimplificationMetric::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkReebGraphSimplificationMetric::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkReebGraphSimplificationMetric * vtkReebGraphSimplificationMetric::NewInstance ( ) const

◆ PrintSelf()

void vtkReebGraphSimplificationMetric::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.

◆ SetLowerBound()

virtual void vtkReebGraphSimplificationMetric::SetLowerBound ( double  )
virtual

Set the lowest possible value for the custom metric space.

This value can be set prior to launching the Reeb graph simplification and then used inside the ComputeMetric call to make sure the returned value of ComputeMetric call is indeed between 0 and 1.

◆ GetLowerBound()

virtual double vtkReebGraphSimplificationMetric::GetLowerBound ( )
virtual

Set the lowest possible value for the custom metric space.

This value can be set prior to launching the Reeb graph simplification and then used inside the ComputeMetric call to make sure the returned value of ComputeMetric call is indeed between 0 and 1.

◆ SetUpperBound()

virtual void vtkReebGraphSimplificationMetric::SetUpperBound ( double  )
virtual

Set the highest possible value for the custom metric space.

This value can be set prior to launching the Reeb graph simplification and then used inside the ComputeMetric call to make sure the returned value of ComputeMetric call is indeed between 0 and 1.

◆ GetUpperBound()

virtual double vtkReebGraphSimplificationMetric::GetUpperBound ( )
virtual

Set the highest possible value for the custom metric space.

This value can be set prior to launching the Reeb graph simplification and then used inside the ComputeMetric call to make sure the returned value of ComputeMetric call is indeed between 0 and 1.

◆ ComputeMetric()

virtual double vtkReebGraphSimplificationMetric::ComputeMetric ( vtkDataSet mesh,
vtkDataArray field,
vtkIdType  startCriticalPoint,
vtkAbstractArray vertexList,
vtkIdType  endCriticalPoint 
)
virtual

Function to implement in your simplification metric algorithm.

Given the input mesh and the Ids of the vertices living on the Reeb graph arc to consider for removal, you should return a value between 0 and 1 (the smallest the more likely the arc will be removed, depending on the user-defined simplification threshold).

Member Data Documentation

◆ LowerBound

double vtkReebGraphSimplificationMetric::LowerBound
protected

Definition at line 99 of file vtkReebGraphSimplificationMetric.h.

◆ UpperBound

double vtkReebGraphSimplificationMetric::UpperBound
protected

Definition at line 99 of file vtkReebGraphSimplificationMetric.h.


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