Class designed to help with merging of points in parallel. More...

#include <vtkSMPMergePoints.h>

Inheritance diagram for vtkSMPMergePoints:

Collaboration diagram for vtkSMPMergePoints:

Public Types
typedef vtkMergePoints	Superclass

Public Types inherited from vtkMergePoints
typedef vtkPointLocator	Superclass

Public Types inherited from vtkPointLocator
typedef vtkIncrementalPointLocator	Superclass
	Standard methods for type management and printing. More...

Public Types inherited from vtkIncrementalPointLocator
typedef vtkAbstractPointLocator	Superclass

Public Types inherited from vtkAbstractPointLocator
typedef vtkLocator	Superclass
	Standard type and print methods. More...

Public Types inherited from vtkLocator
typedef vtkObject	Superclass
	Standard type and print methods. More...

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type management and printing. More...

vtkSMPMergePoints *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods. More...

void	InitializeMerge ()
	This should be called from 1 thread before any call to Merge. More...

void	Merge (vtkSMPMergePoints locator, vtkIdType idx, vtkPointData outPd, vtkPointData inPd, vtkIdList idList)
	Merge the points of one of the bins from the given locator to the same bin of the current locator. More...

void	FixSizeOfPointArray ()
	At the of the merge, this can be called to set the MaxId of the points array to the maximum id in the locator. More...

vtkIdType	GetMaxId ()
	Returns the biggest id in the locator. More...

vtkIdType	GetNumberOfBuckets () override
	Returns the number of bins. More...


vtkIdType	GetNumberOfIdsInBucket (vtkIdType idx)
	Returns the number of points in a bin. More...

Public Member Functions inherited from vtkMergePoints
vtkMergePoints *	NewInstance () const

int	InsertUniquePoint (const double x[3], vtkIdType &ptId) override
	Determine whether point given by x[3] has been inserted into points list. More...

vtkIdType	IsInsertedPoint (const double x[3]) override
	Determine whether point given by x[3] has been inserted into points list. More...

vtkIdType	IsInsertedPoint (double x, double y, double z) override
	Determine whether point given by x[3] has been inserted into points list. More...

Public Member Functions inherited from vtkPointLocator
vtkIdType	FindClosestPoint (const double x[3]) override
	Given a position x, return the id of the point closest to it. More...

int	InitPointInsertion (vtkPoints *newPts, const double bounds[6]) override
	Initialize the point insertion process. More...

int	InitPointInsertion (vtkPoints *newPts, const double bounds[6], vtkIdType estSize) override
	Initialize the point insertion process. More...

void	InsertPoint (vtkIdType ptId, const double x[3]) override
	Incrementally insert a point into search structure with a particular index value. More...

vtkIdType	InsertNextPoint (const double x[3]) override
	Incrementally insert a point into search structure. More...

int	InsertUniquePoint (const double x[3], vtkIdType &ptId) override
	Determine whether point given by x[3] has been inserted into points list. More...

vtkIdType	FindClosestInsertedPoint (const double x[3]) override
	Given a position x, return the id of the point closest to it. More...

void	FindClosestNPoints (int N, const double x[3], vtkIdList *result) override
	Find the closest N points to a position. More...

void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result) override
	Find all points within a specified radius R of position x. More...

virtual vtkIdList *	GetPointsInBucket (const double x[3], int ijk[3])
	Given a position x, return the list of points in the bucket that contains the point. More...

virtual void	SetDivisions (int, int, int)
	Set the number of divisions in x-y-z directions. More...

virtual void	SetDivisions (int[3])
	Set the number of divisions in x-y-z directions. More...

virtual int *	GetDivisions ()
	Set the number of divisions in x-y-z directions. More...

virtual void	GetDivisions (int data[3])
	Set the number of divisions in x-y-z directions. More...

virtual void	SetNumberOfPointsPerBucket (int)
	Specify the average number of points in each bucket. More...

virtual int	GetNumberOfPointsPerBucket ()
	Specify the average number of points in each bucket. More...

vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double &dist2) override
	Given a position x and a radius r, return the id of the point closest to the point in that radius. More...

virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double inputDataLength, double &dist2)
	Given a position x and a radius r, return the id of the point closest to the point in that radius. More...

