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

merges any number of vtkDataSets back into a single vtkUnstructuredGrid More...

#include <vtkMergeCells.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMergeCellsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetUnstructuredGrid (vtkUnstructuredGrid *)
 Set the vtkUnstructuredGrid object that will become the union of the DataSets specified in MergeDataSet calls. More...
 
virtual vtkUnstructuredGridGetUnstructuredGrid ()
 
virtual void SetTotalNumberOfCells (vtkIdType)
 Specify the total number of cells in the final vtkUnstructuredGrid. More...
 
virtual vtkIdType GetTotalNumberOfCells ()
 
virtual void SetTotalNumberOfPoints (vtkIdType)
 Specify the total number of points in the final vtkUnstructuredGrid Make this call before any call to MergeDataSet(). More...
 
virtual vtkIdType GetTotalNumberOfPoints ()
 
virtual void SetUseGlobalIds (int)
 vtkMergeCells attempts eliminate duplicate points when merging data sets. More...
 
virtual int GetUseGlobalIds ()
 
virtual void UseGlobalIdsOn ()
 
virtual void UseGlobalIdsOff ()
 
virtual void SetPointMergeTolerance (double)
 vtkMergeCells attempts eliminate duplicate points when merging data sets. More...
 
virtual double GetPointMergeTolerance ()
 
virtual void SetUseGlobalCellIds (int)
 vtkMergeCells will detect and filter out duplicate cells if you provide it the name of a global cell ID array. More...
 
virtual int GetUseGlobalCellIds ()
 
virtual void UseGlobalCellIdsOn ()
 
virtual void UseGlobalCellIdsOff ()
 
virtual void SetMergeDuplicatePoints (bool)
 vtkMergeCells attempts eliminate duplicate points when merging data sets. More...
 
virtual bool GetMergeDuplicatePoints ()
 
virtual void MergeDuplicatePointsOn ()
 
virtual void MergeDuplicatePointsOff ()
 
void InvalidateCachedLocator ()
 Clear the Locator and set it to nullptr. More...
 
virtual void SetTotalNumberOfDataSets (int)
 We need to know the number of different data sets that will be merged into one so we can pre-allocate some arrays. More...
 
virtual int GetTotalNumberOfDataSets ()
 
int MergeDataSet (vtkDataSet *set)
 Provide a DataSet to be merged in to the final UnstructuredGrid. More...
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output points. More...
 
virtual int GetOutputPointsPrecision ()
 
void Finish ()
 Call Finish() after merging last DataSet to free unneeded memory and to make sure the ugrid's GetNumberOfPoints() reflects the actual number of points set, not the number allocated. 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...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual 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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMergeCellsSafeDownCast (vtkObjectBase *o)
 
static vtkMergeCellsNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMergeCells ()
 
 ~vtkMergeCells () override
 
void FreeLists ()
 
void StartUGrid (vtkDataSet *set)
 
vtkIdTypeMapPointsToIdsUsingGlobalIds (vtkDataSet *set)
 
vtkIdTypeMapPointsToIdsUsingLocator (vtkDataSet *set)
 
vtkIdType AddNewCellsUnstructuredGrid (vtkDataSet *set, vtkIdType *idMap)
 
vtkIdType AddNewCellsDataSet (vtkDataSet *set, vtkIdType *idMap)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int TotalNumberOfDataSets
 
vtkIdType TotalNumberOfCells
 
vtkIdType TotalNumberOfPoints
 
vtkIdType NumberOfCells
 
vtkIdType NumberOfPoints
 
int UseGlobalIds
 
int UseGlobalCellIds
 
double PointMergeTolerance
 
bool MergeDuplicatePoints
 
int OutputPointsPrecision = vtkAlgorithm::DEFAULT_PRECISION
 
char InputIsUGrid
 
char InputIsPointSet
 
vtkMergeCellsSTLCloak * GlobalIdMap
 
vtkMergeCellsSTLCloak * GlobalCellIdMap
 
vtkDataSetAttributes::FieldListPointList
 
vtkDataSetAttributes::FieldListCellList
 
vtkUnstructuredGridUnstructuredGrid
 
int NextGrid
 
vtkSmartPointer< vtkIncrementalPointLocatorLocator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

merges any number of vtkDataSets back into a single vtkUnstructuredGrid

Designed to work with distributed vtkDataSets, this class will take vtkDataSets and merge them back into a single vtkUnstructuredGrid.

The vtkPoints object of the unstructured grid will have data type VTK_FLOAT if input is not of type vtkPointSet, otherwise it will have same data type than the input point set.

It is assumed the different DataSets have the same field arrays. If the name of a global point ID array is provided, this class will refrain from including duplicate points in the merged Ugrid. This class differs from vtkAppendFilter in these ways: (1) it uses less memory than that class (which uses memory equal to twice the size of the final Ugrid) but requires that you know the size of the final Ugrid in advance (2) this class assumes the individual DataSets have the same field arrays, while vtkAppendFilter intersects the field arrays (3) this class knows duplicate points may be appearing in the DataSets and can filter those out, (4) this class is not a filter.

