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

Label an image by connectivity. More...

#include <vtkImageConnectivityFilter.h>

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

Public Types

enum  LabelModeEnum { SeedScalar = 0, ConstantValue = 1, SizeRank = 2 }
 Enum constants for SetLabelMode(). More...
 
enum  ExtractionModeEnum { SeededRegions = 0, AllRegions = 1, LargestRegion = 2 }
 Enum constants for SetExtractionMode(). More...
 
typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
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...
 
vtkImageConnectivityFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSeedConnection (vtkAlgorithmOutput *port)
 The input for seed locations (input port 1). More...
 
vtkAlgorithmOutputGetSeedConnection ()
 
void SetSeedData (vtkDataSet *data)
 
void SetStencilConnection (vtkAlgorithmOutput *port)
 The input for a stencil (input port 2). More...
 
vtkAlgorithmOutputGetStencilConnection ()
 
void SetStencilData (vtkImageStencilData *data)
 
void SetLabelScalarTypeToUnsignedChar ()
 Set the scalar type for the output label image. More...
 
void SetLabelScalarTypeToShort ()
 
void SetLabelScalarTypeToUnsignedShort ()
 
void SetLabelScalarTypeToInt ()
 
const char * GetLabelScalarTypeAsString ()
 
virtual void SetLabelScalarType (int)
 
virtual int GetLabelScalarType ()
 
void SetLabelModeToSeedScalar ()
 Set the mode for applying labels to the output. More...
 
void SetLabelModeToConstantValue ()
 
void SetLabelModeToSizeRank ()
 
const char * GetLabelModeAsString ()
 
virtual void SetLabelMode (int)
 
virtual int GetLabelMode ()
 
void SetExtractionModeToSeededRegions ()
 Set which regions to output from this filter. More...
 
void SetExtractionModeToAllRegions ()
 
void SetExtractionModeToLargestRegion ()
 
const char * GetExtractionModeAsString ()
 
virtual void SetExtractionMode (int)
 
virtual int GetExtractionMode ()
 
virtual void SetLabelConstantValue (int)
 The label used when LabelMode is ConstantValue. More...
 
virtual int GetLabelConstantValue ()
 
vtkIdType GetNumberOfExtractedRegions ()
 Get the number of extracted regions. More...
 
vtkIdTypeArrayGetExtractedRegionLabels ()
 Get the label used for each extracted region. More...
 
vtkIdTypeArrayGetExtractedRegionSizes ()
 
vtkIdTypeArrayGetExtractedRegionSeedIds ()
 Get the PointId of the seed for each region. More...
 
vtkIntArrayGetExtractedRegionExtents ()
 Get the extent (a 6-tuples) for each output region. More...
 
virtual void SetGenerateRegionExtents (vtkTypeBool)
 Turn this on to request creation of the ExtractedRegionExtents array. More...
 
virtual void GenerateRegionExtentsOn ()
 
virtual void GenerateRegionExtentsOff ()
 
virtual vtkTypeBool GetGenerateRegionExtents ()
 
virtual void SetSizeRange (vtkIdType, vtkIdType)
 Set the size range for the extracted regions. More...
 
void SetSizeRange (vtkIdType[2])
 
virtual vtkIdTypeGetSizeRange ()
 
virtual void GetSizeRange (vtkIdType &, vtkIdType &)
 
virtual void GetSizeRange (vtkIdType[2])
 
virtual void SetScalarRange (double, double)
 Set the scalar range used to define potential regions. More...
 
void SetScalarRange (double[2])
 
virtual doubleGetScalarRange ()
 
virtual void GetScalarRange (double &, double &)
 
virtual void GetScalarRange (double[2])
 
virtual void SetActiveComponent (int)
 For multi-component input images, select which component to use. More...
 
virtual int GetActiveComponent ()
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- 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...
 
vtkTypeBool 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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool 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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageConnectivityFilterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageConnectivityFilterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageConnectivityFilter ()
 
 ~vtkImageConnectivityFilter () override
 
