vtkDistributedDataFilter - Distribute data among processors More...

Inheritance diagram for Kitware.VTK.vtkDistributedDataFilter:

Collaboration diagram for Kitware.VTK.vtkDistributedDataFilter:

Public Types
enum	BoundaryModes { ASSIGN_TO_ALL_INTERSECTING_REGIONS = 1, ASSIGN_TO_ONE_REGION = 0, SPLIT_BOUNDARY_CELLS = 2 }
	Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off. More...

Public Member Functions
	vtkDistributedDataFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkDistributedDataFilter ()
	*Undocumented Block
virtual void	ClipCellsOff ()
	Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.
virtual void	ClipCellsOn ()
	Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.
int	GetBoundaryMode ()
	Handling of ClipCells and IncludeAllIntersectingCells.
virtual int	GetClipCells ()
	Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.
virtual vtkMultiProcessController	GetController ()
	Set/Get the communicator object.
vtkBSPCuts	GetCuts ()
	You can set the k-d tree decomposition, rather than have D3 compute it. This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:
virtual int	GetIncludeAllIntersectingCells ()
	Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.
vtkPKdTree	GetKdtree ()
	Get a pointer to the parallel k-d tree object. Required for changing default behavior for region assignment, changing default depth of tree, or other tree building default parameters. See vtkPKdTree and vtkKdTree for more information about these options. NOTE: Changing the tree returned by this method does NOT change the d3 filter. Make sure to call Modified() on the d3 object if you want it to re-execute.
virtual int	GetRetainKdtree ()
	When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.
virtual int	GetTiming ()
	Turn on collection of timing data.
virtual int	GetUseMinimalMemory ()
	This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.
virtual void	IncludeAllIntersectingCellsOff ()
	Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.
virtual void	IncludeAllIntersectingCellsOn ()
	Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.
override int	IsA (string type)
	*Undocumented Block
new vtkDistributedDataFilter	NewInstance ()
	*Undocumented Block
virtual void	RetainKdtreeOff ()
	When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.
virtual void	RetainKdtreeOn ()
	When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.
void	SetBoundaryMode (int mode)
	Handling of ClipCells and IncludeAllIntersectingCells.
void	SetBoundaryModeToAssignToAllIntersectingRegions ()
	Handling of ClipCells and IncludeAllIntersectingCells.
void	SetBoundaryModeToAssignToOneRegion ()
	Handling of ClipCells and IncludeAllIntersectingCells.
void	SetBoundaryModeToSplitBoundaryCells ()
	Handling of ClipCells and IncludeAllIntersectingCells.
virtual void	SetClipCells (int _arg)
	Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.
void	SetController (vtkMultiProcessController c)
	Set/Get the communicator object.
void	SetCuts (vtkBSPCuts cuts)
	You can set the k-d tree decomposition, rather than have D3 compute it. This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:
virtual void	SetIncludeAllIntersectingCells (int _arg)
	Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.
virtual void	SetRetainKdtree (int _arg)
	When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.
virtual void	SetTiming (int _arg)
	Turn on collection of timing data.
virtual void	SetUseMinimalMemory (int _arg)
	This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.
void	SetUserRegionAssignments (IntPtr map, int numRegions)
	vtkBSPCuts doesn't have information about process assignments for the cuts. Typically D3 filter simply reassigns the processes for each cut. However, that may not always work, sometimes the processes have be pre-assigned and we want to preserve that partitioning. In that case, one sets the region assignments explicitly. Look at vtkPKdTree::AssignRegions for details about the arguments. Calling SetUserRegionAssignments(NULL, 0) will revert to default behavior i.e. letting the KdTree come up with the assignments.
virtual void	TimingOff ()
	Turn on collection of timing data.
virtual void	TimingOn ()
	Turn on collection of timing data.
virtual void	UseMinimalMemoryOff ()
	This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.
virtual void	UseMinimalMemoryOn ()
	This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.
