VTK  9.4.20241209
Protected Member Functions | Protected Attributes | List of all members
vtkContourLoopExtraction Class Reference

extract closed loops (polygons) from lines and polylines More...

#include <vtkContourLoopExtraction.h>

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

Public Member Functions

virtual void SetLoopClosure (int)
 Specify whether to close loops or not.
 
virtual int GetLoopClosure ()
 Specify whether to close loops or not.
 
void SetLoopClosureToOff ()
 Specify whether to close loops or not.
 
void SetLoopClosureToBoundary ()
 Specify whether to close loops or not.
 
void SetLoopClosureToAll ()
 Specify whether to close loops or not.
 
const char * GetLoopClosureAsString ()
 Specify whether to close loops or not.
 
virtual void SetScalarThresholding (bool)
 Turn on/off the extraction of loops based on scalar thresholding.
 
virtual bool GetScalarThresholding ()
 Turn on/off the extraction of loops based on scalar thresholding.
 
virtual void ScalarThresholdingOn ()
 Turn on/off the extraction of loops based on scalar thresholding.
 
virtual void ScalarThresholdingOff ()
 Turn on/off the extraction of loops based on scalar thresholding.
 
virtual void SetScalarRange (double, double)
 Set the scalar range to use to extract loop based on scalar thresholding.
 
void SetScalarRange (double[2])
 Set the scalar range to use to extract loop based on scalar thresholding.
 
virtual double * GetScalarRange ()
 Set the scalar range to use to extract loop based on scalar thresholding.
 
virtual void GetScalarRange (double &, double &)
 Set the scalar range to use to extract loop based on scalar thresholding.
 
virtual void GetScalarRange (double[2])
 Set the scalar range to use to extract loop based on scalar thresholding.
 
virtual void SetNormal (double, double, double)
 Set the normal vector used to orient the algorithm (controlling turns around the loop).
 
virtual void SetNormal (double[3])
 Set the normal vector used to orient the algorithm (controlling turns around the loop).
 
virtual double * GetNormal ()
 Set the normal vector used to orient the algorithm (controlling turns around the loop).
 
virtual void GetNormal (double &, double &, double &)
 Set the normal vector used to orient the algorithm (controlling turns around the loop).
 
virtual void GetNormal (double[3])
 Set the normal vector used to orient the algorithm (controlling turns around the loop).
 
virtual void SetOutputMode (int)
 Specify the form of the output.
 
virtual int GetOutputMode ()
 Specify the form of the output.
 
void SetOutputModeToPolygons ()
 Specify the form of the output.
 
void SetOutputModeToPolylines ()
 Specify the form of the output.
 
void SetOutputModeToBoth ()
 Specify the form of the output.
 
const char * GetOutputModeAsString ()
 Specify the form of the output.
 
virtual void SetCleanPoints (bool)
 Indicate whether to clean the output points.
 
virtual bool GetCleanPoints ()
 Indicate whether to clean the output points.
 
virtual void CleanPointsOn ()
 Indicate whether to clean the output points.
 
virtual void CleanPointsOff ()
 Indicate whether to clean the output points.
 
- 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.
 