Definition at line 62 of file vtkMergeCells.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkMergeCells.h.

Constructor & Destructor Documentation

◆ vtkMergeCells()

vtkMergeCells::vtkMergeCells ( )
protected

◆ ~vtkMergeCells()

vtkMergeCells::~vtkMergeCells ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkMergeCells::IsA ( const char *  name)
virtual

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

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMergeCells::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkMergeCells* vtkMergeCells::NewInstance ( ) const

◆ PrintSelf()

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

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

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

Reimplemented from vtkObject.

◆ New()

static vtkMergeCells* vtkMergeCells::New ( )
static

◆ SetUnstructuredGrid()

virtual void vtkMergeCells::SetUnstructuredGrid ( vtkUnstructuredGrid )
virtual

Set the vtkUnstructuredGrid object that will become the union of the DataSets specified in MergeDataSet calls.

vtkMergeCells assumes this grid is empty at first.

◆ GetUnstructuredGrid()

virtual vtkUnstructuredGrid* vtkMergeCells::GetUnstructuredGrid ( )
virtual

◆ SetTotalNumberOfCells()

virtual void vtkMergeCells::SetTotalNumberOfCells ( vtkIdType  )
virtual

Specify the total number of cells in the final vtkUnstructuredGrid.

Make this call before any call to MergeDataSet().

◆ GetTotalNumberOfCells()

virtual vtkIdType vtkMergeCells::GetTotalNumberOfCells ( )
virtual

◆ SetTotalNumberOfPoints()

virtual void vtkMergeCells::SetTotalNumberOfPoints ( vtkIdType  )
virtual

Specify the total number of points in the final vtkUnstructuredGrid Make this call before any call to MergeDataSet().

This is an upper bound, since some points may be duplicates.

◆ GetTotalNumberOfPoints()

virtual vtkIdType vtkMergeCells::GetTotalNumberOfPoints ( )
virtual

◆ SetUseGlobalIds()

