VTK  9.6.20260305
vtkLabeledImagePointSampler Class Reference

produce sampled points from a segmented image More...

#include <vtkLabeledImagePointSampler.h>

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

Public Member Functions

vtkMTimeType GetMTime () override
 Because we delegate to vtkContourValues.
 
virtual void SetBackgroundPointMapping (int)
 These methods are used to control how output region labels are assigned to background points.
 
virtual int GetBackgroundPointMapping ()
 These methods are used to control how output region labels are assigned to background points.
 
virtual void BackgroundPointMappingOn ()
 These methods are used to control how output region labels are assigned to background points.
 
virtual void BackgroundPointMappingOff ()
 These methods are used to control how output region labels are assigned to background points.
 
virtual void SetBackgroundPointLabel (int)
 These methods are used to control how output region labels are assigned to background points.
 
virtual int GetBackgroundPointLabel ()
 These methods are used to control how output region labels are assigned to background points.
 
virtual void SetN (unsigned int)
 Specify the parameter N which controls the generation of points, and the resulting point density.
 
virtual unsigned int GetN ()
 Specify the parameter N which controls the generation of points, and the resulting point density.
 
virtual void SetRandomize (vtkTypeBool)
 The production of output points can be randomized.
 
virtual vtkTypeBool GetRandomize ()
 The production of output points can be randomized.
 
virtual void RandomizeOn ()
 The production of output points can be randomized.
 
virtual void RandomizeOff ()
 The production of output points can be randomized.
 
virtual void SetRandomProbabilityRange (double, double)
 Modifiy the probability of the point randomization process.
 
void SetRandomProbabilityRange (double[2])
 Modifiy the probability of the point randomization process.
 
virtual double * GetRandomProbabilityRange ()
 Modifiy the probability of the point randomization process.
 
virtual void GetRandomProbabilityRange (double data[2])
 Modifiy the probability of the point randomization process.
 
virtual void SetJoggle (vtkTypeBool)
 Enable/disable point joggling.
 
virtual vtkTypeBool GetJoggle ()
 Enable/disable point joggling.
 
virtual void JoggleOn ()
 Enable/disable point joggling.
 
virtual void JoggleOff ()
 Enable/disable point joggling.
 
virtual void SetJoggleRadius (double)
 Enable/disable point joggling.
 
virtual double GetJoggleRadius ()
 Enable/disable point joggling.
 
virtual void SetJoggleRadiusIsAbsolute (vtkTypeBool)
 Enable/disable point joggling.
 
virtual void JoggleRadiusIsAbsoluteOn ()
 Enable/disable point joggling.
 
virtual void JoggleRadiusIsAbsoluteOff ()
 Enable/disable point joggling.
 
virtual vtkTypeBool GetJoggleRadiusIsAbsolute ()
 Enable/disable point joggling.
 
virtual void SetConstrainJoggle (vtkTypeBool)
 Enable/disable point joggling.
 
virtual void ConstrainJoggleOn ()
 Enable/disable point joggling.
 
virtual void ConstrainJoggleOff ()
 Enable/disable point joggling.
 
virtual vtkTypeBool GetConstrainJoggle ()
 Enable/disable point joggling.
 
virtual void SetJoggleConstraint (double)
 Enable/disable point joggling.
 
virtual double GetJoggleConstraint ()
 Enable/disable point joggling.
 
void SetValue (int i, double value)
 Set a particular label value at label number i.
 
void SetLabel (int i, double value)
 Set a particular label value at label number i.
 
double GetValue (int i)
 Get the ith label value.
 
double GetLabel (int i)
 Get the ith label value.
 
double * GetValues ()
 Get a pointer to an array of labels.
 
double * GetLabels ()
 Get a pointer to an array of labels.
 
void GetValues (double *contourValues)
 Fill a supplied list with label values.
 
void GetLabels (double *contourValues)
 Fill a supplied list with label values.
 
void SetNumberOfLabels (int number)
 Set the number of labels to place into the list.
 
void SetNumberOfContours (int number)
 Set the number of labels to place into the list.
 
vtkIdType GetNumberOfLabels ()
 Get the number of labels in the list of label values.
 
vtkIdType GetNumberOfContours ()
 Get the number of labels in the list of label values.
 
