VTK  9.0.20201129
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDijkstraImageContourLineInterpolator Class Reference

Contour interpolator for placing points on an image. More...

#include <vtkDijkstraImageContourLineInterpolator.h>

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

Public Types

typedef vtkContourLineInterpolator Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkContourLineInterpolator
typedef vtkObject Superclass
 Standard methods for instances of this class. More...
 

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...
 
vtkDijkstraImageContourLineInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int InterpolateLine (vtkRenderer *ren, vtkContourRepresentation *rep, int idx1, int idx2) override
 Subclasses that wish to interpolate a line segment must implement this. More...
 
virtual void SetCostImage (vtkImageData *)
 Set the image data for the vtkDijkstraImageGeodesicPath. More...
 
virtual vtkImageDataGetCostImage ()
 
virtual vtkDijkstraImageGeodesicPathGetDijkstraImageGeodesicPath ()
 access to the internal dijkstra path More...
 
- Public Member Functions inherited from vtkContourLineInterpolator
vtkContourLineInterpolatorNewInstance () const
 
virtual int UpdateNode (vtkRenderer *, vtkContourRepresentation *, double *vtkNotUsed(node), int vtkNotUsed(idx))
 The interpolator is given a chance to update the node. More...
 
virtual void GetSpan (int nodeIndex, vtkIntArray *nodeIndices, vtkContourRepresentation *rep)
 Span of the interpolator. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDijkstraImageContourLineInterpolatorSafeDownCast (vtkObjectBase *o)
 
static vtkDijkstraImageContourLineInterpolatorNew ()
 
- Static Public Member Functions inherited from vtkContourLineInterpolator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContourLineInterpolatorSafeDownCast (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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDijkstraImageContourLineInterpolator ()
 
 ~vtkDijkstraImageContourLineInterpolator () override
 
- Protected Member Functions inherited from vtkContourLineInterpolator
 vtkContourLineInterpolator ()
 
 ~vtkContourLineInterpolator () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkImageDataCostImage
 
vtkDijkstraImageGeodesicPathDijkstraImageGeodesicPath
 
- 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

Contour interpolator for placing points on an image.

vtkDijkstraImageContourLineInterpolator interpolates and places contour points on images. The class interpolates nodes by computing a graph laying on the image data. By graph, we mean that the line interpolating the two end points traverses along pixels so as to form a shortest path. A Dijkstra algorithm is used to compute the path.

The class is meant to be used in conjunction with vtkImageActorPointPlacer. One reason for this coupling is a performance issue: both classes need to perform a cell pick, and coupling avoids multiple cell picks (cell picks are slow). Another issue is that the interpolator may need to set the image input to its vtkDijkstraImageGeodesicPath ivar.

See also
vtkContourWidget vtkContourLineInterpolator vtkDijkstraImageGeodesicPath

Definition at line 47 of file vtkDijkstraImageContourLineInterpolator.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 55 of file vtkDijkstraImageContourLineInterpolator.h.

Constructor & Destructor Documentation

◆ vtkDijkstraImageContourLineInterpolator()

vtkDijkstraImageContourLineInterpolator::vtkDijkstraImageContourLineInterpolator ( )
protected

◆ ~vtkDijkstraImageContourLineInterpolator()

vtkDijkstraImageContourLineInterpolator::~vtkDijkstraImageContourLineInterpolator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDijkstraImageContourLineInterpolator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContourLineInterpolator.

◆ NewInstance()

vtkDijkstraImageContourLineInterpolator* vtkDijkstraImageContourLineInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkDijkstraImageContourLineInterpolator::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 vtkContourLineInterpolator.

◆ New()

static vtkDijkstraImageContourLineInterpolator* vtkDijkstraImageContourLineInterpolator::New ( )
static

◆ InterpolateLine()

int vtkDijkstraImageContourLineInterpolator::InterpolateLine ( vtkRenderer ren,
vtkContourRepresentation rep,
int  idx1,
int  idx2 
)
overridevirtual

Subclasses that wish to interpolate a line segment must implement this.

For instance vtkBezierContourLineInterpolator adds nodes between idx1 and idx2, that allow the contour to adhere to a bezier curve.

Implements vtkContourLineInterpolator.

◆ SetCostImage()

virtual void vtkDijkstraImageContourLineInterpolator::SetCostImage ( vtkImageData )
virtual

Set the image data for the vtkDijkstraImageGeodesicPath.

If not set, the interpolator uses the image data input to the image actor. The image actor is obtained from the expected vtkImageActorPointPlacer.

◆ GetCostImage()

virtual vtkImageData* vtkDijkstraImageContourLineInterpolator::GetCostImage ( )
virtual

◆ GetDijkstraImageGeodesicPath()

virtual vtkDijkstraImageGeodesicPath* vtkDijkstraImageContourLineInterpolator::GetDijkstraImageGeodesicPath ( )
virtual

access to the internal dijkstra path

Member Data Documentation

◆ CostImage

vtkImageData* vtkDijkstraImageContourLineInterpolator::CostImage
protected

Definition at line 89 of file vtkDijkstraImageContourLineInterpolator.h.

◆ DijkstraImageGeodesicPath

vtkDijkstraImageGeodesicPath* vtkDijkstraImageContourLineInterpolator::DijkstraImageGeodesicPath
protected

Definition at line 90 of file vtkDijkstraImageContourLineInterpolator.h.


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