void ComputeInputUpdateExtent (int inExt[6], int outExt[6])
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called in response to a REQUEST_DATA request from the executive. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. 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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int LabelMode
 
int ExtractionMode
 
double ScalarRange [2]
 
vtkIdType SizeRange [2]
 
int LabelConstantValue
 
int ActiveComponent
 
int LabelScalarType
 
vtkTypeBool GenerateRegionExtents
 
vtkIdTypeArrayExtractedRegionLabels
 
vtkIdTypeArrayExtractedRegionSizes
 
vtkIdTypeArrayExtractedRegionSeedIds
 
vtkIntArrayExtractedRegionExtents
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- 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

Label an image by connectivity.

vtkImageConnectivityFilter will identify connected regions within an image and label them. Only points with scalar values within a prescribed range are considered for inclusion, by default this range includes all scalar values with a value greater than zero. Points within the prescribed scalar range are considered to be connected if a path exists between the points that does not traverse any points that are not within the prescribed scalar range. Adjacency of points is governed by 4-connectivity for 2D images, and 6-connectivity for 3D images.

The output of this filter is a label image. By default, each region is assigned a different label, where the labels are integer values starting at a value of 1. The SetLabelMode() method can be used to change the way that labels are assigned. Labels can be assigned by providing input seed points for each region to be labelled, or they can be assigned by ranking the regions by size.

If a set of seeds is provided with the SetSeedData() method, then the default behavior is to only output the regions that are connected to the seeds, and if the seeds have scalars, then these scalars will be used to label the regions. Seeds with a scalar value equal to zero are ignored. See the documentation for the SetExtractionMode() method for details on how to control which regions will labeled.

Regions can be selected by size with the SetSizeRange() method, which can be useful for identifying objects of a certain size, e.g. for rejecting small regions that are likely to be noise. It is also possible to label only the largest region and ignore all others, with SetExtractionModeToLargestRegion().

In addition to the labels, the following additional information is provided: the number of regions identified, the size of each region, a list of all label values used, and the seed for each region (if seeds were used). Optionally, this filter can also compute the extent of each region if GenerateRegionExtentsOn() is called. These extents can be useful for cropping the output of the filter.

See also
vtkConnectivityFilter, vtkPolyDataConnectivityFilter
Tests:
vtkImageConnectivityFilter (Tests)

Definition at line 108 of file vtkImageConnectivityFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 113 of file vtkImageConnectivityFilter.h.

Member Enumeration Documentation

◆ LabelModeEnum

Enum constants for SetLabelMode().

Enumerator
SeedScalar 
ConstantValue 
SizeRank 

Definition at line 119 of file vtkImageConnectivityFilter.h.

◆ ExtractionModeEnum

Enum constants for SetExtractionMode().

Enumerator
SeededRegions 
AllRegions 
LargestRegion 

Definition at line 128 of file vtkImageConnectivityFilter.h.

Constructor & Destructor Documentation

◆ vtkImageConnectivityFilter()

vtkImageConnectivityFilter::vtkImageConnectivityFilter ( )
protected

◆ ~vtkImageConnectivityFilter()

vtkImageConnectivityFilter::~vtkImageConnectivityFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageConnectivityFilter* vtkImageConnectivityFilter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageConnectivityFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

◆ NewInstance()

vtkImageConnectivityFilter* vtkImageConnectivityFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkImageConnectivityFilter::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 vtkImageAlgorithm.

◆ SetSeedConnection()

void vtkImageConnectivityFilter::SetSeedConnection ( vtkAlgorithmOutput port)

The input for seed locations (input port 1).

Each point in the supplied data set will be used as a seed, unless the data set has scalars, in which case only the points with scalar values that are not equal to zero will be used as seeds.

◆ GetSeedConnection()

vtkAlgorithmOutput* vtkImageConnectivityFilter::GetSeedConnection ( )