void GenerateLabels (int numLabels, double range[2])
 Generate numLabels equally spaced labels between the specified range.
 
void GenerateValues (int numContours, double range[2])
 Generate numLabels equally spaced labels between the specified range.
 
void GenerateLabels (int numLabels, double rangeStart, double rangeEnd)
 Generate numLabels equally spaced labels between the specified range.
 
void GenerateValues (int numContours, double rangeStart, double rangeEnd)
 Generate numLabels equally spaced labels between the specified range.
 
virtual void SetGenerateVerts (vtkTypeBool)
 Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.
 
virtual vtkTypeBool GetGenerateVerts ()
 Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.
 
virtual void GenerateVertsOn ()
 Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.
 
virtual void GenerateVertsOff ()
 Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetOutput (int)
 Get the output data object for a port on this algorithm.
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
int GetNumberOfInputArraySpecifications ()
 Get the number of input array indices that have already been set.
 
bool ResetInputArraySpecifications ()
 Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual bool UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual bool UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual bool UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
void SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
 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, const char *name, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
 
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, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
 
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 SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName, const char *component)
 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 bool Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual bool Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual 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

 vtkLabeledImagePointSampler ()
 
 ~vtkLabeledImagePointSampler () override=default
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
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.
 
int GetInputArrayComponent (int idx)
 Get the component to process of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkSmartPointer< vtkAbstractArrayGetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
 
vtkSmartPointer< vtkAbstractArrayGetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
 
template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType > GetInputArrayAs (Params &&... params)
 Get an array from the input at index idx.
 
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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool BackgroundPointMapping
 
int BackgroundPointLabel
 
int DensityDistribution
 
unsigned int N
 
int OutputType
 
vtkTypeBool Randomize
 
double RandomProbabilityRange [2]
 
vtkTypeBool Joggle
 
double JoggleRadius
 
vtkTypeBool JoggleRadiusIsAbsolute
 
vtkTypeBool ConstrainJoggle
 
double JoggleConstraint
 
vtkSmartPointer< vtkContourValuesLabels
 
vtkTypeBool GenerateVerts
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
enum  DensityDistributionType { LINEAR = 0 , EXPONENTIAL = 1 }
 Used to indicate the type of point density distribution. More...
 
virtual void SetDensityDistribution (int)
 Specify the type of point selection distribution (i.e., the specification of the point density).
 
virtual int GetDensityDistribution ()
 Used to indicate the type of point density distribution.
 
void SetDensityDistributionToLinear ()
 Used to indicate the type of point density distribution.
 
void SetDensityDistributionToExponential ()
 Used to indicate the type of point density distribution.
 
enum  OutputLabelsSelection { ALL_POINTS = 0 , LABELED_POINTS = 1 , BACKGROUND_POINTS = 2 }
 Used to indicate which generated points to output. More...
 
virtual void SetOutputType (int)
 Indicate what points to output.
 
virtual int GetOutputType ()
 Used to indicate which generated points to output.
 
void SetOutputTypeToAllPoints ()
 Used to indicate which generated points to output.
 
void SetOutputTypeToLabeledPoints ()
 Used to indicate which generated points to output.
 
void SetOutputTypeToBackgroundPoints ()
 Used to indicate which generated points to output.
 
typedef vtkPolyDataAlgorithm Superclass
 Standard methods for instantiation, obtaining type information, and printing information.
 
static vtkLabeledImagePointSamplerNew ()
 Standard methods for instantiation, obtaining type information, and printing information.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, obtaining type information, and printing information.
 
static vtkLabeledImagePointSamplerSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, obtaining type information, and printing information.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, obtaining type information, and printing information.
 
vtkLabeledImagePointSamplerNewInstance () const
 Standard methods for instantiation, obtaining type information, and printing information.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, obtaining type information, and printing information.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, obtaining type information, and printing information.
 

Additional Inherited Members

- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 
- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

produce sampled points from a segmented image

vtkLabeledImagePointSampler is a utility filter that produces points from a labeled input 3D volume or 2D xy image. This can be used to reduce the overall size of the data, and/or convert data (from a segmented image to a sampled vtkPointSet) for filters like vtkVoronoiFlower2D/3D or vtkGeneralizedSurfaceNets3D that require input points. The required input image data is a integer region id point data array (i.e., the labels). (The filter is akin to dividing cubes, which is a way to represent contours with point clouds.) The output of the filter is represented by the vtkPointSet subclass vtkPolyData containing a list of points, and a point data array identifying the region from which each point is generated.

