renumber segmentation labels into contiguous runs of (potentially) smaller type More...

#include <vtkPackLabels.h>

Inheritance diagram for vtkPackLabels:

Collaboration diagram for vtkPackLabels:

Public Types
enum	SortBy { SORT_BY_LABEL_VALUE = 0 , SORT_BY_LABEL_COUNT }
	Flags to control how sorting of the labels is performed. More...

Public Types inherited from vtkDataSetAlgorithm
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
vtkIdTypeArray *	GetLabelsCount ()
	Return the frequency of occurrence (i.e., the count) of each label returned in the LabelsArray.


vtkDataArray *	GetLabels ()
	Return the number of and list of labels found in the input label map.

vtkIdType	GetNumberOfLabels ()
	Return the number of and list of labels found in the input label map.


virtual void	SetSortBy (int)
	Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

virtual int	GetSortBy ()
	Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

void	SortByLabelValue ()
	Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

void	SortByLabelCount ()
	Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).


virtual void	SetBackgroundValue (unsigned long)
	Specify a background label value.

virtual unsigned long	GetBackgroundValue ()
	Specify a background label value.


virtual void	SetPassPointData (bool)
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual bool	GetPassPointData ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassPointDataOn ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassPointDataOff ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	SetPassCellData (bool)
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual bool	GetPassCellData ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassCellDataOn ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassCellDataOff ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	SetPassFieldData (bool)
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual bool	GetPassFieldData ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassFieldDataOn ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

virtual void	PassFieldDataOff ()
	Indicate whether to pass point data, cell data, and/or field data through to the output.

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

vtkDataSetAlgorithm *	NewInstance () const

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

vtkDataObject *	GetInput ()
	Get the input data object.

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints.

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints.

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid.

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

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

vtkDataSet *	GetOutput (int)
	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	SetInputData (vtkDataSet *)
	Assign a data object as input.

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

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

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

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

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

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

vtkAlgorithm *	NewInstance () const

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

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

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

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

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

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

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

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

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

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

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

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

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

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

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

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

void	RemoveAllInputs ()
	Remove all the input data.

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

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

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

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

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

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

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

Protected Member Functions
	vtkPackLabels ()

	~vtkPackLabels () override=default

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks the algorithm to do its work.

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

	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () override=default

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks for Information.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks the algorithm to do its work.

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.

vtkDataObject *	GetInput (int port)

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

	vtkAlgorithm ()

	~vtkAlgorithm () override

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

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

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

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

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

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

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

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

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

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

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

void	AddInputDataInternal (int port, vtkDataObject *input)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkDataArray >	LabelsArray

vtkSmartPointer< vtkIdTypeArray >	LabelsCount

int	SortBy

int	OutputScalarType

unsigned long	BackgroundValue

bool	PassPointData

bool	PassCellData

bool	PassFieldData

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

enum	DefaultScalarType { VTK_DEFAULT_TYPE = -1 }
	Specify the data type of the output image. More...

virtual void	SetOutputScalarType (int)
	Specify the data type of the output image.

virtual int	GetOutputScalarType ()
	Specify the data type of the output image.

void	SetOutputScalarTypeToDefault ()
	Specify the data type of the output image.

void	SetOutputScalarTypeToUnsignedChar ()
	Specify the data type of the output image.

void	SetOutputScalarTypeToUnsignedShort ()
	Specify the data type of the output image.

void	SetOutputScalarTypeToUnsignedInt ()
	Specify the data type of the output image.

void	SetOutputScalarTypeToUnsignedLong ()
	Specify the data type of the output image.

typedef vtkDataSetAlgorithm	Superclass
	Standard methods for instantiation, obtaining type information, and printing an object.

static vtkPackLabels *	New ()
	Standard methods for instantiation, obtaining type information, and printing an object.

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

static vtkPackLabels *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, obtaining type information, and printing an object.

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

vtkPackLabels *	NewInstance () const
	Standard methods for instantiation, obtaining type information, and printing an object.

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

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

Additional Inherited Members
Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

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

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

static vtkInformationIntegerKey *	ABORTED ()

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

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

renumber segmentation labels into contiguous runs of (potentially) smaller type