vtkPolyDataAlgorithmNewInstance () 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
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetOutput (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.
 
vtkAlgorithmNewInstance () 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.
 
vtkExecutiveGetExecutive ()
 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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (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.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
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.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (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 vtkInformationGetInformation ()
 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.
 
vtkAlgorithmGetContainerAlgorithm ()
 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.
 
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 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 vtkProgressObserverGetProgressObserver ()
 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.
 
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.
 
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

 vtkContourLoopExtraction ()
 
 ~vtkContourLoopExtraction () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBaseNewInstanceInternal () 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 vtkObjectBaseNewInstanceInternal () 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.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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

int LoopClosure
 
bool ScalarThresholding
 
double ScalarRange [2]
 
double Normal [3]
 
int OutputMode
 
bool CleanPoints
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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 to instantiate, print and provide type information.
 
static vtkContourLoopExtractionNew ()
 Standard methods to instantiate, print and provide type information.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods to instantiate, print and provide type information.
 
static vtkContourLoopExtractionSafeDownCast (vtkObjectBase *o)
 Standard methods to instantiate, print and provide type information.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods to instantiate, print and provide type information.
 
vtkContourLoopExtractionNewInstance () const
 Standard methods to instantiate, print and provide type information.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods to instantiate, print and provide type information.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods to instantiate, print and provide 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 vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
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 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 (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 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.
 
- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_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 vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

extract closed loops (polygons) from lines and polylines

This filter takes an input consisting of lines and polylines and constructs polygons (i.e., closed loops) from them. It combines some of the capability of connectivity filters and the line stripper to produce manifold loops that are suitable for geometric operations. For example, the vtkCookieCutter works well with this filter.

Note that the input structure for this filter consists of points and line or polyline cells. All other topological types (verts, polygons, triangle strips) are ignored. The output of this filter is by default manifold polygons. Note however, that optionally polyline loops may also be output if requested.

Warning
Although the loops are constructed in 3-space, a normal vector must be supplied to help choose a turn direction when multiple choices are possible. By default the normal vector is n={0,0,1} but may be user specified. Note also that some filters require that the loops are located in the z=constant or z=0 plane. Hence a transform filter of some sort may be necesssary to project the loops to a plane.
Note that lines that do not close in on themselves can be optionally forced closed. This occurs when for example, 2D contours end and begin at the boundaries of data. By forcing closure, the last point is joined to the first point (with boundary points possibly added). Note that there are different closure modes: 1) do not close (and hence reject the polygon); 2) close along the dataset boundaries (i.e., the bounding box of a dataset used to generate the contour lines); and 3) close all open loops by connectiong the first and last point. If Option #2 is chosen, only loops that start and end on either a horizontal or vertical boundary are closed.
Scalar thresholding can be enabled. If enabled, then only those loops with *any" scalar point data within the thresholded range are extracted. @warning Any detached lines forming degenerate loops of defined by two points or less are discarded. Non-manifold junctions are broken into separate, independent loops. @warning Boundary closure only works if the end points are both on a vertical boundary or horizontal boundary. Otherwise new points would have to be added which this filter does not (currently) do. @sa vtkCookieCutter vtkFlyingEdges2D vtkMarchingSquares vtkFeatureEdges vtkConnectivityFilter vtkPolyDataConnectivityFilter vtkDiscreteFlyingEdges2D vtkStripper vtkImprintFilter vtkCleanPolyData vtkStaticCleanPolyData @par Tests: @ref c2_vtk_t_vtkContourLoopExtraction "vtkContourLoopExtraction (Tests)"

Definition at line 77 of file vtkContourLoopExtraction.h.

Member Typedef Documentation

◆ Superclass

Standard methods to instantiate, print and provide type information.

Definition at line 85 of file vtkContourLoopExtraction.h.

Constructor & Destructor Documentation

◆ vtkContourLoopExtraction()

vtkContourLoopExtraction::vtkContourLoopExtraction ( )
protected

◆ ~vtkContourLoopExtraction()

vtkContourLoopExtraction::~vtkContourLoopExtraction ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkContourLoopExtraction * vtkContourLoopExtraction::New ( )
static

Standard methods to instantiate, print and provide type information.

◆ IsTypeOf()

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

Standard methods to instantiate, print and provide type information.

◆ IsA()

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

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

Standard methods to instantiate, print and provide type information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkContourLoopExtraction::NewInstanceInternal ( ) const
protectedvirtual

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkContourLoopExtraction * vtkContourLoopExtraction::NewInstance ( ) const

Standard methods to instantiate, print and provide type information.

◆ PrintSelf()

void vtkContourLoopExtraction::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkAlgorithm.

◆ SetLoopClosure()

virtual void vtkContourLoopExtraction::SetLoopClosure ( int  )
virtual

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

◆ GetLoopClosure()

virtual int vtkContourLoopExtraction::GetLoopClosure ( )
virtual

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

◆ SetLoopClosureToOff()

void vtkContourLoopExtraction::SetLoopClosureToOff ( )
inline

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

Definition at line 98 of file vtkContourLoopExtraction.h.

◆ SetLoopClosureToBoundary()

void vtkContourLoopExtraction::SetLoopClosureToBoundary ( )
inline

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

Definition at line 99 of file vtkContourLoopExtraction.h.

◆ SetLoopClosureToAll()

void vtkContourLoopExtraction::SetLoopClosureToAll ( )
inline

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

Definition at line 100 of file vtkContourLoopExtraction.h.

◆ GetLoopClosureAsString()

const char * vtkContourLoopExtraction::GetLoopClosureAsString ( )

Specify whether to close loops or not.

All non-closed loops can be rejected; boundary loops (end points lie on vertical or horizontal porions of the boundary) can be closed (default); or all loops can be forced closed by connecting first and last points.

◆ SetScalarThresholding()

virtual void vtkContourLoopExtraction::SetScalarThresholding ( bool  )
virtual

Turn on/off the extraction of loops based on scalar thresholding.

Loops with scalar values in a specified range can be extracted. If no scalars are available from the input than this data member is ignored.

◆ GetScalarThresholding()

virtual bool vtkContourLoopExtraction::GetScalarThresholding ( )
virtual

Turn on/off the extraction of loops based on scalar thresholding.

Loops with scalar values in a specified range can be extracted. If no scalars are available from the input than this data member is ignored.

◆ ScalarThresholdingOn()

virtual void vtkContourLoopExtraction::ScalarThresholdingOn ( )
virtual

Turn on/off the extraction of loops based on scalar thresholding.

Loops with scalar values in a specified range can be extracted. If no scalars are available from the input than this data member is ignored.

◆ ScalarThresholdingOff()

virtual void vtkContourLoopExtraction::ScalarThresholdingOff ( )
virtual

Turn on/off the extraction of loops based on scalar thresholding.

Loops with scalar values in a specified range can be extracted. If no scalars are available from the input than this data member is ignored.

◆ SetScalarRange() [1/2]

virtual void vtkContourLoopExtraction::SetScalarRange ( double  ,
double   
)
virtual

Set the scalar range to use to extract loop based on scalar thresholding.

If any scalar, point data, in the loop falls into the scalar range given, then the loop is extracted.

◆ SetScalarRange() [2/2]

void vtkContourLoopExtraction::SetScalarRange ( double  [2])

Set the scalar range to use to extract loop based on scalar thresholding.

If any scalar, point data, in the loop falls into the scalar range given, then the loop is extracted.

◆ GetScalarRange() [1/3]

virtual double * vtkContourLoopExtraction::GetScalarRange ( )
virtual

Set the scalar range to use to extract loop based on scalar thresholding.

If any scalar, point data, in the loop falls into the scalar range given, then the loop is extracted.

◆ GetScalarRange() [2/3]

virtual void vtkContourLoopExtraction::GetScalarRange ( double &  ,
double &   
)
virtual

Set the scalar range to use to extract loop based on scalar thresholding.

If any scalar, point data, in the loop falls into the scalar range given, then the loop is extracted.

◆ GetScalarRange() [3/3]

virtual void vtkContourLoopExtraction::GetScalarRange ( double  [2])
virtual

Set the scalar range to use to extract loop based on scalar thresholding.

If any scalar, point data, in the loop falls into the scalar range given, then the loop is extracted.

◆ SetNormal() [1/2]

virtual void vtkContourLoopExtraction::SetNormal ( double  ,
double  ,
double   
)
virtual

Set the normal vector used to orient the algorithm (controlling turns around the loop).

By default the normal points in the +z direction.

◆ SetNormal() [2/2]

virtual void vtkContourLoopExtraction::SetNormal ( double  [3])
virtual

Set the normal vector used to orient the algorithm (controlling turns around the loop).

By default the normal points in the +z direction.

◆ GetNormal() [1/3]

virtual double * vtkContourLoopExtraction::GetNormal ( )
virtual

Set the normal vector used to orient the algorithm (controlling turns around the loop).

By default the normal points in the +z direction.

◆ GetNormal() [2/3]

virtual void vtkContourLoopExtraction::GetNormal ( double &  ,
double &  ,
double &   
)
virtual

Set the normal vector used to orient the algorithm (controlling turns around the loop).

By default the normal points in the +z direction.

◆ GetNormal() [3/3]

virtual void vtkContourLoopExtraction::GetNormal ( double  [3])
virtual

Set the normal vector used to orient the algorithm (controlling turns around the loop).

By default the normal points in the +z direction.

◆ SetOutputMode()

virtual void vtkContourLoopExtraction::SetOutputMode ( int  )
virtual

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

◆ GetOutputMode()

virtual int vtkContourLoopExtraction::GetOutputMode ( )
virtual

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

◆ SetOutputModeToPolygons()

void vtkContourLoopExtraction::SetOutputModeToPolygons ( )
inline

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

Definition at line 142 of file vtkContourLoopExtraction.h.

◆ SetOutputModeToPolylines()

void vtkContourLoopExtraction::SetOutputModeToPolylines ( )
inline

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

Definition at line 143 of file vtkContourLoopExtraction.h.

◆ SetOutputModeToBoth()

void vtkContourLoopExtraction::SetOutputModeToBoth ( )
inline

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

Definition at line 144 of file vtkContourLoopExtraction.h.

◆ GetOutputModeAsString()

const char * vtkContourLoopExtraction::GetOutputModeAsString ( )

Specify the form of the output.

Polygons can be output (default); polylines can be output (the first and last point is repeated); or both can be output.

◆ SetCleanPoints()

virtual void vtkContourLoopExtraction::SetCleanPoints ( bool  )
virtual

Indicate whether to clean the output points.

Cleaning means discarding any points that are unused by the output polylines or polygons. This results in a potential renumbering of the points. By default, cleaning points is on. (This feature is useful because some filters output points in addition to those used to represent output lines and polylines, and this method is faster than using vtkCleanPolyData/vtkStaticCleanPolyData).

◆ GetCleanPoints()

virtual bool vtkContourLoopExtraction::GetCleanPoints ( )
virtual

Indicate whether to clean the output points.

Cleaning means discarding any points that are unused by the output polylines or polygons. This results in a potential renumbering of the points. By default, cleaning points is on. (This feature is useful because some filters output points in addition to those used to represent output lines and polylines, and this method is faster than using vtkCleanPolyData/vtkStaticCleanPolyData).

◆ CleanPointsOn()

virtual void vtkContourLoopExtraction::CleanPointsOn ( )
virtual

Indicate whether to clean the output points.

Cleaning means discarding any points that are unused by the output polylines or polygons. This results in a potential renumbering of the points. By default, cleaning points is on. (This feature is useful because some filters output points in addition to those used to represent output lines and polylines, and this method is faster than using vtkCleanPolyData/vtkStaticCleanPolyData).

◆ CleanPointsOff()

virtual void vtkContourLoopExtraction::CleanPointsOff ( )
virtual

Indicate whether to clean the output points.

Cleaning means discarding any points that are unused by the output polylines or polygons. This results in a potential renumbering of the points. By default, cleaning points is on. (This feature is useful because some filters output points in addition to those used to represent output lines and polylines, and this method is faster than using vtkCleanPolyData/vtkStaticCleanPolyData).

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

◆ LoopClosure

int vtkContourLoopExtraction::LoopClosure
protected

Definition at line 167 of file vtkContourLoopExtraction.h.

◆ ScalarThresholding

bool vtkContourLoopExtraction::ScalarThresholding
protected

Definition at line 168 of file vtkContourLoopExtraction.h.

◆ ScalarRange

double vtkContourLoopExtraction::ScalarRange[2]
protected

Definition at line 169 of file vtkContourLoopExtraction.h.

◆ Normal

double vtkContourLoopExtraction::Normal[3]
protected

Definition at line 170 of file vtkContourLoopExtraction.h.

◆ OutputMode

int vtkContourLoopExtraction::OutputMode
protected

Definition at line 171 of file vtkContourLoopExtraction.h.

◆ CleanPoints

bool vtkContourLoopExtraction::CleanPoints
protected

Definition at line 172 of file vtkContourLoopExtraction.h.


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