The filter produces points in an adaptive manner, more dense near segmented region boundaries, and less dense moving away from region boundaries. The process of adaption can be controlled by specifying either a linear density distribution, choosing every Nth point, or an exponential distribution, with power N (e.g., point density reduced as a power of 2).

Segmented regions within the input image are identified by specifying a set of one or more values/labels. Points not in any defined (labeled) regions are called background points. As expected, labeled points are generated from the input set of voxel/pixel labels. Background points can be given a "BackgroundPointLabel" which can be used by other filters for thresholding, or for generating tessellations (e.g., Voronoi filters). (By default, the BackgroundPointLabel is a large negative integral number.) By default, both labeled and background points are output; optionally, only points within labeled or background regions can be output.

In some applications, it may be advantageous to randomly joggle (alternatively: perturb, jitter, jiggle) the generated output points. Because a image is being sampled, it can produce regularly spaced points that can affect the performance and numerical stability of certain filters like Voronoi and Delaunay.

Note
The term "joggle" was first used in the context of Voronoi degeneracies by the popular QuickHull algorithm (and the associated QHull implementation qhull.org).
Warning
If the input labels (region ids) are not of type int, they will be converted to type int. This is because several important filters (e.g., vtkVoronoiFlower2D, vtkVoronoi3D, vtkGeneralizedSurfaceNets2D) currently require int region labels as input. This could be extended using templates at the cost of significant bloat, as long as the representational types support both negative and positive values (e.g., unsigned will not work correctly).
This filter can produce large numbers of points. It is recommended that the filter parameter N and density distribution function is chosen carefully to manage the size of the output.
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.
See also
vtkVoronoiFlower2D vtkVoronoiFlower3D vtkGeneralizedSurfaceNets3D vtkJogglePoints vtkFillPointCloud
Tests:
vtkLabeledImagePointSampler (Tests)

Definition at line 83 of file vtkLabeledImagePointSampler.h.

Member Typedef Documentation

◆ Superclass

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

Definition at line 92 of file vtkLabeledImagePointSampler.h.

Member Enumeration Documentation

◆ DensityDistributionType

Used to indicate the type of point density distribution.

By default, an exponential density distribution with N=2 is used.

Enumerator
LINEAR 
EXPONENTIAL 

Definition at line 123 of file vtkLabeledImagePointSampler.h.

◆ OutputLabelsSelection

Used to indicate which generated points to output.

Enumerator
ALL_POINTS 
LABELED_POINTS 
BACKGROUND_POINTS 

Definition at line 183 of file vtkLabeledImagePointSampler.h.

Constructor & Destructor Documentation

◆ vtkLabeledImagePointSampler()

vtkLabeledImagePointSampler::vtkLabeledImagePointSampler ( )
protected

◆ ~vtkLabeledImagePointSampler()

vtkLabeledImagePointSampler::~vtkLabeledImagePointSampler ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkLabeledImagePointSampler * vtkLabeledImagePointSampler::New ( )
static

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

◆ IsTypeOf()

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

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

◆ IsA()

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

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

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLabeledImagePointSampler::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkLabeledImagePointSampler * vtkLabeledImagePointSampler::NewInstance ( ) const

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

◆ PrintSelf()

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

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

Reimplemented from vtkAlgorithm.

◆ SetBackgroundPointMapping()

virtual void vtkLabeledImagePointSampler::SetBackgroundPointMapping ( int )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ GetBackgroundPointMapping()

virtual int vtkLabeledImagePointSampler::GetBackgroundPointMapping ( )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ BackgroundPointMappingOn()

virtual void vtkLabeledImagePointSampler::BackgroundPointMappingOn ( )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ BackgroundPointMappingOff()

virtual void vtkLabeledImagePointSampler::BackgroundPointMappingOff ( )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ SetBackgroundPointLabel()

virtual void vtkLabeledImagePointSampler::SetBackgroundPointLabel ( int )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ GetBackgroundPointLabel()

virtual int vtkLabeledImagePointSampler::GetBackgroundPointLabel ( )
virtual

These methods are used to control how output region labels are assigned to background points.