Public Member Functions inherited from Kitware.VTK.vtkDataObjectAlgorithm
	vtkDataObjectAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkDataObjectAlgorithm ()
	*Undocumented Block
void	AddInput (vtkDataObject arg0)
	Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
void	AddInput (int arg0, vtkDataObject arg1)
	Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
vtkDataObject	GetInput ()
	this method is not recommended for use, but lots of old style filters use it
vtkDataObject	GetInput (int port)
	this method is not recommended for use, but lots of old style filters use it
vtkDataObject	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkDataObject	GetOutput (int arg0)
	Get the output data object for a port on this algorithm.
void	SetInput (vtkDataObject arg0)
	Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void	SetInput (int arg0, vtkDataObject arg1)
	Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
virtual void	SetOutput (vtkDataObject d)
	Get the output data object for a port on this algorithm.
Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
	vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkAlgorithm ()
	*Undocumented Block
override void	Register (vtkObjectBase o)
	Participate in garbage collection.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput input)
	Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void	AddInputConnection (vtkAlgorithmOutput input)
	Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double	ComputePriority ()
	Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void	ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint	GetErrorCode ()
	The error code contains a possible error that occured while reading or writing the file.
vtkExecutive	GetExecutive ()
	Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation	GetInformation ()
	Set/Get the information object associated with this algorithm.
vtkInformation	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkDataObject	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation	GetInputPortInformation (int port)
	Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a 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.
vtkDataObject	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput	GetOutputPort ()
	Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation	GetOutputPortInformation (int port)
	Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double	GetProgress ()
	Set/Get the execution progress of a process object.
virtual double	GetProgressMaxValue ()
	Set/Get the execution progress of a process object.
virtual double	GetProgressMinValue ()
	Set/Get the execution progress of a process object.
virtual string	GetProgressText ()
	Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. This will NOT create a default executive.
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. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
	Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void	ReleaseDataFlagOff ()
	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	RemoveAllInputs ()
	Remove all the input data.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput input)
	Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void	SetAbortExecute (int _arg)
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	SetExecutive (vtkExecutive executive)
	Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void	SetInformation (vtkInformation arg0)
	Set/Get the information object associated with this algorithm.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, vtkInformation info)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
	String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void	SetInputConnection (int port, vtkAlgorithmOutput input)
	Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void	SetInputConnection (vtkAlgorithmOutput input)
	Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void	SetProgress (double _arg)
	Set/Get the execution progress of a process object.
void	SetProgressText (string ptext)
	Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void	SetReleaseDataFlag (int arg0)
	Turn release data flag on or off for all output ports.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