◆ SetSeedData()

void vtkImageConnectivityFilter::SetSeedData ( vtkDataSet data)

◆ SetStencilConnection()

void vtkImageConnectivityFilter::SetStencilConnection ( vtkAlgorithmOutput port)

The input for a stencil (input port 2).

The output labels will be restricted to the region inside the stencil, as if no input voxels existed outside the stencil. This allows you to apply this filter within an arbitrary region of interest.

◆ GetStencilConnection()

vtkAlgorithmOutput* vtkImageConnectivityFilter::GetStencilConnection ( )

◆ SetStencilData()

void vtkImageConnectivityFilter::SetStencilData ( vtkImageStencilData data)

◆ SetLabelScalarTypeToUnsignedChar()

void vtkImageConnectivityFilter::SetLabelScalarTypeToUnsignedChar ( )
inline

Set the scalar type for the output label image.

This should be one of UnsignedChar, Short, UnsignedShort, or Int depending on how many labels are expected. The default is UnsignedChar, which allows for 255 label values. If the total number of regions is greater than the maximum label value N, then only the largest N regions will be kept and the rest will be discarded.

Definition at line 167 of file vtkImageConnectivityFilter.h.

◆ SetLabelScalarTypeToShort()

void vtkImageConnectivityFilter::SetLabelScalarTypeToShort ( )
inline

Definition at line 169 of file vtkImageConnectivityFilter.h.

◆ SetLabelScalarTypeToUnsignedShort()

void vtkImageConnectivityFilter::SetLabelScalarTypeToUnsignedShort ( )
inline

Definition at line 171 of file vtkImageConnectivityFilter.h.

◆ SetLabelScalarTypeToInt()

void vtkImageConnectivityFilter::SetLabelScalarTypeToInt ( )
inline

Definition at line 173 of file vtkImageConnectivityFilter.h.

◆ GetLabelScalarTypeAsString()

const char* vtkImageConnectivityFilter::GetLabelScalarTypeAsString ( )

◆ SetLabelScalarType()

virtual void vtkImageConnectivityFilter::SetLabelScalarType ( int  )
virtual

◆ GetLabelScalarType()

virtual int vtkImageConnectivityFilter::GetLabelScalarType ( )
virtual

◆ SetLabelModeToSeedScalar()

void vtkImageConnectivityFilter::SetLabelModeToSeedScalar ( )
inline

Set the mode for applying labels to the output.

Labeling by SeedScalar uses the scalars from the seeds as labels, if present, or the regions will be labeled consecutively starting at 1, if the seeds have no scalars. Labeling by SizeRank means that the largest region is labeled 1 and other regions are labeled consecutively in order of decreasing size (if there is a tie, then the seed point ID is used as a tiebreaker). Finally, Constant means that all regions will have the value of SetLabelConstantValue(). The default is to label using the seed scalars, if present, or to label consecutively, if no seed scalars are present.

Definition at line 193 of file vtkImageConnectivityFilter.h.

◆ SetLabelModeToConstantValue()

void vtkImageConnectivityFilter::SetLabelModeToConstantValue ( )
inline

Definition at line 194 of file vtkImageConnectivityFilter.h.

◆ SetLabelModeToSizeRank()

void vtkImageConnectivityFilter::SetLabelModeToSizeRank ( )
inline

Definition at line 195 of file vtkImageConnectivityFilter.h.

◆ GetLabelModeAsString()

const char* vtkImageConnectivityFilter::GetLabelModeAsString ( )

◆ SetLabelMode()

virtual void vtkImageConnectivityFilter::SetLabelMode ( int  )
virtual

◆ GetLabelMode()

virtual int vtkImageConnectivityFilter::GetLabelMode ( )
virtual

◆ SetExtractionModeToSeededRegions()

void vtkImageConnectivityFilter::SetExtractionModeToSeededRegions ( )
inline

Set which regions to output from this filter.