When BackgroundPointMapping is enabled, points with region labels not in the input list of segmented values are assigned the BackgroundPointLabel. By default, BackgroundPointMapping is off, so the input image labels are used. If however, BackgroundPointMapping is on, then the BackgroundPointLabel is assigned to unlabeled points. (Recall that background points have input labels/values that do not exist in the specified set of labels/values). By default, the BackgroundPointLabel is set to a negative integral number that typically denotes the point is outside of the segmented points. (Make sure that the background pt id is not a value in the set of labels/values or havoc may ensue).

◆ SetDensityDistribution()

virtual void vtkLabeledImagePointSampler::SetDensityDistribution ( int )
virtual

Specify the type of point selection distribution (i.e., the specification of the point density).

◆ GetDensityDistribution()

virtual int vtkLabeledImagePointSampler::GetDensityDistribution ( )
virtual

Used to indicate the type of point density distribution.

By default, an exponential density distribution with N=2 is used.

◆ SetDensityDistributionToLinear()

void vtkLabeledImagePointSampler::SetDensityDistributionToLinear ( )
inline

Used to indicate the type of point density distribution.

By default, an exponential density distribution with N=2 is used.

Definition at line 134 of file vtkLabeledImagePointSampler.h.

◆ SetDensityDistributionToExponential()

void vtkLabeledImagePointSampler::SetDensityDistributionToExponential ( )
inline

Used to indicate the type of point density distribution.

By default, an exponential density distribution with N=2 is used.

Definition at line 135 of file vtkLabeledImagePointSampler.h.

◆ SetN()

virtual void vtkLabeledImagePointSampler::SetN ( unsigned int )
virtual

Specify the parameter N which controls the generation of points, and the resulting point density.

In a linear distribution, N indicates every Nth point; in an exponential distribution, N indicates is the exponent of density variation. By default, N=2.

◆ GetN()

virtual unsigned int vtkLabeledImagePointSampler::GetN ( )
virtual

Specify the parameter N which controls the generation of points, and the resulting point density.

In a linear distribution, N indicates every Nth point; in an exponential distribution, N indicates is the exponent of density variation. By default, N=2.

◆ SetRandomize()

virtual void vtkLabeledImagePointSampler::SetRandomize ( vtkTypeBool )
virtual

The production of output points can be randomized.

This can be useful because the sampling of a regular grid (i.e., the volume) can output points that are strongly coherent, which is undesirable in some applications. If randomize if enabled, the points are output with probability 1/Dist, where Dist is the distance from a labeled region boundary. The probability can be further modified by applying the probability range, which has the effect of clamping the minimum and maximum selection probabilities. By default, Randomize is true.

◆ GetRandomize()

virtual vtkTypeBool vtkLabeledImagePointSampler::GetRandomize ( )
virtual

The production of output points can be randomized.

This can be useful because the sampling of a regular grid (i.e., the volume) can output points that are strongly coherent, which is undesirable in some applications. If randomize if enabled, the points are output with probability 1/Dist, where Dist is the distance from a labeled region boundary. The probability can be further modified by applying the probability range, which has the effect of clamping the minimum and maximum selection probabilities. By default, Randomize is true.

◆ RandomizeOn()

virtual void vtkLabeledImagePointSampler::RandomizeOn ( )
virtual

The production of output points can be randomized.

This can be useful because the sampling of a regular grid (i.e., the volume) can output points that are strongly coherent, which is undesirable in some applications. If randomize if enabled, the points are output with probability 1/Dist, where Dist is the distance from a labeled region boundary. The probability can be further modified by applying the probability range, which has the effect of clamping the minimum and maximum selection probabilities. By default, Randomize is true.

◆ RandomizeOff()

virtual void vtkLabeledImagePointSampler::RandomizeOff ( )
virtual

The production of output points can be randomized.

This can be useful because the sampling of a regular grid (i.e., the volume) can output points that are strongly coherent, which is undesirable in some applications. If randomize if enabled, the points are output with probability 1/Dist, where Dist is the distance from a labeled region boundary. The probability can be further modified by applying the probability range, which has the effect of clamping the minimum and maximum selection probabilities. By default, Randomize is true.

◆ SetRandomProbabilityRange() [1/2]