vtkPackLabels is a filter that renumbers a set of segmentation labels into a contiguous sequence of label values. The input segmentation labels are represented by a scalar array of arbitrary type, and the labels may be non-contiguous (i.e., there may be "gaps" in the labels used to annotate structured in the segmentation). After execution, the output of this filter consists of (by default) an output of the same dataset type as the input; however the labels are renumbered so that they are contiguous (starting with value==0, [0,NumberOfLabels)). After filter execution, an array of labels present in the input can be retrieved (named "PackedLabels"), listed in ascending order, this is useful in various filters such as discrete isocontouring filters which require iso/label-values (e.g., vtkSurfaceNets3D).

Note that this filter mostly works on input dataset types of vtkImageData (segmentation maps are commonly used in medical computing). However, because this filter operates on scalar point or cell data independent of dataset type, it has been generalized to work on any dataset type.

The filter also converts the input data from one type to another. By default, the output labels are of an unsigned integral type large enough to represent the N packed label values. It is also possible to explicitly specify the type of the output annotation/label image. This conversion capability often reduces the size of the output image, and can be used is useful when an algorithm performs better, or requires, a certain type of input data. Note however, that manual specification can be dangerous: trying to pack a large number of labels into a manually specified reduced precision label values may result in setting some label values to the BackgroundValue.

Finally, in advanced usage, it is possible to control how sorting of the output labels is performed. By default, the labels are assorted based on their associated input label values (SortByLabelValue). However, it is possible to arrange the labels based on their frequency of use (SortByLabelCount). Sorting is useful for gathering data statistics, or to extract and display the segmented objects that are the "largest" in the dataset.

See also: vtkSurfaceNets3D vtkSurfaceNets2D vtkDiscreteFlyingEdges3D vtkDiscreteMarchingCubes

Tests:: vtkPackLabels (Tests)

Definition at line 64 of file vtkPackLabels.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSetAlgorithm vtkPackLabels::Superclass

Standard methods for instantiation, obtaining type information, and printing an object.

Definition at line 73 of file vtkPackLabels.h.

Member Enumeration Documentation

◆ SortBy

enum vtkPackLabels::SortBy

Flags to control how sorting of the labels is performed.

Enumerator
SORT_BY_LABEL_VALUE
SORT_BY_LABEL_COUNT

Definition at line 110 of file vtkPackLabels.h.

◆ DefaultScalarType

enum vtkPackLabels::DefaultScalarType

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Enumerator
VTK_DEFAULT_TYPE

Definition at line 143 of file vtkPackLabels.h.

Constructor & Destructor Documentation

◆ vtkPackLabels()

vtkPackLabels::vtkPackLabels ( )

protected

◆ ~vtkPackLabels()

vtkPackLabels::~vtkPackLabels ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPackLabels * vtkPackLabels::New ( )

static

Standard methods for instantiation, obtaining type information, and printing an object.

◆ IsTypeOf()

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

static

Standard methods for instantiation, obtaining type information, and printing an object.

◆ IsA()

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

virtual

Standard methods for instantiation, obtaining type information, and printing an object.

Reimplemented from vtkDataSetAlgorithm.

◆ SafeDownCast()

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

static

Standard methods for instantiation, obtaining type information, and printing an object.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPackLabels::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, obtaining type information, and printing an object.

Reimplemented from vtkDataSetAlgorithm.

◆ NewInstance()

vtkPackLabels * vtkPackLabels::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing an object.

◆ PrintSelf()

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

overridevirtual

Standard methods for instantiation, obtaining type information, and printing an object.

Reimplemented from vtkDataSetAlgorithm.

◆ GetLabels()

vtkDataArray * vtkPackLabels::GetLabels ( )

inline

Return the number of and list of labels found in the input label map.

The methods return a vtkDataArray with the same data type as the input scalar type. By default, the labels are sorted in ascending order based on the input data (label) values (i.e., SortByLabelValue). However, if SortByLabelCount is specified, then the labels are sorted in descending order based on their frequency of occurrence (i.e., their counts).

Definition at line 86 of file vtkPackLabels.h.

◆ GetNumberOfLabels()

vtkIdType vtkPackLabels::GetNumberOfLabels ( )

inline

Return the number of and list of labels found in the input label map.

The methods return a vtkDataArray with the same data type as the input scalar type. By default, the labels are sorted in ascending order based on the input data (label) values (i.e., SortByLabelValue). However, if SortByLabelCount is specified, then the labels are sorted in descending order based on their frequency of occurrence (i.e., their counts).

Definition at line 87 of file vtkPackLabels.h.

◆ GetLabelsCount()

vtkIdTypeArray * vtkPackLabels::GetLabelsCount ( )

inline

Return the frequency of occurrence (i.e., the count) of each label returned in the LabelsArray.

The methods returns a vtkIdTypeArray that is implicitly ordered consistent with the LabelsArray (i.e., LabelsCount[i] gives the frequency count for LabelsArray[i]). Note that if SortByLabelCount is set, then the labels array and labels count are sorted in descending order based on the frequency of occurrence of labels. If SortByLabelValue is set, then the labels array and label counts are sorted in ascending order based on input label values. Also note that the size of the LabelsCount array is identical to the size of the LabelsCount array.

Definition at line 105 of file vtkPackLabels.h.

◆ SetSortBy()

virtual void vtkPackLabels::SetSortBy ( int )

virtual

Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

By default, sorting is performed by label value. Note that typically the background label has the highest frequency of occurrence, with a label value == 0 (but this is not a guarantee).

◆ GetSortBy()

virtual int vtkPackLabels::GetSortBy ( )

virtual

Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

By default, sorting is performed by label value. Note that typically the background label has the highest frequency of occurrence, with a label value == 0 (but this is not a guarantee).

◆ SortByLabelValue()

void vtkPackLabels::SortByLabelValue ( )

inline

Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

By default, sorting is performed by label value. Note that typically the background label has the highest frequency of occurrence, with a label value == 0 (but this is not a guarantee).

Definition at line 127 of file vtkPackLabels.h.

◆ SortByLabelCount()

void vtkPackLabels::SortByLabelCount ( )

inline

Indicate whether to sort the output labels by their input scalars label value (SortByLabelValue), or to sort by the frequency of occurrence of the label values(SortByLabelCount).

By default, sorting is performed by label value. Note that typically the background label has the highest frequency of occurrence, with a label value == 0 (but this is not a guarantee).

Definition at line 128 of file vtkPackLabels.h.

◆ SetOutputScalarType()

virtual void vtkPackLabels::SetOutputScalarType ( int )

virtual

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

◆ GetOutputScalarType()

virtual int vtkPackLabels::GetOutputScalarType ( )

virtual

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

◆ SetOutputScalarTypeToDefault()

void vtkPackLabels::SetOutputScalarTypeToDefault ( )

inline

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Definition at line 149 of file vtkPackLabels.h.

◆ SetOutputScalarTypeToUnsignedChar()

void vtkPackLabels::SetOutputScalarTypeToUnsignedChar ( )

inline

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Definition at line 150 of file vtkPackLabels.h.

◆ SetOutputScalarTypeToUnsignedShort()

void vtkPackLabels::SetOutputScalarTypeToUnsignedShort ( )

inline

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Definition at line 151 of file vtkPackLabels.h.

◆ SetOutputScalarTypeToUnsignedInt()

void vtkPackLabels::SetOutputScalarTypeToUnsignedInt ( )

inline

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Definition at line 152 of file vtkPackLabels.h.

◆ SetOutputScalarTypeToUnsignedLong()

void vtkPackLabels::SetOutputScalarTypeToUnsignedLong ( )

inline

Specify the data type of the output image.

The choice for output type is an unsigned integral type. Note that DEFAULT_TYPE value indicates that the output data type will be of a type large enough to represent the N labels present in the input (this is on by default). Explicit specification of the output type can cause labels in the input scalars to be replaced with the BackgroundValue in the output scalars. This occurs when trying to represent N labels in a data type that cannot represent all N values (e.g., trying to pack 500 labels unto an unsigned char packed label map).

Definition at line 153 of file vtkPackLabels.h.

◆ SetBackgroundValue()

virtual void vtkPackLabels::SetBackgroundValue ( unsigned long )

virtual

Specify a background label value.

This value is used when the ith label is i >= N where N is the number of labels that the OutputScalarType can represent. So for example, when trying to pack 500 labels into an unsigned char output scalar type, all i labels i>=256 would be set to this background value. By default the BackgroundValue == 0.

◆ GetBackgroundValue()

virtual unsigned long vtkPackLabels::GetBackgroundValue ( )

virtual

Specify a background label value.

This value is used when the ith label is i >= N where N is the number of labels that the OutputScalarType can represent. So for example, when trying to pack 500 labels into an unsigned char output scalar type, all i labels i>=256 would be set to this background value. By default the BackgroundValue == 0.