VTK  9.4.20241108
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGridProbeFilter Class Reference

Probe a vtkHyperTreeGrid. More...

#include <vtkHyperTreeGridProbeFilter.h>

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

Public Types

typedef vtkDataSetAlgorithm Superclass
 
- Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkHyperTreeGridProbeFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the data set that will be probed at the input points.
 
void SetSourceData (vtkHyperTreeGrid *source)
 Specify the data set that will be probed at the input points.
 
vtkHyperTreeGridGetSource ()
 Specify the data set that will be probed at the input points.
 
virtual vtkHyperTreeGridLocatorGetLocator ()
 Set and get the locator object.
 
virtual void SetLocator (vtkHyperTreeGridLocator *)
 Set and get the locator object.
 
virtual void SetPassCellArrays (bool)
 Shallow copy the input cell data arrays to the output.
 
virtual void PassCellArraysOn ()
 Shallow copy the input cell data arrays to the output.
 
virtual void PassCellArraysOff ()
 Shallow copy the input cell data arrays to the output.
 
virtual bool GetPassCellArrays ()
 Shallow copy the input cell data arrays to the output.
 
virtual void SetPassPointArrays (bool)
 Shallow copy the input point data arrays to the output Off by default.
 
virtual void PassPointArraysOn ()
 Shallow copy the input point data arrays to the output Off by default.
 
virtual void PassPointArraysOff ()
 Shallow copy the input point data arrays to the output Off by default.
 
virtual bool GetPassPointArrays ()
 Shallow copy the input point data arrays to the output Off by default.
 
virtual void SetPassFieldArrays (bool)
 Set whether to pass the field-data arrays from the Input i.e.
 
virtual void PassFieldArraysOn ()
 Set whether to pass the field-data arrays from the Input i.e.
 
virtual void PassFieldArraysOff ()
 Set whether to pass the field-data arrays from the Input i.e.
 
virtual bool GetPassFieldArrays ()
 Set whether to pass the field-data arrays from the Input i.e.
 
virtual void SetValidPointMaskArrayName (std::string)
 Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.
 
virtual std::string GetValidPointMaskArrayName ()
 Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.
 
vtkIdTypeArrayGetValidPoints ()
 Get the list of point ids in the output that contain attribute data from the source.
 
virtual void SetTolerance (double)
 Get/Set tolerance used when finding points in the HTG source.
 
virtual double GetTolerance ()
 Get/Set tolerance used when finding points in the HTG source.
 
virtual void SetComputeTolerance (bool)
 Get/Set whether or not to compute the tolerance automatically for when finding points in the HTG source.
 
virtual bool GetComputeTolerance ()
 Get/Set whether or not to compute the tolerance automatically for when finding points in the HTG source.
 
virtual void SetUseImplicitArrays (bool)
 Get/Set wether or not the filter should use implicit arrays.
 
virtual bool GetUseImplicitArrays ()
 Get/Set wether or not the filter should use implicit arrays.
 
virtual void UseImplicitArraysOn ()
 Get/Set wether or not the filter should use implicit arrays.
 
virtual void UseImplicitArraysOff ()
 Get/Set wether or not the filter should use implicit arrays.
 
- Public Member Functions inherited from vtkDataSetAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataSetAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkDataObjectGetInput ()
 Get the input data object.
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData.
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as vtkStructuredPoints.
 