vtkIdType	IsInsertedPoint (double x, double y, double z) override
	Determine whether point given by x[3] has been inserted into points list. More...

vtkIdType	IsInsertedPoint (const double x[3]) override
	Determine whether point given by x[3] has been inserted into points list. More...

virtual void	FindDistributedPoints (int N, const double x[3], vtkIdList *result, int M)
	Find the closest points to a position such that each octant of space around the position contains at least N points. More...

virtual void	FindDistributedPoints (int N, double x, double y, double z, vtkIdList *result, int M)
	Find the closest points to a position such that each octant of space around the position contains at least N points. More...

virtual vtkPoints *	GetPoints ()
	Provide an accessor to the points. More...

void	Initialize () override
	See vtkLocator interface documentation. More...

void	FreeSearchStructure () override
	See vtkLocator interface documentation. More...

void	BuildLocator () override
	See vtkLocator interface documentation. More...

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	See vtkLocator interface documentation. More...

vtkPointLocator *	NewInstance () const
	Standard methods for type management and printing. More...

Public Member Functions inherited from vtkIncrementalPointLocator
vtkIncrementalPointLocator *	NewInstance () const

Public Member Functions inherited from vtkAbstractPointLocator
vtkIdType	FindClosestPoint (double x, double y, double z)
	Given a position x, return the id of the point closest to it. More...

void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
	Find the closest N points to a position. More...

void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
	Find all points within a specified radius R of position x. More...

virtual double *	GetBounds ()
	Provide an accessor to the bounds. More...

virtual void	GetBounds (double *)
	Provide an accessor to the bounds. More...

vtkAbstractPointLocator *	NewInstance () const
	Standard type and print methods. More...

Public Member Functions inherited from vtkLocator
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed. More...

virtual void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset. More...

virtual vtkDataSet *	GetDataSet ()
	Build the locator from the points/cells defining this dataset. More...

virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree. More...

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree. More...

virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true). More...

virtual void	SetAutomatic (vtkTypeBool)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...

virtual vtkTypeBool	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...

virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...

virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...

virtual void	SetTolerance (double)
	Specify absolute tolerance (in world coordinates) for performing geometric operations. More...

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations. More...

virtual vtkMTimeType	GetBuildTime ()
	Return the time of the last data structure build. More...

void	Register (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop. More...

void	UnRegister (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop. More...

vtkLocator *	NewInstance () const
	Standard type and print methods. More...

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSMPMergePoints *	SafeDownCast (vtkObjectBase *o)

static vtkSMPMergePoints *	New ()

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMergePoints *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkPointLocator
static vtkPointLocator *	New ()
	Construct with automatic computation of divisions, averaging 25 points per bucket. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type management and printing. More...

static vtkPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type management and printing. More...

Static Public Member Functions inherited from vtkIncrementalPointLocator
static vtkTypeBool	IsTypeOf (const char *type)

static vtkIncrementalPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractPointLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods. More...

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods. More...

Static Public Member Functions inherited from vtkLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods. More...

static vtkLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods. More...

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. More...

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

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

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

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

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

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type management and printing. More...

	vtkSMPMergePoints ()

	~vtkSMPMergePoints () override

Protected Member Functions inherited from vtkMergePoints
	vtkMergePoints ()

	~vtkMergePoints () override

Protected Member Functions inherited from vtkPointLocator
	vtkPointLocator ()

	~vtkPointLocator () override

void	GetBucketNeighbors (vtkNeighborPoints *buckets, const int ijk[3], const int ndivs[3], int level)

void	GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], const int ijk[3], double dist, int level)

void	GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])

void	GenerateFace (int face, int i, int j, int k, vtkPoints pts, vtkCellArray polys)

double	Distance2ToBucket (const double x[3], const int nei[3])

double	Distance2ToBounds (const double x[3], const double bounds[6])

void	GetBucketIndices (const double *x, int ijk[3]) const

vtkIdType	GetBucketIndex (const double *x) const

void	ComputePerformanceFactors ()

Protected Member Functions inherited from vtkIncrementalPointLocator
	vtkIncrementalPointLocator ()

	~vtkIncrementalPointLocator () override