virtual void vtkLabeledImagePointSampler::SetRandomProbabilityRange ( double ,
double  )
virtual

Modifiy the probability of the point randomization process.

The range should be within [0,1], and it's effect is to clamp the minimum and maximum selection probabilities. By default, the range is (0,1). These default values mean that points directly adjacent to the region boundaries have probability 1 of be selected; while distant points approach a probability of zero to be selected (using the 1/Dist randomization function mentioned previously).

◆ SetRandomProbabilityRange() [2/2]

void vtkLabeledImagePointSampler::SetRandomProbabilityRange ( double [2])

Modifiy the probability of the point randomization process.

The range should be within [0,1], and it's effect is to clamp the minimum and maximum selection probabilities. By default, the range is (0,1). These default values mean that points directly adjacent to the region boundaries have probability 1 of be selected; while distant points approach a probability of zero to be selected (using the 1/Dist randomization function mentioned previously).

◆ GetRandomProbabilityRange() [1/2]

virtual double * vtkLabeledImagePointSampler::GetRandomProbabilityRange ( )
virtual

Modifiy the probability of the point randomization process.

The range should be within [0,1], and it's effect is to clamp the minimum and maximum selection probabilities. By default, the range is (0,1). These default values mean that points directly adjacent to the region boundaries have probability 1 of be selected; while distant points approach a probability of zero to be selected (using the 1/Dist randomization function mentioned previously).

◆ GetRandomProbabilityRange() [2/2]

virtual void vtkLabeledImagePointSampler::GetRandomProbabilityRange ( double data[2])
virtual

Modifiy the probability of the point randomization process.

The range should be within [0,1], and it's effect is to clamp the minimum and maximum selection probabilities. By default, the range is (0,1). These default values mean that points directly adjacent to the region boundaries have probability 1 of be selected; while distant points approach a probability of zero to be selected (using the 1/Dist randomization function mentioned previously).

◆ SetOutputType()

virtual void vtkLabeledImagePointSampler::SetOutputType ( int )
virtual

Indicate what points to output.

By default, all points including both labeled points, as well as background points, are produced on output. However it is possible to output only points in the labeled regions, or output points in background regions.

◆ GetOutputType()

virtual int vtkLabeledImagePointSampler::GetOutputType ( )
virtual

Used to indicate which generated points to output.

◆ SetOutputTypeToAllPoints()

void vtkLabeledImagePointSampler::SetOutputTypeToAllPoints ( )
inline

Used to indicate which generated points to output.

Definition at line 197 of file vtkLabeledImagePointSampler.h.

◆ SetOutputTypeToLabeledPoints()

void vtkLabeledImagePointSampler::SetOutputTypeToLabeledPoints ( )
inline

Used to indicate which generated points to output.

Definition at line 198 of file vtkLabeledImagePointSampler.h.

◆ SetOutputTypeToBackgroundPoints()

void vtkLabeledImagePointSampler::SetOutputTypeToBackgroundPoints ( )
inline

Used to indicate which generated points to output.

Definition at line 199 of file vtkLabeledImagePointSampler.h.

◆ SetJoggle()

virtual void vtkLabeledImagePointSampler::SetJoggle ( vtkTypeBool )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ GetJoggle()

virtual vtkTypeBool vtkLabeledImagePointSampler::GetJoggle ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ JoggleOn()

virtual void vtkLabeledImagePointSampler::JoggleOn ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ JoggleOff()

virtual void vtkLabeledImagePointSampler::JoggleOff ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ SetJoggleRadius()

virtual void vtkLabeledImagePointSampler::SetJoggleRadius ( double )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ GetJoggleRadius()

virtual double vtkLabeledImagePointSampler::GetJoggleRadius ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ SetJoggleRadiusIsAbsolute()

virtual void vtkLabeledImagePointSampler::SetJoggleRadiusIsAbsolute ( vtkTypeBool )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ JoggleRadiusIsAbsoluteOn()

virtual void vtkLabeledImagePointSampler::JoggleRadiusIsAbsoluteOn ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ JoggleRadiusIsAbsoluteOff()

virtual void vtkLabeledImagePointSampler::JoggleRadiusIsAbsoluteOff ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ GetJoggleRadiusIsAbsolute()

virtual vtkTypeBool vtkLabeledImagePointSampler::GetJoggleRadiusIsAbsolute ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ SetConstrainJoggle()

virtual void vtkLabeledImagePointSampler::SetConstrainJoggle ( vtkTypeBool )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ ConstrainJoggleOn()

virtual void vtkLabeledImagePointSampler::ConstrainJoggleOn ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ ConstrainJoggleOff()

virtual void vtkLabeledImagePointSampler::ConstrainJoggleOff ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ GetConstrainJoggle()

virtual vtkTypeBool vtkLabeledImagePointSampler::GetConstrainJoggle ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ SetJoggleConstraint()

virtual void vtkLabeledImagePointSampler::SetJoggleConstraint ( double )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ GetJoggleConstraint()

virtual double vtkLabeledImagePointSampler::GetJoggleConstraint ( )
virtual

Enable/disable point joggling.

By default, the joggle radius is a fraction of the diagonal length of the input image data. However, an absolute joggle radius can be specified. Optionally, the joggle radius can be constrained so that it remains in the originating pixel/voxel. If a joggle constraint is enabled, then a factor can be applied that specifies the maximum distance a point can be perturbed relative to the minimum length of the pixel/voxel.

◆ SetValue()

void vtkLabeledImagePointSampler::SetValue ( int i,
double value )
inline

Set a particular label value at label number i.

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

Definition at line 242 of file vtkLabeledImagePointSampler.h.

◆ SetLabel()

void vtkLabeledImagePointSampler::SetLabel ( int i,
double value )
inline

Set a particular label value at label number i.

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

Definition at line 243 of file vtkLabeledImagePointSampler.h.

◆ GetValue()

double vtkLabeledImagePointSampler::GetValue ( int i)
inline

Get the ith label value.

Definition at line 250 of file vtkLabeledImagePointSampler.h.

◆ GetLabel()

double vtkLabeledImagePointSampler::GetLabel ( int i)
inline

Get the ith label value.

Definition at line 251 of file vtkLabeledImagePointSampler.h.

◆ GetValues() [1/2]

double * vtkLabeledImagePointSampler::GetValues ( )
inline

Get a pointer to an array of labels.

There will be GetNumberOfLabels() values in the list.

Definition at line 259 of file vtkLabeledImagePointSampler.h.

◆ GetLabels() [1/2]

double * vtkLabeledImagePointSampler::GetLabels ( )
inline

Get a pointer to an array of labels.

There will be GetNumberOfLabels() values in the list.

Definition at line 260 of file vtkLabeledImagePointSampler.h.

◆ GetValues() [2/2]

void vtkLabeledImagePointSampler::GetValues ( double * contourValues)
inline

Fill a supplied list with label values.

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

Definition at line 269 of file vtkLabeledImagePointSampler.h.

◆ GetLabels() [2/2]

void vtkLabeledImagePointSampler::GetLabels ( double * contourValues)
inline

Fill a supplied list with label values.

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

Definition at line 270 of file vtkLabeledImagePointSampler.h.

◆ SetNumberOfLabels()

void vtkLabeledImagePointSampler::SetNumberOfLabels ( int number)
inline

Set the number of labels to place into the list.

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

Definition at line 281 of file vtkLabeledImagePointSampler.h.

◆ SetNumberOfContours()

void vtkLabeledImagePointSampler::SetNumberOfContours ( int number)
inline

Set the number of labels to place into the list.

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

Definition at line 282 of file vtkLabeledImagePointSampler.h.

◆ GetNumberOfLabels()

vtkIdType vtkLabeledImagePointSampler::GetNumberOfLabels ( )
inline

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

Definition at line 289 of file vtkLabeledImagePointSampler.h.

◆ GetNumberOfContours()

vtkIdType vtkLabeledImagePointSampler::GetNumberOfContours ( )
inline

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

Definition at line 290 of file vtkLabeledImagePointSampler.h.

◆ GenerateLabels() [1/2]

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

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 298 of file vtkLabeledImagePointSampler.h.

◆ GenerateValues() [1/2]

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

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 302 of file vtkLabeledImagePointSampler.h.

◆ GenerateLabels() [2/2]

void vtkLabeledImagePointSampler::GenerateLabels ( int numLabels,
double rangeStart,
double rangeEnd )
inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 306 of file vtkLabeledImagePointSampler.h.

◆ GenerateValues() [2/2]

void vtkLabeledImagePointSampler::GenerateValues ( int numContours,
double rangeStart,
double rangeEnd )
inline

Generate numLabels equally spaced labels between the specified range.

The labels will include the min/max range values.

Definition at line 310 of file vtkLabeledImagePointSampler.h.

◆ SetGenerateVerts()

virtual void vtkLabeledImagePointSampler::SetGenerateVerts ( vtkTypeBool )
virtual

Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.

Cell vertices are necessary for rendering, but may not be needed by other filters. Producing vertices (which is on by default) incurs extra memory and compute time.

◆ GetGenerateVerts()

virtual vtkTypeBool vtkLabeledImagePointSampler::GetGenerateVerts ( )
virtual

Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.

Cell vertices are necessary for rendering, but may not be needed by other filters. Producing vertices (which is on by default) incurs extra memory and compute time.

◆ GenerateVertsOn()

virtual void vtkLabeledImagePointSampler::GenerateVertsOn ( )
virtual

Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.

Cell vertices are necessary for rendering, but may not be needed by other filters. Producing vertices (which is on by default) incurs extra memory and compute time.

◆ GenerateVertsOff()

virtual void vtkLabeledImagePointSampler::GenerateVertsOff ( )
virtual

Specify whether to create output cell vertices (i.e., a Verts vtkCellArray) as well as output points.

Cell vertices are necessary for rendering, but may not be needed by other filters. Producing vertices (which is on by default) incurs extra memory and compute time.

◆ GetMTime()

vtkMTimeType vtkLabeledImagePointSampler::GetMTime ( )
overridevirtual

Because we delegate to vtkContourValues.

Reimplemented from vtkObject.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkLabeledImagePointSampler::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 vtkAlgorithm.

Member Data Documentation

◆ BackgroundPointMapping

vtkTypeBool vtkLabeledImagePointSampler::BackgroundPointMapping
protected

Definition at line 338 of file vtkLabeledImagePointSampler.h.

◆ BackgroundPointLabel

int vtkLabeledImagePointSampler::BackgroundPointLabel
protected

Definition at line 339 of file vtkLabeledImagePointSampler.h.

◆ DensityDistribution

int vtkLabeledImagePointSampler::DensityDistribution
protected

Definition at line 340 of file vtkLabeledImagePointSampler.h.

◆ N

unsigned int vtkLabeledImagePointSampler::N
protected

Definition at line 341 of file vtkLabeledImagePointSampler.h.

◆ OutputType

int vtkLabeledImagePointSampler::OutputType
protected

Definition at line 342 of file vtkLabeledImagePointSampler.h.

◆ Randomize

vtkTypeBool vtkLabeledImagePointSampler::Randomize
protected

Definition at line 344 of file vtkLabeledImagePointSampler.h.

◆ RandomProbabilityRange

double vtkLabeledImagePointSampler::RandomProbabilityRange[2]
protected

Definition at line 345 of file vtkLabeledImagePointSampler.h.

◆ Joggle

vtkTypeBool vtkLabeledImagePointSampler::Joggle
protected

Definition at line 347 of file vtkLabeledImagePointSampler.h.

◆ JoggleRadius

double vtkLabeledImagePointSampler::JoggleRadius
protected

Definition at line 348 of file vtkLabeledImagePointSampler.h.

◆ JoggleRadiusIsAbsolute

vtkTypeBool vtkLabeledImagePointSampler::JoggleRadiusIsAbsolute
protected

Definition at line 349 of file vtkLabeledImagePointSampler.h.

◆ ConstrainJoggle

vtkTypeBool vtkLabeledImagePointSampler::ConstrainJoggle
protected

Definition at line 350 of file vtkLabeledImagePointSampler.h.

◆ JoggleConstraint

double vtkLabeledImagePointSampler::JoggleConstraint
protected

Definition at line 351 of file vtkLabeledImagePointSampler.h.

◆ Labels

vtkSmartPointer<vtkContourValues> vtkLabeledImagePointSampler::Labels
protected

Definition at line 353 of file vtkLabeledImagePointSampler.h.

◆ GenerateVerts

vtkTypeBool vtkLabeledImagePointSampler::GenerateVerts
protected

Definition at line 355 of file vtkLabeledImagePointSampler.h.


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