vtkImageDataGetImageDataOutput ()
 Get the output as vtkStructuredPoints.
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid.
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid.
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as vtkRectilinearGrid.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkDataSetGetOutput (int)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (vtkDataSet *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual VTK_UNBLOCKTHREADS void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridProbeFilterSafeDownCast (vtkObjectBase *o)
 
static vtkHyperTreeGridProbeFilterNew ()
 
- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
void DealWithRemoteHandles (vtkIdList *remotePointIds, vtkIdList *remoteHandles, vtkIdList *totHandles)
 Helper method for dealing with handles coming from remote locations during the reduce operation.
 
void Finalize (vtkHyperTreeGrid *source, vtkDataSet *output, vtkIdType nanId)
 Instantiate and set implicit arrays.
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Methods for processing requests.
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Methods for processing requests.
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Methods for processing requests.
 
int FillInputPortInformation (int, vtkInformation *) override
 Input port should have 2 inputs: input (a dataset) and a source (an HTG).
 
bool Initialize (vtkDataSet *input, vtkHyperTreeGrid *source, vtkDataSet *output)
 Helper method for initializing the output and local arrays for all processes.
 
bool PassAttributeData (vtkDataSet *input, vtkDataSet *output)
 Helper method for passing data from input to output.
 
bool DoProbing (vtkDataSet *input, vtkHyperTreeGrid *source, vtkDataSet *output, vtkIdList *localPointIds)
 Helper method for performing the probing.
 
virtual bool Reduce (vtkHyperTreeGrid *source, vtkDataSet *output, vtkIdList *localPointIds)
 Helper method for reducing the data after probing.
 
void DealWithRemote (vtkIdList *remotePointIds, vtkDataSet *remoteOutput, vtkHyperTreeGrid *source, vtkDataSet *totOutput)
 Helper method for dealing with arrays coming from remote locations during the reduce operation.
 
- Protected Member Functions inherited from vtkDataSetAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information.
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks the algorithm to do its work.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkHyperTreeGridLocatorLocator
 
bool PassCellArrays = false
 
bool PassPointArrays = false
 
bool PassFieldArrays = true
 
double Tolerance = 0.0
 
bool ComputeTolerance = true
 
std::string ValidPointMaskArrayName = "vtkValidPointMask"
 
vtkNew< vtkIdTypeArrayValidPoints
 
vtkSmartPointer< vtkCharArrayMaskPoints
 
bool UseImplicitArrays = false
 
vtkSmartPointer< vtkIdListHandles
 Used to store vtkIndexedArray handles when UseImplicitArrays is on.
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Probe a vtkHyperTreeGrid.

Heavily modeled after the vtkProbeFilter, this class is meant to be used to probe vtkHyperTreeGrid objects.

This class can use two different strategies to store data arrays on the output :

Note
The implicit array strategy is not available in distributed yet.
See also
vtkPHyperTreeGridProbeFilter
Tests:
vtkHyperTreeGridProbeFilter (Tests)

Definition at line 42 of file vtkHyperTreeGridProbeFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkHyperTreeGridProbeFilter.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridProbeFilter()

vtkHyperTreeGridProbeFilter::vtkHyperTreeGridProbeFilter ( )
protected

Construction methods.

◆ ~vtkHyperTreeGridProbeFilter()

vtkHyperTreeGridProbeFilter::~vtkHyperTreeGridProbeFilter ( )
overrideprotected

Construction methods.

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkHyperTreeGridProbeFilter::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 vtkDataSetAlgorithm.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHyperTreeGridProbeFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ NewInstance()

vtkHyperTreeGridProbeFilter * vtkHyperTreeGridProbeFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkHyperTreeGridProbeFilter::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 vtkDataSetAlgorithm.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ New()

static vtkHyperTreeGridProbeFilter * vtkHyperTreeGridProbeFilter::New ( )
static

◆ SetSourceData()

void vtkHyperTreeGridProbeFilter::SetSourceData ( vtkHyperTreeGrid source)

Specify the data set that will be probed at the input points.

The Input gives the geometry (the points and cells) for the output, while the Source is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ GetSource()

vtkHyperTreeGrid * vtkHyperTreeGridProbeFilter::GetSource ( )

Specify the data set that will be probed at the input points.

The Input gives the geometry (the points and cells) for the output, while the Source is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ SetSourceConnection()

void vtkHyperTreeGridProbeFilter::SetSourceConnection ( vtkAlgorithmOutput algOutput)

Specify the data set that will be probed at the input points.

The Input gives the geometry (the points and cells) for the output, while the Source is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ GetLocator()

virtual vtkHyperTreeGridLocator * vtkHyperTreeGridProbeFilter::GetLocator ( )
virtual

Set and get the locator object.

◆ SetLocator()

virtual void vtkHyperTreeGridProbeFilter::SetLocator ( vtkHyperTreeGridLocator )
virtual

Set and get the locator object.

◆ SetPassCellArrays()

virtual void vtkHyperTreeGridProbeFilter::SetPassCellArrays ( bool  )
virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ PassCellArraysOn()

virtual void vtkHyperTreeGridProbeFilter::PassCellArraysOn ( )
virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ PassCellArraysOff()

virtual void vtkHyperTreeGridProbeFilter::PassCellArraysOff ( )
virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ GetPassCellArrays()

virtual bool vtkHyperTreeGridProbeFilter::GetPassCellArrays ( )
virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ SetPassPointArrays()

virtual void vtkHyperTreeGridProbeFilter::SetPassPointArrays ( bool  )
virtual

Shallow copy the input point data arrays to the output Off by default.

◆ PassPointArraysOn()

virtual void vtkHyperTreeGridProbeFilter::PassPointArraysOn ( )
virtual

Shallow copy the input point data arrays to the output Off by default.

◆ PassPointArraysOff()

virtual void vtkHyperTreeGridProbeFilter::PassPointArraysOff ( )
virtual

Shallow copy the input point data arrays to the output Off by default.

◆ GetPassPointArrays()

virtual bool vtkHyperTreeGridProbeFilter::GetPassPointArrays ( )
virtual

Shallow copy the input point data arrays to the output Off by default.

◆ SetPassFieldArrays()

virtual void vtkHyperTreeGridProbeFilter::SetPassFieldArrays ( bool  )
virtual

Set whether to pass the field-data arrays from the Input i.e.

the input providing the geometry to the output. On by default.

◆ PassFieldArraysOn()

virtual void vtkHyperTreeGridProbeFilter::PassFieldArraysOn ( )
virtual

Set whether to pass the field-data arrays from the Input i.e.

the input providing the geometry to the output. On by default.

◆ PassFieldArraysOff()

virtual void vtkHyperTreeGridProbeFilter::PassFieldArraysOff ( )
virtual

Set whether to pass the field-data arrays from the Input i.e.

the input providing the geometry to the output. On by default.

◆ GetPassFieldArrays()

virtual bool vtkHyperTreeGridProbeFilter::GetPassFieldArrays ( )
virtual

Set whether to pass the field-data arrays from the Input i.e.

the input providing the geometry to the output. On by default.

◆ SetValidPointMaskArrayName()

virtual void vtkHyperTreeGridProbeFilter::SetValidPointMaskArrayName ( std::string  )
virtual

Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.

Set to "vtkValidPointMask" by default.

◆ GetValidPointMaskArrayName()

virtual std::string vtkHyperTreeGridProbeFilter::GetValidPointMaskArrayName ( )
virtual

Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.

Set to "vtkValidPointMask" by default.

◆ GetValidPoints()

vtkIdTypeArray * vtkHyperTreeGridProbeFilter::GetValidPoints ( )

Get the list of point ids in the output that contain attribute data from the source.

◆ SetTolerance()

virtual void vtkHyperTreeGridProbeFilter::SetTolerance ( double  )
virtual

Get/Set tolerance used when finding points in the HTG source.

Overridden when ComputeTolerance == true.

Default is 0.0

◆ GetTolerance()

virtual double vtkHyperTreeGridProbeFilter::GetTolerance ( )
virtual

Get/Set tolerance used when finding points in the HTG source.

Overridden when ComputeTolerance == true.

Default is 0.0

◆ SetComputeTolerance()

virtual void vtkHyperTreeGridProbeFilter::SetComputeTolerance ( bool  )
virtual

Get/Set whether or not to compute the tolerance automatically for when finding points in the HTG source.

If false use the tolerance from SetTolerance .

Default is true

◆ GetComputeTolerance()

virtual bool vtkHyperTreeGridProbeFilter::GetComputeTolerance ( )
virtual

Get/Set whether or not to compute the tolerance automatically for when finding points in the HTG source.

If false use the tolerance from SetTolerance .

Default is true

◆ SetUseImplicitArrays()

virtual void vtkHyperTreeGridProbeFilter::SetUseImplicitArrays ( bool  )
virtual

Get/Set wether or not the filter should use implicit arrays.

If set to true, probed values will not be copied to the output but retrieved from the source through indexation (thanks to indexed arrays). This can lower the memory consumption, especially if the probed source contains a lot of data arrays. Note that it will also increase the computation time.

Warning
This option is disabled in distributed. It can be made available once vtkHyperTreeGrids are able to generate global IDs (and vtkHyperTreeGridLocator able to use them).
See also
vtkPHyperTreeGridProbeFilter

◆ GetUseImplicitArrays()

virtual bool vtkHyperTreeGridProbeFilter::GetUseImplicitArrays ( )
virtual

Get/Set wether or not the filter should use implicit arrays.

If set to true, probed values will not be copied to the output but retrieved from the source through indexation (thanks to indexed arrays). This can lower the memory consumption, especially if the probed source contains a lot of data arrays. Note that it will also increase the computation time.

Warning
This option is disabled in distributed. It can be made available once vtkHyperTreeGrids are able to generate global IDs (and vtkHyperTreeGridLocator able to use them).
See also
vtkPHyperTreeGridProbeFilter

◆ UseImplicitArraysOn()

virtual void vtkHyperTreeGridProbeFilter::UseImplicitArraysOn ( )
virtual

Get/Set wether or not the filter should use implicit arrays.

If set to true, probed values will not be copied to the output but retrieved from the source through indexation (thanks to indexed arrays). This can lower the memory consumption, especially if the probed source contains a lot of data arrays. Note that it will also increase the computation time.

Warning
This option is disabled in distributed. It can be made available once vtkHyperTreeGrids are able to generate global IDs (and vtkHyperTreeGridLocator able to use them).
See also
vtkPHyperTreeGridProbeFilter

◆ UseImplicitArraysOff()

virtual void vtkHyperTreeGridProbeFilter::UseImplicitArraysOff ( )
virtual

Get/Set wether or not the filter should use implicit arrays.

If set to true, probed values will not be copied to the output but retrieved from the source through indexation (thanks to indexed arrays). This can lower the memory consumption, especially if the probed source contains a lot of data arrays. Note that it will also increase the computation time.

Warning
This option is disabled in distributed. It can be made available once vtkHyperTreeGrids are able to generate global IDs (and vtkHyperTreeGridLocator able to use them).
See also
vtkPHyperTreeGridProbeFilter

◆ RequestInformation()

int vtkHyperTreeGridProbeFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Methods for processing requests.

Reimplemented from vtkDataSetAlgorithm.

◆ RequestData()

int vtkHyperTreeGridProbeFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Methods for processing requests.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ RequestUpdateExtent()

int vtkHyperTreeGridProbeFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Methods for processing requests.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ FillInputPortInformation()

int vtkHyperTreeGridProbeFilter::FillInputPortInformation ( int  ,
vtkInformation  
)
overrideprotectedvirtual

Input port should have 2 inputs: input (a dataset) and a source (an HTG).

Output should be same as input

Reimplemented from vtkDataSetAlgorithm.

◆ Initialize()

bool vtkHyperTreeGridProbeFilter::Initialize ( vtkDataSet input,
vtkHyperTreeGrid source,
vtkDataSet output 
)
protected

Helper method for initializing the output and local arrays for all processes.

◆ PassAttributeData()

bool vtkHyperTreeGridProbeFilter::PassAttributeData ( vtkDataSet input,
vtkDataSet output 
)
protected

Helper method for passing data from input to output.

◆ DoProbing()

bool vtkHyperTreeGridProbeFilter::DoProbing ( vtkDataSet input,
vtkHyperTreeGrid source,
vtkDataSet output,
vtkIdList localPointIds 
)
protected

Helper method for performing the probing.

◆ Reduce()

virtual bool vtkHyperTreeGridProbeFilter::Reduce ( vtkHyperTreeGrid source,
vtkDataSet output,
vtkIdList localPointIds 
)
protectedvirtual

Helper method for reducing the data after probing.

Reimplemented in vtkPHyperTreeGridProbeFilter.

◆ DealWithRemote()

void vtkHyperTreeGridProbeFilter::DealWithRemote ( vtkIdList remotePointIds,
vtkDataSet remoteOutput,
vtkHyperTreeGrid source,
vtkDataSet totOutput 
)
protected

Helper method for dealing with arrays coming from remote locations during the reduce operation.

This method is only called on rank 0. Remote locations refers to any node, including rank 0. This method is also called in serial (that is equivalent to only having rank 0 in distributed).

◆ DealWithRemoteHandles()

void vtkHyperTreeGridProbeFilter::DealWithRemoteHandles ( vtkIdList remotePointIds,
vtkIdList remoteHandles,
vtkIdList totHandles 
)
protected

Helper method for dealing with handles coming from remote locations during the reduce operation.

This method is only called on rank 0. Remote locations refers to any node, including rank 0. This method is also called in serial (that is equivalent to only having rank 0 in distributed).

◆ Finalize()

void vtkHyperTreeGridProbeFilter::Finalize ( vtkHyperTreeGrid source,
vtkDataSet output,
vtkIdType  nanId 
)
protected

Instantiate and set implicit arrays.

Member Data Documentation

◆ Locator

vtkSmartPointer<vtkHyperTreeGridLocator> vtkHyperTreeGridProbeFilter::Locator
protected

Definition at line 238 of file vtkHyperTreeGridProbeFilter.h.

◆ PassCellArrays

bool vtkHyperTreeGridProbeFilter::PassCellArrays = false
protected

Definition at line 240 of file vtkHyperTreeGridProbeFilter.h.

◆ PassPointArrays

bool vtkHyperTreeGridProbeFilter::PassPointArrays = false
protected

Definition at line 241 of file vtkHyperTreeGridProbeFilter.h.

◆ PassFieldArrays

bool vtkHyperTreeGridProbeFilter::PassFieldArrays = true
protected

Definition at line 242 of file vtkHyperTreeGridProbeFilter.h.

◆ Tolerance

double vtkHyperTreeGridProbeFilter::Tolerance = 0.0
protected

Definition at line 243 of file vtkHyperTreeGridProbeFilter.h.

◆ ComputeTolerance

bool vtkHyperTreeGridProbeFilter::ComputeTolerance = true
protected

Definition at line 244 of file vtkHyperTreeGridProbeFilter.h.

◆ ValidPointMaskArrayName

std::string vtkHyperTreeGridProbeFilter::ValidPointMaskArrayName = "vtkValidPointMask"
protected

Definition at line 246 of file vtkHyperTreeGridProbeFilter.h.

◆ ValidPoints

vtkNew<vtkIdTypeArray> vtkHyperTreeGridProbeFilter::ValidPoints
protected

Definition at line 247 of file vtkHyperTreeGridProbeFilter.h.

◆ MaskPoints

vtkSmartPointer<vtkCharArray> vtkHyperTreeGridProbeFilter::MaskPoints
protected

Definition at line 248 of file vtkHyperTreeGridProbeFilter.h.

◆ UseImplicitArrays

bool vtkHyperTreeGridProbeFilter::UseImplicitArrays = false
protected

Definition at line 250 of file vtkHyperTreeGridProbeFilter.h.

◆ Handles

vtkSmartPointer<vtkIdList> vtkHyperTreeGridProbeFilter::Handles
protected

Used to store vtkIndexedArray handles when UseImplicitArrays is on.

Definition at line 256 of file vtkHyperTreeGridProbeFilter.h.


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