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

extract / segment points based on geometric connectivity More...

#include <vtkConnectedPointsFilter.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- 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
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkConnectedPointsFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void InitializeSeedList ()
 Initialize list of point ids ids used to seed regions. More...
 
void AddSeed (vtkIdType id)
 Add a non-negative point seed id. More...
 
void DeleteSeed (vtkIdType id)
 Delete a point seed id. More...
 
void InitializeSpecifiedRegionList ()
 Initialize list of region ids to extract. More...
 
void AddSpecifiedRegion (vtkIdType id)
 Add a non-negative region id to extract. More...
 
void DeleteSpecifiedRegion (vtkIdType id)
 Delete a region id to extract. More...
 
int GetNumberOfExtractedRegions ()
 Obtain the number of connected regions. More...
 
virtual void SetRadius (double)
 Set / get the radius variable specifying a local sphere used to define local point neighborhood. More...
 
virtual double GetRadius ()
 Set / get the radius variable specifying a local sphere used to define local point neighborhood. More...
 
virtual void SetExtractionMode (int)
 Control the extraction of connected regions. More...
 
virtual int GetExtractionMode ()
 Control the extraction of connected regions. More...
 
void SetExtractionModeToPointSeededRegions ()
 Control the extraction of connected regions. More...
 
void SetExtractionModeToLargestRegion ()
 Control the extraction of connected regions. More...
 
void SetExtractionModeToSpecifiedRegions ()
 Control the extraction of connected regions. More...
 
void SetExtractionModeToClosestPointRegion ()
 Control the extraction of connected regions. More...
 
void SetExtractionModeToAllRegions ()
 Control the extraction of connected regions. More...
 
const char * GetExtractionModeAsString ()
 Return the method of extraction as a string. More...
 
virtual void SetClosestPoint (double, double, double)
 Use to specify x-y-z point coordinates when extracting the region closest to a specified point. More...
 
virtual void SetClosestPoint (double[3])
 Use to specify x-y-z point coordinates when extracting the region closest to a specified point. More...
 
virtual doubleGetClosestPoint ()
 Use to specify x-y-z point coordinates when extracting the region closest to a specified point. More...
 
virtual void GetClosestPoint (double data[3])
 Use to specify x-y-z point coordinates when extracting the region closest to a specified point. More...
 
virtual void SetAlignedNormals (int)
 Turn on/off connectivity based on point normal consistency. More...
 
virtual int GetAlignedNormals ()
 Turn on/off connectivity based on point normal consistency. More...
 
virtual void AlignedNormalsOn ()
 Turn on/off connectivity based on point normal consistency. More...
 
virtual void AlignedNormalsOff ()
 Turn on/off connectivity based on point normal consistency. More...
 
virtual void SetNormalAngle (double)
 Specify a threshold for normal angles. More...
 
virtual double GetNormalAngle ()
 Specify a threshold for normal angles. More...
 
virtual void SetScalarConnectivity (int)
 Turn on/off connectivity based on scalar value. More...
 
virtual int GetScalarConnectivity ()
 Turn on/off connectivity based on scalar value. More...
 
virtual void ScalarConnectivityOn ()
 Turn on/off connectivity based on scalar value. More...
 
virtual void ScalarConnectivityOff ()
 Turn on/off connectivity based on scalar value. More...
 
virtual void SetScalarRange (double, double)
 Set the scalar range to use to extract points based on scalar connectivity. More...
 
void SetScalarRange (double[2])
 Set the scalar range to use to extract points based on scalar connectivity. More...
 
virtual doubleGetScalarRange ()
 Set the scalar range to use to extract points based on scalar connectivity. More...
 
virtual void GetScalarRange (double &, double &)
 Set the scalar range to use to extract points based on scalar connectivity. More...
 
virtual void GetScalarRange (double[2])
 Set the scalar range to use to extract points based on scalar connectivity. More...
 
void SetLocator (vtkAbstractPointLocator *locator)
 Specify a point locator. More...
 
virtual vtkAbstractPointLocatorGetLocator ()
 Specify a point locator. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual 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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkConnectedPointsFilterSafeDownCast (vtkObjectBase *o)
 
static vtkConnectedPointsFilterNew ()
 Construct with default extraction mode to extract the largest region. More...
 
- 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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkConnectedPointsFilter ()
 
 ~vtkConnectedPointsFilter () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
void TraverseAndMark (vtkPoints *inPts, vtkDataArray *inScalars, float *normals, vtkIdType *labels)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Radius
 
int ExtractionMode
 
vtkIdListSeeds
 
vtkIdListSpecifiedRegionIds
 
double ClosestPoint [3]
 
int AlignedNormals
 
double NormalAngle
 
double NormalThreshold
 
int ScalarConnectivity
 
double ScalarRange [2]
 
vtkAbstractPointLocatorLocator
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

extract / segment points based on geometric connectivity