This can be all the regions, just the seeded regions, or the largest region (which will be the largest seeded region, if there are seeds). The default is to output all the seeded regions, if there are seeds, or to output all the regions, if there are no seeds.

Definition at line 209 of file vtkImageConnectivityFilter.h.

◆ SetExtractionModeToAllRegions()

void vtkImageConnectivityFilter::SetExtractionModeToAllRegions ( )
inline

Definition at line 211 of file vtkImageConnectivityFilter.h.

◆ SetExtractionModeToLargestRegion()

void vtkImageConnectivityFilter::SetExtractionModeToLargestRegion ( )
inline

Definition at line 213 of file vtkImageConnectivityFilter.h.

◆ GetExtractionModeAsString()

const char* vtkImageConnectivityFilter::GetExtractionModeAsString ( )

◆ SetExtractionMode()

virtual void vtkImageConnectivityFilter::SetExtractionMode ( int  )
virtual

◆ GetExtractionMode()

virtual int vtkImageConnectivityFilter::GetExtractionMode ( )
virtual

◆ SetLabelConstantValue()

virtual void vtkImageConnectivityFilter::SetLabelConstantValue ( int  )
virtual

The label used when LabelMode is ConstantValue.

The default value is 255.

◆ GetLabelConstantValue()

virtual int vtkImageConnectivityFilter::GetLabelConstantValue ( )
virtual

◆ GetNumberOfExtractedRegions()

vtkIdType vtkImageConnectivityFilter::GetNumberOfExtractedRegions ( )

Get the number of extracted regions.

◆ GetExtractedRegionLabels()

vtkIdTypeArray* vtkImageConnectivityFilter::GetExtractedRegionLabels ( )
inline

Get the label used for each extracted region.

Definition at line 237 of file vtkImageConnectivityFilter.h.

◆ GetExtractedRegionSizes()

vtkIdTypeArray* vtkImageConnectivityFilter::GetExtractedRegionSizes ( )
inline

Definition at line 242 of file vtkImageConnectivityFilter.h.

◆ GetExtractedRegionSeedIds()

vtkIdTypeArray* vtkImageConnectivityFilter::GetExtractedRegionSeedIds ( )
inline

Get the PointId of the seed for each region.

If no seed was used, the PointId will be -1.

Definition at line 249 of file vtkImageConnectivityFilter.h.

◆ GetExtractedRegionExtents()

vtkIntArray* vtkImageConnectivityFilter::GetExtractedRegionExtents ( )
inline

Get the extent (a 6-tuples) for each output region.

This is only valid if GenerateRegionExtentsOn() was called before the filter was executed.

Definition at line 257 of file vtkImageConnectivityFilter.h.

◆ SetGenerateRegionExtents()

virtual void vtkImageConnectivityFilter::SetGenerateRegionExtents ( vtkTypeBool  )
virtual

Turn this on to request creation of the ExtractedRegionExtents array.

◆ GenerateRegionExtentsOn()

virtual void vtkImageConnectivityFilter::GenerateRegionExtentsOn ( )
virtual

◆ GenerateRegionExtentsOff()

virtual void vtkImageConnectivityFilter::GenerateRegionExtentsOff ( )
virtual

◆ GetGenerateRegionExtents()

virtual vtkTypeBool vtkImageConnectivityFilter::GetGenerateRegionExtents ( )
virtual

◆ SetSizeRange() [1/2]

virtual void vtkImageConnectivityFilter::SetSizeRange ( vtkIdType  ,
vtkIdType   
)
virtual

Set the size range for the extracted regions.

Only regions that have sizes within the specified range will be present in the output. The default range is (1, VTK_ID_MAX).

◆ SetSizeRange() [2/2]

void vtkImageConnectivityFilter::SetSizeRange ( vtkIdType  [2])

◆ GetSizeRange() [1/3]

virtual vtkIdType* vtkImageConnectivityFilter::GetSizeRange ( )
virtual

◆ GetSizeRange() [2/3]

virtual void vtkImageConnectivityFilter::GetSizeRange ( vtkIdType ,
vtkIdType  
)
virtual

◆ GetSizeRange() [3/3]

virtual void vtkImageConnectivityFilter::GetSizeRange ( vtkIdType  [2])
virtual

◆ SetScalarRange() [1/2]

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

Set the scalar range used to define potential regions.

Only voxels with values that are within this range will be considered for region membership. This is an inclusive range, meaning that the upper and lower limits are considered to be within the range. The default range goes from 0.5 to VTK_DOUBLE_MAX.

◆ SetScalarRange() [2/2]

void vtkImageConnectivityFilter::SetScalarRange ( double  [2])

◆ GetScalarRange() [1/3]

virtual double* vtkImageConnectivityFilter::GetScalarRange ( )
virtual

◆ GetScalarRange() [2/3]

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

◆ GetScalarRange() [3/3]

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

◆ SetActiveComponent()

virtual void vtkImageConnectivityFilter::SetActiveComponent ( int  )
virtual

For multi-component input images, select which component to use.

◆ GetActiveComponent()

virtual int vtkImageConnectivityFilter::GetActiveComponent ( )
virtual

◆ ComputeInputUpdateExtent()

void vtkImageConnectivityFilter::ComputeInputUpdateExtent ( int  inExt[6],
int  outExt[6] 
)
protected

◆ FillInputPortInformation()

int vtkImageConnectivityFilter::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 vtkImageAlgorithm.

◆ RequestInformation()

int vtkImageConnectivityFilter::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

◆ RequestUpdateExtent()

int vtkImageConnectivityFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.

Reimplemented from vtkImageAlgorithm.

◆ RequestData()

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

This is called in response to a REQUEST_DATA request from the executive.

Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

◆ LabelMode

int vtkImageConnectivityFilter::LabelMode
protected

Definition at line 303 of file vtkImageConnectivityFilter.h.

◆ ExtractionMode

int vtkImageConnectivityFilter::ExtractionMode
protected

Definition at line 304 of file vtkImageConnectivityFilter.h.

◆ ScalarRange

double vtkImageConnectivityFilter::ScalarRange[2]
protected

Definition at line 306 of file vtkImageConnectivityFilter.h.

◆ SizeRange

vtkIdType vtkImageConnectivityFilter::SizeRange[2]
protected

Definition at line 307 of file vtkImageConnectivityFilter.h.

◆ LabelConstantValue

int vtkImageConnectivityFilter::LabelConstantValue
protected

Definition at line 308 of file vtkImageConnectivityFilter.h.

◆ ActiveComponent

int vtkImageConnectivityFilter::ActiveComponent
protected

Definition at line 309 of file vtkImageConnectivityFilter.h.

◆ LabelScalarType

int vtkImageConnectivityFilter::LabelScalarType
protected

Definition at line 310 of file vtkImageConnectivityFilter.h.

◆ GenerateRegionExtents

vtkTypeBool vtkImageConnectivityFilter::GenerateRegionExtents
protected

Definition at line 311 of file vtkImageConnectivityFilter.h.

◆ ExtractedRegionLabels

vtkIdTypeArray* vtkImageConnectivityFilter::ExtractedRegionLabels
protected

Definition at line 313 of file vtkImageConnectivityFilter.h.

◆ ExtractedRegionSizes

vtkIdTypeArray* vtkImageConnectivityFilter::ExtractedRegionSizes
protected

Definition at line 314 of file vtkImageConnectivityFilter.h.

◆ ExtractedRegionSeedIds

vtkIdTypeArray* vtkImageConnectivityFilter::ExtractedRegionSeedIds
protected

Definition at line 315 of file vtkImageConnectivityFilter.h.

◆ ExtractedRegionExtents

vtkIntArray* vtkImageConnectivityFilter::ExtractedRegionExtents
protected

Definition at line 316 of file vtkImageConnectivityFilter.h.


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