virtual void vtkMergeCells::SetUseGlobalIds ( int  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets.

This is done most efficiently if a global point ID field array is available. Set the name of the point array if you have one.

◆ GetUseGlobalIds()

virtual int vtkMergeCells::GetUseGlobalIds ( )
virtual

◆ UseGlobalIdsOn()

virtual void vtkMergeCells::UseGlobalIdsOn ( )
virtual

◆ UseGlobalIdsOff()

virtual void vtkMergeCells::UseGlobalIdsOff ( )
virtual

◆ SetPointMergeTolerance()

virtual void vtkMergeCells::SetPointMergeTolerance ( double  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets.

If no global point ID field array name is provided, it will use a point locator to find duplicate points. You can set a tolerance for that locator here. The default tolerance is 10e-4.

◆ GetPointMergeTolerance()

virtual double vtkMergeCells::GetPointMergeTolerance ( )
virtual

◆ SetUseGlobalCellIds()

virtual void vtkMergeCells::SetUseGlobalCellIds ( int  )
virtual

vtkMergeCells will detect and filter out duplicate cells if you provide it the name of a global cell ID array.

◆ GetUseGlobalCellIds()

virtual int vtkMergeCells::GetUseGlobalCellIds ( )
virtual

◆ UseGlobalCellIdsOn()

virtual void vtkMergeCells::UseGlobalCellIdsOn ( )
virtual

◆ UseGlobalCellIdsOff()

virtual void vtkMergeCells::UseGlobalCellIdsOff ( )
virtual

◆ SetMergeDuplicatePoints()

virtual void vtkMergeCells::SetMergeDuplicatePoints ( bool  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets.

If for some reason you don't want it to do this, than MergeDuplicatePointsOff().

◆ GetMergeDuplicatePoints()

virtual bool vtkMergeCells::GetMergeDuplicatePoints ( )
virtual

◆ MergeDuplicatePointsOn()

virtual void vtkMergeCells::MergeDuplicatePointsOn ( )
virtual

◆ MergeDuplicatePointsOff()

virtual void vtkMergeCells::MergeDuplicatePointsOff ( )
virtual

◆ InvalidateCachedLocator()

void vtkMergeCells::InvalidateCachedLocator ( )

Clear the Locator and set it to nullptr.

◆ SetTotalNumberOfDataSets()

virtual void vtkMergeCells::SetTotalNumberOfDataSets ( int  )
virtual

We need to know the number of different data sets that will be merged into one so we can pre-allocate some arrays.

This can be an upper bound, not necessarily exact.

◆ GetTotalNumberOfDataSets()

virtual int vtkMergeCells::GetTotalNumberOfDataSets ( )
virtual

◆ MergeDataSet()

int vtkMergeCells::MergeDataSet ( vtkDataSet set)

Provide a DataSet to be merged in to the final UnstructuredGrid.

This call returns after the merge has completed. Be sure to call SetTotalNumberOfCells, SetTotalNumberOfPoints, and SetTotalNumberOfDataSets before making this call. Return 0 if OK, -1 if error.

◆ SetOutputPointsPrecision()

virtual void vtkMergeCells::SetOutputPointsPrecision ( int  )
virtual

Set/get the desired precision for the output points.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

virtual int vtkMergeCells::GetOutputPointsPrecision ( )
virtual

◆ Finish()

void vtkMergeCells::Finish ( )

Call Finish() after merging last DataSet to free unneeded memory and to make sure the ugrid's GetNumberOfPoints() reflects the actual number of points set, not the number allocated.

◆ FreeLists()

void vtkMergeCells::FreeLists ( )
protected

◆ StartUGrid()

void vtkMergeCells::StartUGrid ( vtkDataSet set)
protected

◆ MapPointsToIdsUsingGlobalIds()

vtkIdType* vtkMergeCells::MapPointsToIdsUsingGlobalIds ( vtkDataSet set)
protected

◆ MapPointsToIdsUsingLocator()

vtkIdType* vtkMergeCells::MapPointsToIdsUsingLocator ( vtkDataSet set)
protected

◆ AddNewCellsUnstructuredGrid()

vtkIdType vtkMergeCells::AddNewCellsUnstructuredGrid ( vtkDataSet set,
vtkIdType idMap 
)
protected

◆ AddNewCellsDataSet()

vtkIdType vtkMergeCells::AddNewCellsDataSet ( vtkDataSet set,
vtkIdType idMap 
)
protected

Member Data Documentation

◆ TotalNumberOfDataSets

int vtkMergeCells::TotalNumberOfDataSets
protected

Definition at line 195 of file vtkMergeCells.h.

◆ TotalNumberOfCells

vtkIdType vtkMergeCells::TotalNumberOfCells
protected

Definition at line 197 of file vtkMergeCells.h.

◆ TotalNumberOfPoints

vtkIdType vtkMergeCells::TotalNumberOfPoints
protected

Definition at line 198 of file vtkMergeCells.h.

◆ NumberOfCells

vtkIdType vtkMergeCells::NumberOfCells
protected

Definition at line 200 of file vtkMergeCells.h.

◆ NumberOfPoints

vtkIdType vtkMergeCells::NumberOfPoints
protected

Definition at line 201 of file vtkMergeCells.h.

◆ UseGlobalIds

int vtkMergeCells::UseGlobalIds
protected

Definition at line 203 of file vtkMergeCells.h.

◆ UseGlobalCellIds

int vtkMergeCells::UseGlobalCellIds
protected

Definition at line 204 of file vtkMergeCells.h.

◆ PointMergeTolerance

double vtkMergeCells::PointMergeTolerance
protected

Definition at line 206 of file vtkMergeCells.h.

◆ MergeDuplicatePoints

bool vtkMergeCells::MergeDuplicatePoints
protected

Definition at line 207 of file vtkMergeCells.h.

◆ OutputPointsPrecision

int vtkMergeCells::OutputPointsPrecision = vtkAlgorithm::DEFAULT_PRECISION
protected

Definition at line 209 of file vtkMergeCells.h.

◆ InputIsUGrid

char vtkMergeCells::InputIsUGrid
protected

Definition at line 211 of file vtkMergeCells.h.

◆ InputIsPointSet

char vtkMergeCells::InputIsPointSet
protected

Definition at line 212 of file vtkMergeCells.h.

◆ GlobalIdMap

vtkMergeCellsSTLCloak* vtkMergeCells::GlobalIdMap
protected

Definition at line 214 of file vtkMergeCells.h.

◆ GlobalCellIdMap

vtkMergeCellsSTLCloak* vtkMergeCells::GlobalCellIdMap
protected

Definition at line 215 of file vtkMergeCells.h.

◆ PointList

vtkDataSetAttributes::FieldList* vtkMergeCells::PointList
protected

Definition at line 217 of file vtkMergeCells.h.

◆ CellList

vtkDataSetAttributes::FieldList* vtkMergeCells::CellList
protected

Definition at line 218 of file vtkMergeCells.h.

◆ UnstructuredGrid

vtkUnstructuredGrid* vtkMergeCells::UnstructuredGrid
protected

Definition at line 220 of file vtkMergeCells.h.

◆ NextGrid

int vtkMergeCells::NextGrid
protected

Definition at line 222 of file vtkMergeCells.h.

◆ Locator

vtkSmartPointer<vtkIncrementalPointLocator> vtkMergeCells::Locator
protected

Definition at line 224 of file vtkMergeCells.h.


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