vtkConnectedPointsFilter is a filter that extracts and/or segments points from a point cloud based on geometric distance measures (e.g., proximity, normal alignments, etc.) and optional measures such as scalar range. The default operation is to segment the points into "connected" regions where the connection is determined by an appropriate distance measure. Each region is given a region id. Optionally, the filter can output the largest connected region of points; a particular region (via id specification); those regions that are seeded using a list of input point ids; or the region of points closest to a specified position.

The key parameter of this filter is the radius defining a sphere around each point which defines a local neighborhood: any other points in the local neighborhood are assumed connected to the point. Note that the radius is defined in absolute terms.

Other parameters are used to further qualify what it means to be a neighboring point. For example, scalar range and/or point normals can be used to further constrain the neighborhood. Also the extraction mode defines how the filter operates. By default, all regions are extracted but it is possible to extract particular regions; the region closest to a seed point; seeded regions; or the largest region found while processing. By default, all regions are extracted.

On output, all points are labeled with a region number. However note that the number of input and output points may not be the same: if not extracting all regions then the output size may be less than the input size.

See also
vtkPolyDataConnectivityFilter vtkConnectivityFilter
Tests:
vtkConnectedPointsFilter (Tests)

Definition at line 74 of file vtkConnectedPointsFilter.h.

Member Typedef Documentation

Definition at line 77 of file vtkConnectedPointsFilter.h.

Constructor & Destructor Documentation

vtkConnectedPointsFilter::vtkConnectedPointsFilter ( )
protected
vtkConnectedPointsFilter::~vtkConnectedPointsFilter ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkConnectedPointsFilter::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkConnectedPointsFilter::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkConnectedPointsFilter* vtkConnectedPointsFilter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkConnectedPointsFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkConnectedPointsFilter* vtkConnectedPointsFilter::NewInstance ( ) const
void vtkConnectedPointsFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

static vtkConnectedPointsFilter* vtkConnectedPointsFilter::New ( )
static

Construct with default extraction mode to extract the largest region.

virtual void vtkConnectedPointsFilter::SetRadius ( double  )
virtual

Set / get the radius variable specifying a local sphere used to define local point neighborhood.

virtual double vtkConnectedPointsFilter::GetRadius ( )
virtual

Set / get the radius variable specifying a local sphere used to define local point neighborhood.

virtual void vtkConnectedPointsFilter::SetExtractionMode ( int  )
virtual

Control the extraction of connected regions.

virtual int vtkConnectedPointsFilter::GetExtractionMode ( )
virtual

Control the extraction of connected regions.

void vtkConnectedPointsFilter::SetExtractionModeToPointSeededRegions ( )
inline

Control the extraction of connected regions.

Definition at line 101 of file vtkConnectedPointsFilter.h.

void vtkConnectedPointsFilter::SetExtractionModeToLargestRegion ( )
inline

Control the extraction of connected regions.

Definition at line 103 of file vtkConnectedPointsFilter.h.

void vtkConnectedPointsFilter::SetExtractionModeToSpecifiedRegions ( )
inline

Control the extraction of connected regions.

Definition at line 105 of file vtkConnectedPointsFilter.h.

void vtkConnectedPointsFilter::SetExtractionModeToClosestPointRegion ( )
inline

Control the extraction of connected regions.

Definition at line 107 of file vtkConnectedPointsFilter.h.

void vtkConnectedPointsFilter::SetExtractionModeToAllRegions ( )
inline

Control the extraction of connected regions.

Definition at line 109 of file vtkConnectedPointsFilter.h.

const char * vtkConnectedPointsFilter::GetExtractionModeAsString ( void  )
inline

Return the method of extraction as a string.

Definition at line 268 of file vtkConnectedPointsFilter.h.

virtual void vtkConnectedPointsFilter::SetClosestPoint ( double  ,
double  ,
double   
)
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkConnectedPointsFilter::SetClosestPoint ( double  [3])
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual double* vtkConnectedPointsFilter::GetClosestPoint ( )
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkConnectedPointsFilter::GetClosestPoint ( double  data[3])
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

void vtkConnectedPointsFilter::InitializeSeedList ( )

Initialize list of point ids ids used to seed regions.

void vtkConnectedPointsFilter::AddSeed ( vtkIdType  id)

Add a non-negative point seed id.

Note: ids are 0-offset.

void vtkConnectedPointsFilter::DeleteSeed ( vtkIdType  id)

Delete a point seed id.

Note: ids are 0-offset.

void vtkConnectedPointsFilter::InitializeSpecifiedRegionList ( )

Initialize list of region ids to extract.

void vtkConnectedPointsFilter::AddSpecifiedRegion ( vtkIdType  id)

Add a non-negative region id to extract.

Note: ids are 0-offset.

void vtkConnectedPointsFilter::DeleteSpecifiedRegion ( vtkIdType  id)

Delete a region id to extract.

Note: ids are 0-offset.

virtual void vtkConnectedPointsFilter::SetAlignedNormals ( int  )
virtual

Turn on/off connectivity based on point normal consistency.

If on, and point normals are defined, points are connected only if they satisfy other criterion (e.g., geometric proximity, scalar connectivity, etc.) AND the angle between normals is no greater than NormalAngle;

virtual int vtkConnectedPointsFilter::GetAlignedNormals ( )
virtual

Turn on/off connectivity based on point normal consistency.

If on, and point normals are defined, points are connected only if they satisfy other criterion (e.g., geometric proximity, scalar connectivity, etc.) AND the angle between normals is no greater than NormalAngle;

virtual void vtkConnectedPointsFilter::AlignedNormalsOn ( )
virtual

Turn on/off connectivity based on point normal consistency.

If on, and point normals are defined, points are connected only if they satisfy other criterion (e.g., geometric proximity, scalar connectivity, etc.) AND the angle between normals is no greater than NormalAngle;

virtual void vtkConnectedPointsFilter::AlignedNormalsOff ( )
virtual

Turn on/off connectivity based on point normal consistency.

If on, and point normals are defined, points are connected only if they satisfy other criterion (e.g., geometric proximity, scalar connectivity, etc.) AND the angle between normals is no greater than NormalAngle;

virtual void vtkConnectedPointsFilter::SetNormalAngle ( double  )
virtual

Specify a threshold for normal angles.

If AlignedNormalsOn is set, then points are connected if the angle between their normals is within this angle threshold (expressed in degress).

virtual double vtkConnectedPointsFilter::GetNormalAngle ( )
virtual

Specify a threshold for normal angles.

If AlignedNormalsOn is set, then points are connected if the angle between their normals is within this angle threshold (expressed in degress).

virtual void vtkConnectedPointsFilter::SetScalarConnectivity ( int  )
virtual

Turn on/off connectivity based on scalar value.

If on, points are connected only if they satisfy the various geometric criterion AND one of the points scalar values falls in the scalar range specified.

virtual int vtkConnectedPointsFilter::GetScalarConnectivity ( )
virtual

Turn on/off connectivity based on scalar value.

If on, points are connected only if they satisfy the various geometric criterion AND one of the points scalar values falls in the scalar range specified.

virtual void vtkConnectedPointsFilter::ScalarConnectivityOn ( )
virtual

Turn on/off connectivity based on scalar value.

If on, points are connected only if they satisfy the various geometric criterion AND one of the points scalar values falls in the scalar range specified.

virtual void vtkConnectedPointsFilter::ScalarConnectivityOff ( )
virtual

Turn on/off connectivity based on scalar value.

If on, points are connected only if they satisfy the various geometric criterion AND one of the points scalar values falls in the scalar range specified.

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

Set the scalar range to use to extract points based on scalar connectivity.

void vtkConnectedPointsFilter::SetScalarRange ( double  [2])

Set the scalar range to use to extract points based on scalar connectivity.

virtual double* vtkConnectedPointsFilter::GetScalarRange ( )
virtual

Set the scalar range to use to extract points based on scalar connectivity.

virtual void vtkConnectedPointsFilter::GetScalarRange ( double ,
double  
)
virtual

Set the scalar range to use to extract points based on scalar connectivity.

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

Set the scalar range to use to extract points based on scalar connectivity.

int vtkConnectedPointsFilter::GetNumberOfExtractedRegions ( )

Obtain the number of connected regions.

The return value is valid only after the filter has executed.

void vtkConnectedPointsFilter::SetLocator ( vtkAbstractPointLocator locator)

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points around a sample point.

virtual vtkAbstractPointLocator* vtkConnectedPointsFilter::GetLocator ( )
virtual

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points around a sample point.

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkConnectedPointsFilter::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.

void vtkConnectedPointsFilter::TraverseAndMark ( vtkPoints inPts,
vtkDataArray inScalars,
float normals,
vtkIdType labels 
)
protected

Member Data Documentation

double vtkConnectedPointsFilter::Radius
protected

Definition at line 219 of file vtkConnectedPointsFilter.h.

int vtkConnectedPointsFilter::ExtractionMode
protected

Definition at line 222 of file vtkConnectedPointsFilter.h.

vtkIdList* vtkConnectedPointsFilter::Seeds
protected

Definition at line 225 of file vtkConnectedPointsFilter.h.

vtkIdList* vtkConnectedPointsFilter::SpecifiedRegionIds
protected

Definition at line 228 of file vtkConnectedPointsFilter.h.

double vtkConnectedPointsFilter::ClosestPoint[3]
protected

Definition at line 231 of file vtkConnectedPointsFilter.h.

int vtkConnectedPointsFilter::AlignedNormals
protected

Definition at line 234 of file vtkConnectedPointsFilter.h.

double vtkConnectedPointsFilter::NormalAngle
protected

Definition at line 235 of file vtkConnectedPointsFilter.h.

double vtkConnectedPointsFilter::NormalThreshold
protected

Definition at line 236 of file vtkConnectedPointsFilter.h.

int vtkConnectedPointsFilter::ScalarConnectivity
protected

Definition at line 239 of file vtkConnectedPointsFilter.h.

double vtkConnectedPointsFilter::ScalarRange[2]
protected

Definition at line 240 of file vtkConnectedPointsFilter.h.

vtkAbstractPointLocator* vtkConnectedPointsFilter::Locator
protected

Definition at line 243 of file vtkConnectedPointsFilter.h.


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