Protected Member Functions inherited from vtkAbstractPointLocator
	vtkAbstractPointLocator ()

	~vtkAbstractPointLocator () override

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkAtomicIdType	AtomicInsertionId

Protected Attributes inherited from vtkPointLocator
vtkPoints *	Points

int	Divisions [3]

int	NumberOfPointsPerBucket

vtkIdList **	HashTable

double	H [3]

double	InsertionTol2

vtkIdType	InsertionPointId

double	InsertionLevel

double	HX

double	HY

double	HZ

double	FX

double	FY

double	FZ

double	BX

double	BY

double	BZ

vtkIdType	XD

vtkIdType	YD

vtkIdType	ZD

vtkIdType	SliceSize

Protected Attributes inherited from vtkAbstractPointLocator
double	Bounds [6]

vtkIdType	NumberOfBuckets

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Class designed to help with merging of points in parallel.

vtkSMPMergePoints is a subclass of vtkMergePoints designed to help with merging of points generated by using multiple locators in parallel. Its main functionality is provided by the Merge function. It also has a few additional convenience functions. Merge is thread safe as long as no two threads are merging the same bin. The common way of using vtkSMPMergePoints is:

Initialize with outLocator->InitializeMerge()
Allocate points with outLocator->GetPoints()->Resize(numPts) (numPts should be >= total number of points)
Do bunch of merging with outLocator->Merge(inLocator[i], ...) (this can be done in parallel as long as no two bins are done at the same time)
Fix the size of points with outLocator->FixSizeOfPointArray()

Definition at line 41 of file vtkSMPMergePoints.h.

Member Typedef Documentation

typedef vtkMergePoints vtkSMPMergePoints::Superclass

Definition at line 44 of file vtkSMPMergePoints.h.

Constructor & Destructor Documentation

vtkSMPMergePoints::vtkSMPMergePoints ( )

protected

vtkSMPMergePoints::~vtkSMPMergePoints ( )

overrideprotected

Member Function Documentation

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

static

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

virtual

Standard methods for type management and printing.

Reimplemented from vtkMergePoints.

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

static

virtual vtkObjectBase* vtkSMPMergePoints::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type management and printing.

Reimplemented from vtkMergePoints.

vtkSMPMergePoints* vtkSMPMergePoints::NewInstance ( ) const

static vtkSMPMergePoints* vtkSMPMergePoints::New ( )

static

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkMergePoints.

void vtkSMPMergePoints::InitializeMerge ( )

This should be called from 1 thread before any call to Merge.

void vtkSMPMergePoints::Merge	(	vtkSMPMergePoints *	locator,
		vtkIdType	idx,
		vtkPointData *	outPd,
		vtkPointData *	inPd,
		vtkIdList *	idList
	)

Merge the points of one of the bins from the given locator to the same bin of the current locator.

Note that this requires that the two locators have identical binning structures. This also merges point data given in the inPD argument to the outPd. Furthermore, it generates a map of the old ids of the input locator to the new ids. This is stored in the idList argument. The map is idList[oldId] = newId.

void vtkSMPMergePoints::FixSizeOfPointArray ( )

At the of the merge, this can be called to set the MaxId of the points array to the maximum id in the locator.

The current design usage is as follows:

Allocate points with points->Resize(numPts). NumPts should be >= total number of points
Do bunch of merging with outLocator->Merge(inLocator[i], ...)
Fix the size of points with outLocator->FixSizeOfPointArray()

vtkIdType vtkSMPMergePoints::GetMaxId ( )

inline

Returns the biggest id in the locator.

Definition at line 81 of file vtkSMPMergePoints.h.

vtkIdType vtkSMPMergePoints::GetNumberOfIdsInBucket ( vtkIdType idx )

inline

Returns the number of points in a bin.

Definition at line 90 of file vtkSMPMergePoints.h.

vtkIdType vtkSMPMergePoints::GetNumberOfBuckets ( void )

inlineoverridevirtual

Returns the number of bins.

Reimplemented from vtkAbstractPointLocator.

Definition at line 104 of file vtkSMPMergePoints.h.

Member Data Documentation

vtkAtomicIdType vtkSMPMergePoints::AtomicInsertionId

protected

Definition at line 113 of file vtkSMPMergePoints.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Filters/SMP/vtkSMPMergePoints.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation