generate smoothed constours from segmented 2D image data (i.e., "label maps") More...

#include <vtkSurfaceNets2D.h>

Inheritance diagram for vtkSurfaceNets2D:

Collaboration diagram for vtkSurfaceNets2D:

Public Member Functions
vtkMTimeType	GetMTime () override
	The modified time is also a function of the label values and the smoothing filter.


void	SetValue (int i, double value)
	Set a particular label value at label number i.

void	SetLabel (int i, double value)
	Set a particular label value at label number i.


double	GetValue (int i)
	Get the ith label value.

double	GetLabel (int i)
	Get the ith label value.


double *	GetValues ()
	Get a pointer to an array of labels.

double *	GetLabels ()
	Get a pointer to an array of labels.


void	GetValues (double *contourValues)
	Fill a supplied list with label values.

void	GetLabels (double *contourValues)
	Fill a supplied list with label values.


void	SetNumberOfLabels (int number)
	Set the number of labels to place into the list.

void	SetNumberOfContours (int number)
	Set the number of labels to place into the list.


vtkIdType	GetNumberOfLabels ()
	Get the number of labels in the list of label values.

vtkIdType	GetNumberOfContours ()
	Get the number of labels in the list of label values.


void	GenerateLabels (int numLabels, double range[2])
	Generate numLabels equally spaced labels between the specified range.

void	GenerateValues (int numContours, double range[2])
	Generate numLabels equally spaced labels between the specified range.

void	GenerateLabels (int numLabels, double rangeStart, double rangeEnd)
	Generate numLabels equally spaced labels between the specified range.

void	GenerateValues (int numContours, double rangeStart, double rangeEnd)
	Generate numLabels equally spaced labels between the specified range.


virtual void	SetComputeScalars (bool)
	Enable/disable an option to generate cell scalars in the output.

virtual bool	GetComputeScalars ()
	Enable/disable an option to generate cell scalars in the output.

virtual void	ComputeScalarsOn ()
	Enable/disable an option to generate cell scalars in the output.

virtual void	ComputeScalarsOff ()
	Enable/disable an option to generate cell scalars in the output.


virtual void	SetBackgroundLabel (double)
	If computing cell scalars, specify the label to use when referencing a labeled region outside any of the specified regions (i.e., when referencing the background region).

virtual double	GetBackgroundLabel ()
	If computing cell scalars, specify the label to use when referencing a labeled region outside any of the specified regions (i.e., when referencing the background region).


virtual void	SetArrayComponent (int)
	Set/get which component of a input multi-component scalar array to contour with; defaults to component 0.

virtual int	GetArrayComponent ()
	Set/get which component of a input multi-component scalar array to contour with; defaults to component 0.


virtual void	SetSmoothing (bool)
	Indicate whether smoothing should be enabled.

virtual bool	GetSmoothing ()
	Indicate whether smoothing should be enabled.

virtual void	SmoothingOn ()
	Indicate whether smoothing should be enabled.

virtual void	SmoothingOff ()
	Indicate whether smoothing should be enabled.


	vtkGetSmartPointerMacro (Smoother, vtkConstrainedSmoothingFilter)
	Get the instance of vtkConstrainedSmoothingFilter used to smooth the extracted surface net.


virtual void	SetDataCaching (bool)
	Enable caching of intermediate data.

virtual bool	GetDataCaching ()
	Enable caching of intermediate data.

virtual void	DataCachingOn ()
	Enable caching of intermediate data.

virtual void	DataCachingOff ()
	Enable caching of intermediate data.

Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkPolyDataAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

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.

vtkCommand *	GetCommand (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.

Protected Member Functions
	vtkSurfaceNets2D ()

	~vtkSurfaceNets2D () override=default

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

bool	IsCacheEmpty ()

void	CacheData (vtkPolyData pd, vtkCellArray ca)

Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called by the superclass.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

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
vtkSmartPointer< vtkContourValues >	Labels

bool	ComputeScalars

double	BackgroundLabel

int	ArrayComponent

bool	Smoothing

vtkSmartPointer< vtkConstrainedSmoothingFilter >	Smoother

bool	DataCaching

vtkSmartPointer< vtkPolyData >	GeometryCache

vtkSmartPointer< vtkCellArray >	StencilsCache

vtkTimeStamp	SmoothingTime

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

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 vtkPolyDataAlgorithm	Superclass
	Standard methods for instantiation, printing, and type information.

static vtkSurfaceNets2D *	New ()
	Standard methods for instantiation, printing, and type information.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, printing, and type information.

static vtkSurfaceNets2D *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, printing, and type information.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, printing, and type information.

vtkSurfaceNets2D *	NewInstance () const
	Standard methods for instantiation, printing, and type information.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, printing, and type information.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, printing, and type information.

Additional Inherited Members
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

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.

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

Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

generate smoothed constours from segmented 2D image data (i.e., "label maps")

vtkSurfaceNets2D creates boundary/isocontour lines from a label map (e.g., a segmented image) using a threaded, 2D version of the multiple regions/labels surface nets algorithm. The input is a 2D image where each pixel is labeled (integer labels are preferred to real values), and the output data is polygonal data separating labeled regions via line segments. (Note that on output each region [corresponding to a different segmented object] will share points/edges on a common boundary, i.e., two objects next to each other will share the boundary that separates them.)

While this filter is similar to a contouring operation, classic contouring methods assume a continuous scalar field. In comparison, label maps are not continuous in scalar function value, meaning that usual data interpolation (e.g., along edges) is not possible. Instead, when the edge endpoint pixels are labeled in differing regions, the edge is split and transected by a line segment that connects the center points of the squares on either side of the edge. Later, using a energy minimization smoothing process, these split edges will be adjusted to produce a smoother result. (Constraints on smoothing displacements may be specified to prevent excessive shrinkage and/or object distortion.)

The smoothing process is controlled by setting a convergence measure, the number of smoothing iterations, the step size, and the allowed (constraint) distance that points may move. These can be adjusted to provide the desired result. This class provides a method to access an internal instance of vtkConstrainedSmoothingFilter, through which these smoothing parameters may be specified, and which actually performs the smoothing operation. (Note: it is possible to skip the smoothing process altogether by disabling smoothing (e.g., invoking SmoothingOff()) or setting the number of smoothing iterations to zero. This can be useful when using a different smoothing filter like vtkWindowedSincPolyDataFilter; or if an unsmoothed, aliased output is desired. The reason the smoothing is built in to this filter is to remain faithful to the published literature describing the surface nets algorithm.)

See the following reference for more details about the implementation: W. Schroeder, S. Tsalikis, M. Halle, S. Frisken. A High-Performance SurfaceNets Discrete Isocontouring Algorithm. arXiv:2401.14906. 2024. (http://arxiv.org/abs/2401.14906).

The SurfaceNets algorithm was first proposed by Sarah Frisken. Two important papers include the description of surface nets for binary objects (i.e., extracting just one segmented object from a volume) and multi-label (multiple object extraction).

S. Frisken (Gibson), “Constrained Elastic SurfaceNets: Generating Smooth Surfaces from Binary Segmented Data”, Proc. MICCAI, 1998, pp. 888-898.

S. Frisken, “SurfaceNets for Multi-Label Segmentations with Preservation of Sharp Boundaries”, J. Computer Graphics Techniques, 2022.

Note that one nice feature of this filter is that algorithm execution occurs only once no matter the number of object labels / contour values. In many contouring-like algorithms, each separate contour value requires an additional algorithm execution with a new contour value. So in this filter large numbers of contour values do not significantly affect overall speed. The user can specify which objects (i.e., labels) are to be output to the filter. (Unspecified labels are treated as background and not output.)

The filter can optionally output a two-component, cell data array indicating the labels/regions on either side of the line segments composing the output vtkPolyData. This can be used for advanced operations like extracting shared/contacting boundaries between two objects. The name of this cell data array is "BoundaryLabels".

Implementation note: For performance reasons, this filter is internally implemented quite differently than described in the literature. The main difference is that concepts from the Flying Edges parallel isocontouring algorithm are used. Namely, parallel, edge-by-edge processing is used to define cell cases, generate smoothing stencils, and produce points and output lines. The smoothing process is also threaded using a double-buffering approach.

Warning: This filter is specialized to 2D images.; Subtle differences in the output may result when the number of objects / labels changes. This is because the smoothing operation operates on all of the boundaries simultaneously. If the boundaries change due to a difference in the number of regions / labels, then the smoothing operation can produce different results.; The filters vtkDiscreteMarchingCubes, vtkDiscreteFlyingEdges2D, vtkDiscreteFlyingEdges3D, and vtkDiscreteFlyingEdgesClipper2D also perform isocontour extraction. However these filters produce output that may not share common boundary cells, and may produce "gaps" between segmented regions. For example, vtkDiscreteMarchingCubes will share points between adjacent regions, but not triangle cells (which will be coincident). Also, no center point is inserted into voxels, meaning that intermittent gaps may form between regions.; This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.; See also vtkPackLabels which is a utility class for renumbering the labels found in the input segmentation mask to contiguous forms of smaller type.

See also: vtkSurfaceNets3D vtkDiscreteFlyingEdges2D vtkDiscreteFlyingEdgesClipper2D vtkConstrainedSmoothingFilter vtkFlyingEdges2D vtkFlyingEdges3D vtkWindowedSincPolyDataFilter vtkPackLabels

Tests:: vtkSurfaceNets2D (Tests)

Definition at line 132 of file vtkSurfaceNets2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkSurfaceNets2D::Superclass

Standard methods for instantiation, printing, and type information.

Definition at line 140 of file vtkSurfaceNets2D.h.

Constructor & Destructor Documentation

◆ vtkSurfaceNets2D()

vtkSurfaceNets2D::vtkSurfaceNets2D ( )

protected

◆ ~vtkSurfaceNets2D()

vtkSurfaceNets2D::~vtkSurfaceNets2D ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSurfaceNets2D * vtkSurfaceNets2D::New ( )

static

Standard methods for instantiation, printing, and type information.

◆ IsTypeOf()

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

static

Standard methods for instantiation, printing, and type information.

◆ IsA()

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

virtual

Standard methods for instantiation, printing, and type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

static

Standard methods for instantiation, printing, and type information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSurfaceNets2D::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, printing, and type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkSurfaceNets2D * vtkSurfaceNets2D::NewInstance ( ) const

Standard methods for instantiation, printing, and type information.

◆ PrintSelf()

void vtkSurfaceNets2D::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for instantiation, printing, and type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ GetMTime()

vtkMTimeType vtkSurfaceNets2D::GetMTime ( )

overridevirtual

The modified time is also a function of the label values and the smoothing filter.

Reimplemented from vtkObject.

◆ SetValue()

void vtkSurfaceNets2D::SetValue	(	int	i,
		double	value
	)

inline

Set a particular label value at label number i.

The index i ranges between 0 <= i <NumberOfLabels. (Note: while labels values are expressed as doubles, the underlying scalar data may be a different type. During execution the label values are cast to the type of the scalar data.) Note the use of "Value" and "Label" when specifying regions to extract. The use of "Value" is continuous with other VTK continuous-scalar field isocontouring algorithms; however the term "Label" is more consistent with label maps.

Definition at line 161 of file vtkSurfaceNets2D.h.

◆ SetLabel()

void vtkSurfaceNets2D::SetLabel	(	int	i,
		double	value
	)

inline

Set a particular label value at label number i.

The index i ranges between 0 <= i <NumberOfLabels. (Note: while labels values are expressed as doubles, the underlying scalar data may be a different type. During execution the label values are cast to the type of the scalar data.) Note the use of "Value" and "Label" when specifying regions to extract. The use of "Value" is continuous with other VTK continuous-scalar field isocontouring algorithms; however the term "Label" is more consistent with label maps.

Definition at line 162 of file vtkSurfaceNets2D.h.

◆ GetValue()

double vtkSurfaceNets2D::GetValue ( int i )

inline

Get the ith label value.

Definition at line 169 of file vtkSurfaceNets2D.h.

◆ GetLabel()

double vtkSurfaceNets2D::GetLabel ( int i )

inline

Get the ith label value.

Definition at line 170 of file vtkSurfaceNets2D.h.

◆ GetValues() [1/2]

double * vtkSurfaceNets2D::GetValues ( )

inline

Get a pointer to an array of labels.

There will be GetNumberOfLabels() values in the list.

Definition at line 178 of file vtkSurfaceNets2D.h.

◆ GetLabels() [1/2]

double * vtkSurfaceNets2D::GetLabels ( )

inline

Get a pointer to an array of labels.

There will be GetNumberOfLabels() values in the list.

Definition at line 179 of file vtkSurfaceNets2D.h.

◆ GetValues() [2/2]

void vtkSurfaceNets2D::GetValues ( double * contourValues )

inline

Fill a supplied list with label values.

There will be GetNumberOfLabels() values in the list. Make sure you allocate enough memory to hold the list.

Definition at line 188 of file vtkSurfaceNets2D.h.

◆ GetLabels() [2/2]

void vtkSurfaceNets2D::GetLabels ( double * contourValues )

inline

Fill a supplied list with label values.

There will be GetNumberOfLabels() values in the list. Make sure you allocate enough memory to hold the list.

Definition at line 189 of file vtkSurfaceNets2D.h.

◆ SetNumberOfLabels()

void vtkSurfaceNets2D::SetNumberOfLabels ( int number )

inline

Set the number of labels to place into the list.

You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed. Note that for consistency with other isocountoring-related algorithms, some methods use "Labels" and "Contours" interchangeably.

Definition at line 200 of file vtkSurfaceNets2D.h.

◆ SetNumberOfContours()

void vtkSurfaceNets2D::SetNumberOfContours ( int number )

inline

Set the number of labels to place into the list.

You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed. Note that for consistency with other isocountoring-related algorithms, some methods use "Labels" and "Contours" interchangeably.

Definition at line 201 of file vtkSurfaceNets2D.h.

◆ GetNumberOfLabels()

vtkIdType vtkSurfaceNets2D::GetNumberOfLabels ( )

inline

Get the number of labels in the list of label values.

Definition at line 208 of file vtkSurfaceNets2D.h.

◆ GetNumberOfContours()

vtkIdType vtkSurfaceNets2D::GetNumberOfContours ( )

inline

Get the number of labels in the list of label values.

Definition at line 209 of file vtkSurfaceNets2D.h.

◆ GenerateLabels() [1/2]

void vtkSurfaceNets2D::GenerateLabels	(	int	numLabels,
		double	range[2]
	)

inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 217 of file vtkSurfaceNets2D.h.

◆ GenerateValues() [1/2]

void vtkSurfaceNets2D::GenerateValues	(	int	numContours,
		double	range[2]
	)

inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 221 of file vtkSurfaceNets2D.h.

◆ GenerateLabels() [2/2]

void vtkSurfaceNets2D::GenerateLabels	(	int	numLabels,
		double	rangeStart,
		double	rangeEnd
	)

inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 225 of file vtkSurfaceNets2D.h.

◆ GenerateValues() [2/2]

void vtkSurfaceNets2D::GenerateValues	(	int	numContours,
		double	rangeStart,
		double	rangeEnd
	)

inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 229 of file vtkSurfaceNets2D.h.

◆ SetComputeScalars()

virtual void vtkSurfaceNets2D::SetComputeScalars ( bool )

virtual

Enable/disable an option to generate cell scalars in the output.

The cell scalars are a two-tuple that indicates which labels (i.e., segmented regions) are on either side of each (line) cell (l0,l1) with l0<l1. If an object is one-sided (meaning the background is on one side of the line) then l1=(OutsideLabel). The name of the output cell scalars is "BoundaryLabels". By default this flag is on.

◆ GetComputeScalars()

virtual bool vtkSurfaceNets2D::GetComputeScalars ( )

virtual

Enable/disable an option to generate cell scalars in the output.

The cell scalars are a two-tuple that indicates which labels (i.e., segmented regions) are on either side of each (line) cell (l0,l1) with l0<l1. If an object is one-sided (meaning the background is on one side of the line) then l1=(OutsideLabel). The name of the output cell scalars is "BoundaryLabels". By default this flag is on.

◆ ComputeScalarsOn()

virtual void vtkSurfaceNets2D::ComputeScalarsOn ( )

virtual

Enable/disable an option to generate cell scalars in the output.

The cell scalars are a two-tuple that indicates which labels (i.e., segmented regions) are on either side of each (line) cell (l0,l1) with l0<l1. If an object is one-sided (meaning the background is on one side of the line) then l1=(OutsideLabel). The name of the output cell scalars is "BoundaryLabels". By default this flag is on.

◆ ComputeScalarsOff()

virtual void vtkSurfaceNets2D::ComputeScalarsOff ( )

virtual

Enable/disable an option to generate cell scalars in the output.

The cell scalars are a two-tuple that indicates which labels (i.e., segmented regions) are on either side of each (line) cell (l0,l1) with l0<l1. If an object is one-sided (meaning the background is on one side of the line) then l1=(OutsideLabel). The name of the output cell scalars is "BoundaryLabels". By default this flag is on.

◆ SetBackgroundLabel()

virtual void vtkSurfaceNets2D::SetBackgroundLabel ( double )

virtual

If computing cell scalars, specify the label to use when referencing a labeled region outside any of the specified regions (i.e., when referencing the background region).

By default this value is zero. Be very careful of the value being used here, it should not overlap an extracted label value, and because it is the same type as the input image scalars, make sure the value can be properly represented (i.e., if the input scalars are an unsigned type, then BackgroundLabel should not be negative).

◆ GetBackgroundLabel()

virtual double vtkSurfaceNets2D::GetBackgroundLabel ( )

virtual

If computing cell scalars, specify the label to use when referencing a labeled region outside any of the specified regions (i.e., when referencing the background region).

By default this value is zero. Be very careful of the value being used here, it should not overlap an extracted label value, and because it is the same type as the input image scalars, make sure the value can be properly represented (i.e., if the input scalars are an unsigned type, then BackgroundLabel should not be negative).

◆ SetArrayComponent()

virtual void vtkSurfaceNets2D::SetArrayComponent ( int )

virtual

Set/get which component of a input multi-component scalar array to contour with; defaults to component 0.

◆ GetArrayComponent()

virtual int vtkSurfaceNets2D::GetArrayComponent ( )

virtual

Set/get which component of a input multi-component scalar array to contour with; defaults to component 0.

◆ SetSmoothing()

virtual void vtkSurfaceNets2D::SetSmoothing ( bool )

virtual

Indicate whether smoothing should be enabled.

By default, after the isoline is extracted, smoothing occurs using the built-in smoother. To disable smoothing, invoke SmoothingOff().

◆ GetSmoothing()

virtual bool vtkSurfaceNets2D::GetSmoothing ( )

virtual

Indicate whether smoothing should be enabled.

By default, after the isoline is extracted, smoothing occurs using the built-in smoother. To disable smoothing, invoke SmoothingOff().

◆ SmoothingOn()

virtual void vtkSurfaceNets2D::SmoothingOn ( )

virtual

Indicate whether smoothing should be enabled.

By default, after the isoline is extracted, smoothing occurs using the built-in smoother. To disable smoothing, invoke SmoothingOff().

◆ SmoothingOff()

virtual void vtkSurfaceNets2D::SmoothingOff ( )

virtual

Indicate whether smoothing should be enabled.

By default, after the isoline is extracted, smoothing occurs using the built-in smoother. To disable smoothing, invoke SmoothingOff().

◆ vtkGetSmartPointerMacro()

vtkSurfaceNets2D::vtkGetSmartPointerMacro	(	Smoother	,
		vtkConstrainedSmoothingFilter
	)

Get the instance of vtkConstrainedSmoothingFilter used to smooth the extracted surface net.

To control smoothing, access this instance and specify its parameters such as number of smoothing iterations and constraint distance. If you wish to disable smoothing, set SmoothingOff().

◆ SetDataCaching()

virtual void vtkSurfaceNets2D::SetDataCaching ( bool )

virtual

Enable caching of intermediate data.

A common workflow using this filter requires extracting object boundaries, and then repeatedly rerunning the smoothing process with different parameters. To improve performance by avoiding repeated extraction of the boundary, the filter can cache intermediate data prior to the smoothing process. In this way, the boundary is only extracted once, and as long as only the internal constrained smoothing filter is modified, then boundary extraction will not be reexecuted. By default this is enabled.

◆ GetDataCaching()

virtual bool vtkSurfaceNets2D::GetDataCaching ( )

virtual

Enable caching of intermediate data.

A common workflow using this filter requires extracting object boundaries, and then repeatedly rerunning the smoothing process with different parameters. To improve performance by avoiding repeated extraction of the boundary, the filter can cache intermediate data prior to the smoothing process. In this way, the boundary is only extracted once, and as long as only the internal constrained smoothing filter is modified, then boundary extraction will not be reexecuted. By default this is enabled.

◆ DataCachingOn()

virtual void vtkSurfaceNets2D::DataCachingOn ( )

virtual

Enable caching of intermediate data.

A common workflow using this filter requires extracting object boundaries, and then repeatedly rerunning the smoothing process with different parameters. To improve performance by avoiding repeated extraction of the boundary, the filter can cache intermediate data prior to the smoothing process. In this way, the boundary is only extracted once, and as long as only the internal constrained smoothing filter is modified, then boundary extraction will not be reexecuted. By default this is enabled.

◆ DataCachingOff()

virtual void vtkSurfaceNets2D::DataCachingOff ( )

virtual

Enable caching of intermediate data.

A common workflow using this filter requires extracting object boundaries, and then repeatedly rerunning the smoothing process with different parameters. To improve performance by avoiding repeated extraction of the boundary, the filter can cache intermediate data prior to the smoothing process. In this way, the boundary is only extracted once, and as long as only the internal constrained smoothing filter is modified, then boundary extraction will not be reexecuted. By default this is enabled.

◆ RequestData()

int vtkSurfaceNets2D::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkSurfaceNets2D::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

◆ IsCacheEmpty()

bool vtkSurfaceNets2D::IsCacheEmpty ( )

protected

◆ CacheData()

void vtkSurfaceNets2D::CacheData	(	vtkPolyData *	pd,
		vtkCellArray *	ca
	)

protected

Member Data Documentation

◆ Labels

vtkSmartPointer<vtkContourValues> vtkSurfaceNets2D::Labels

protected

Definition at line 318 of file vtkSurfaceNets2D.h.

◆ ComputeScalars

bool vtkSurfaceNets2D::ComputeScalars

protected

Definition at line 319 of file vtkSurfaceNets2D.h.

◆ BackgroundLabel

double vtkSurfaceNets2D::BackgroundLabel

protected

Definition at line 320 of file vtkSurfaceNets2D.h.

◆ ArrayComponent

int vtkSurfaceNets2D::ArrayComponent

protected

Definition at line 321 of file vtkSurfaceNets2D.h.

◆ Smoothing

bool vtkSurfaceNets2D::Smoothing

protected

Definition at line 323 of file vtkSurfaceNets2D.h.

◆ Smoother

vtkSmartPointer<vtkConstrainedSmoothingFilter> vtkSurfaceNets2D::Smoother

protected

Definition at line 324 of file vtkSurfaceNets2D.h.

◆ DataCaching

bool vtkSurfaceNets2D::DataCaching

protected

Definition at line 329 of file vtkSurfaceNets2D.h.

◆ GeometryCache

vtkSmartPointer<vtkPolyData> vtkSurfaceNets2D::GeometryCache

protected

Definition at line 330 of file vtkSurfaceNets2D.h.

◆ StencilsCache

vtkSmartPointer<vtkCellArray> vtkSurfaceNets2D::StencilsCache

protected

Definition at line 331 of file vtkSurfaceNets2D.h.

◆ SmoothingTime

vtkTimeStamp vtkSurfaceNets2D::SmoothingTime

protected

Definition at line 332 of file vtkSurfaceNets2D.h.

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

Filters/Core/vtkSurfaceNets2D.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSurfaceNets2D()

◆ ~vtkSurfaceNets2D()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ SetValue()

◆ SetLabel()

◆ GetValue()

◆ GetLabel()

◆ GetValues() [1/2]

◆ GetLabels() [1/2]

◆ GetValues() [2/2]

◆ GetLabels() [2/2]

◆ SetNumberOfLabels()

◆ SetNumberOfContours()

◆ GetNumberOfLabels()

◆ GetNumberOfContours()

◆ GenerateLabels() [1/2]

◆ GenerateValues() [1/2]

◆ GenerateLabels() [2/2]

◆ GenerateValues() [2/2]

◆ SetComputeScalars()

◆ GetComputeScalars()

◆ ComputeScalarsOn()

◆ ComputeScalarsOff()

◆ SetBackgroundLabel()

◆ GetBackgroundLabel()

◆ SetArrayComponent()

◆ GetArrayComponent()

◆ SetSmoothing()

◆ GetSmoothing()

◆ SmoothingOn()

◆ SmoothingOff()

◆ vtkGetSmartPointerMacro()

◆ SetDataCaching()

◆ GetDataCaching()

◆ DataCachingOn()

◆ DataCachingOff()

◆ RequestData()

◆ FillInputPortInformation()

◆ IsCacheEmpty()

◆ CacheData()

Member Data Documentation

◆ Labels

◆ ComputeScalars

◆ BackgroundLabel

◆ ArrayComponent

◆ Smoothing

◆ Smoother

◆ DataCaching

◆ GeometryCache

◆ StencilsCache

◆ SmoothingTime