int	UpdateExtentIsEmpty (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. The source uses this call to determine whether to call Execute.
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. The source uses this call to determine whether to call Execute.
virtual void	UpdateInformation ()
	Backward compatibility method to invoke UpdateInformation on executive.
void	UpdateProgress (double amount)
	Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkDistributedDataFilter	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkDistributedDataFilter	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkDistributedDataFilter"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkDataObjectAlgorithm
Public Attributes inherited from Kitware.VTK.vtkAlgorithm
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "24vtkDistributedDataFilter"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkDataObjectAlgorithm
Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkDistributedDataFilter ()
	Automatically generated type registration mechanics.

Detailed Description

vtkDistributedDataFilter - Distribute data among processors

Description This filter redistributes data among processors in a parallel application into spatially contiguous vtkUnstructuredGrids. The execution model anticipated is that all processes read in part of a large vtkDataSet. Each process sets the input of filter to be that DataSet. When executed, this filter builds in parallel a k-d tree, decomposing the space occupied by the distributed DataSet into spatial regions. It assigns each spatial region to a processor. The data is then redistributed and the output is a single vtkUnstructuredGrid containing the cells in the process' assigned regions.

This filter is sometimes called "D3" for "distributed data decomposition".

Enhancement: You can set the k-d tree decomposition, rather than have D3 compute it. This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:

vtkBSPCuts *cuts = D3Object1->GetCuts()

And set it this way:

D3Object2->SetCuts(cuts)

It is desirable to have a field array of global node IDs for two reasons:

When merging together sub grids that were distributed across processors, global node IDs can be used to remove duplicate points and significantly reduce the size of the resulting output grid. If no such array is available, D3 will use a tolerance to merge points, which is much slower.
If ghost cells have been requested, D3 requires a global node ID array in order to request and transfer ghost cells in parallel among the processors. If there is no global node ID array, D3 will in parallel create a global node ID array, and the time to do this can be significant.

If you know the name of a global node ID array in the input dataset, set that name with this method. If you leave it unset, D3 will search the input data set for certain common names of global node ID arrays. If none is found, and ghost cells have been requested, D3 will create a temporary global node ID array before aquiring ghost cells. It is also desirable to have global element IDs. However, if they don't exist D3 can create them relatively quickly. Set the name of the global element ID array if you have it. If it is not set, D3 will search for it using common names. If still not found, D3 will create a temporary array of global element IDs.

Caveats The Execute() method must be called by all processes in the parallel application, or it will hang. If you are not certain that your pipeline will execute identically on all processors, you may want to use this filter in an explicit execution mode.

vtkKdTree vtkPKdTree vtkBSPCuts

Member Enumeration Documentation

enum Kitware.VTK.vtkDistributedDataFilter.BoundaryModes

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.

Enumerator:

ASSIGN_TO_ALL_INTERSECTING_REGIONS	enum member
ASSIGN_TO_ONE_REGION	enum member
SPLIT_BOUNDARY_CELLS	enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkDistributedDataFilter.vtkDistributedDataFilter ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkDistributedDataFilter.vtkDistributedDataFilter	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkDistributedDataFilter.vtkDistributedDataFilter ( )

*Undocumented Block

Member Function Documentation

virtual void Kitware.VTK.vtkDistributedDataFilter.ClipCellsOff ( )

virtual

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.

virtual void Kitware.VTK.vtkDistributedDataFilter.ClipCellsOn ( )

virtual

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.

override void Kitware.VTK.vtkDistributedDataFilter.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

int Kitware.VTK.vtkDistributedDataFilter.GetBoundaryMode ( )

Handling of ClipCells and IncludeAllIntersectingCells.

virtual int Kitware.VTK.vtkDistributedDataFilter.GetClipCells ( )

virtual

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.

virtual vtkMultiProcessController Kitware.VTK.vtkDistributedDataFilter.GetController ( )

virtual

Set/Get the communicator object.

Here is the call graph for this function:

vtkBSPCuts Kitware.VTK.vtkDistributedDataFilter.GetCuts ( )

You can set the k-d tree decomposition, rather than have D3 compute it. This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:

vtkBSPCuts *cuts = D3Object1->GetCuts()

And set it this way:

D3Object2->SetCuts(cuts)

Here is the call graph for this function:

virtual int Kitware.VTK.vtkDistributedDataFilter.GetIncludeAllIntersectingCells ( )

virtual

Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.

vtkPKdTree Kitware.VTK.vtkDistributedDataFilter.GetKdtree ( )

Get a pointer to the parallel k-d tree object. Required for changing default behavior for region assignment, changing default depth of tree, or other tree building default parameters. See vtkPKdTree and vtkKdTree for more information about these options. NOTE: Changing the tree returned by this method does NOT change the d3 filter. Make sure to call Modified() on the d3 object if you want it to re-execute.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkDistributedDataFilter.GetRetainKdtree ( )

virtual

When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.

virtual int Kitware.VTK.vtkDistributedDataFilter.GetTiming ( )

virtual

Turn on collection of timing data.

virtual int Kitware.VTK.vtkDistributedDataFilter.GetUseMinimalMemory ( )

virtual

This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.

virtual void Kitware.VTK.vtkDistributedDataFilter.IncludeAllIntersectingCellsOff ( )

virtual

Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.

virtual void Kitware.VTK.vtkDistributedDataFilter.IncludeAllIntersectingCellsOn ( )

virtual

Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.

override int Kitware.VTK.vtkDistributedDataFilter.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

static new int Kitware.VTK.vtkDistributedDataFilter.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

static new vtkDistributedDataFilter Kitware.VTK.vtkDistributedDataFilter.New ( )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

new vtkDistributedDataFilter Kitware.VTK.vtkDistributedDataFilter.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

virtual void Kitware.VTK.vtkDistributedDataFilter.RetainKdtreeOff ( )

virtual

When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.

virtual void Kitware.VTK.vtkDistributedDataFilter.RetainKdtreeOn ( )

virtual

When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.

static new vtkDistributedDataFilter Kitware.VTK.vtkDistributedDataFilter.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

Here is the call graph for this function:

void Kitware.VTK.vtkDistributedDataFilter.SetBoundaryMode ( int mode )

Handling of ClipCells and IncludeAllIntersectingCells.

void Kitware.VTK.vtkDistributedDataFilter.SetBoundaryModeToAssignToAllIntersectingRegions ( )

Handling of ClipCells and IncludeAllIntersectingCells.

void Kitware.VTK.vtkDistributedDataFilter.SetBoundaryModeToAssignToOneRegion ( )

Handling of ClipCells and IncludeAllIntersectingCells.

void Kitware.VTK.vtkDistributedDataFilter.SetBoundaryModeToSplitBoundaryCells ( )

Handling of ClipCells and IncludeAllIntersectingCells.

virtual void Kitware.VTK.vtkDistributedDataFilter.SetClipCells ( int _arg )

virtual

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. By default this is off.

void Kitware.VTK.vtkDistributedDataFilter.SetController ( vtkMultiProcessController c )

Set/Get the communicator object.

void Kitware.VTK.vtkDistributedDataFilter.SetCuts ( vtkBSPCuts cuts )

You can set the k-d tree decomposition, rather than have D3 compute it. This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:

vtkBSPCuts *cuts = D3Object1->GetCuts()

And set it this way:

D3Object2->SetCuts(cuts)

virtual void Kitware.VTK.vtkDistributedDataFilter.SetIncludeAllIntersectingCells ( int _arg )

virtual

Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.

virtual void Kitware.VTK.vtkDistributedDataFilter.SetRetainKdtree ( int _arg )

virtual

When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.

virtual void Kitware.VTK.vtkDistributedDataFilter.SetTiming ( int _arg )

virtual

Turn on collection of timing data.

virtual void Kitware.VTK.vtkDistributedDataFilter.SetUseMinimalMemory ( int _arg )

virtual

This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.

void Kitware.VTK.vtkDistributedDataFilter.SetUserRegionAssignments	(	IntPtr	map,
		int	numRegions
	)

vtkBSPCuts doesn't have information about process assignments for the cuts. Typically D3 filter simply reassigns the processes for each cut. However, that may not always work, sometimes the processes have be pre-assigned and we want to preserve that partitioning. In that case, one sets the region assignments explicitly. Look at vtkPKdTree::AssignRegions for details about the arguments. Calling SetUserRegionAssignments(NULL, 0) will revert to default behavior i.e. letting the KdTree come up with the assignments.

virtual void Kitware.VTK.vtkDistributedDataFilter.TimingOff ( )

virtual

Turn on collection of timing data.

virtual void Kitware.VTK.vtkDistributedDataFilter.TimingOn ( )

virtual

Turn on collection of timing data.

virtual void Kitware.VTK.vtkDistributedDataFilter.UseMinimalMemoryOff ( )

virtual

This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.

virtual void Kitware.VTK.vtkDistributedDataFilter.UseMinimalMemoryOn ( )

virtual

This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.