|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkCellGridEvaluator * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetCellAttribute (vtkCellAttribute *) |
| Set/get the cell-attribute to be evaluated.
|
|
virtual vtkCellAttribute * | GetCellAttribute () |
|
virtual vtkDataArray * | GetInputPoints () |
| Get the input points to be classified and possibly interpolated.
|
|
virtual vtkTypeUInt32Array * | GetClassifierCellTypes () |
| Get the discovered types of cells containing input points.
|
|
virtual vtkTypeUInt64Array * | GetClassifierCellOffsets () |
| Get the offset into the result arrays where each cell-type's points reside.
|
|
virtual vtkTypeUInt64Array * | GetClassifierPointIDs () |
| Get the array holding indices into the InputPoints array of each output.
|
|
virtual vtkTypeUInt64Array * | GetClassifierCellIndices () |
| Get the array holding indices into cells of a given type that contain input points.
|
|
virtual vtkDataArray * | GetClassifierPointParameters () |
| Get the array holding (r, s, t)-coordinates where each input point is located.
|
|
virtual vtkDataArray * | GetInterpolatedValues () |
| Get the array holding cell-attribute values interpolated to each input point.
|
|
void | ClassifyPoints (vtkDataArray *points) |
| Configure the query to run the classifier but not the interpolator.
|
|
void | InterpolatePoints (vtkDataArray *points) |
| Configure the query to run the classifier followed by the interpolator.
|
|
void | InterpolateCellParameters (vtkTypeUInt32Array *cellTypes, vtkTypeUInt64Array *cellOffsets, vtkTypeUInt64Array *cellIndices, vtkDataArray *pointParameters) |
| Configure the query to run only the interpolator.
|
|
| vtkGetEnumMacro (PhasesToPerform, vtkCellGridEvaluator::Phases) |
| Return what work the query has been configured to do.
|
|
bool | Initialize () override |
| Invoked during evaluation before any cell-grid responders are run.
|
|
void | StartPass () override |
| Invoked at the start of each pass.
|
|
bool | IsAnotherPassRequired () override |
| Invoked at the end of each pass.
|
|
bool | Finalize () override |
| Invoked during evaluation after all cell-grid responders are run.
|
|
virtual vtkStaticPointLocator * | GetLocator () |
|
AllocationsByCellType & | GetAllocationsForCellType (vtkStringToken cellType) |
| Return a reference to a cellType's allocated input points for responders to fill out.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkCellGridQuery * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual bool | Initialize () |
| Override this if your query-result state requires initialization.
|
|
virtual void | StartPass () |
| Mark the start of a pass through each cell type.
|
|
virtual int | GetPass () |
| Return the current pass (the number of times each responder has been evaluated so far).
|
|
virtual bool | IsAnotherPassRequired () |
| Override this if your query allows responders to execute in multiple phases.
|
|
virtual bool | Finalize () |
| Override this if your query-result state requires finalization.
|
|
| 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.
|
|
vtkCommand * | GetCommand (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.
|
|
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.
|
|
virtual bool | UsesGarbageCollector () const |
| Indicate whether the class uses vtkGarbageCollector or not.
|
|
|
static vtkCellGridEvaluator * | New () |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkCellGridEvaluator * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkCellGridQuery * | SafeDownCast (vtkObjectBase *o) |
|
static vtkObject * | New () |
| 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 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 vtkObjectBase * | New () |
| 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.
|
|
Evaluate a field (vtkCellAttribute) at some points inside cells.
This class is a cell-grid query whose purpose is to determine the value a vtkCellAttribute takes on at one or more points inside the domain of a vtkCellGrid.
This class performs its work in two phases:
- Classification. Input points are classified by the type and index of cell in the grid in which they lie.
- Attribute/field interpolation. Each cell is asked to interpolate the value of a cell-attribute at each point classified to it.
As an example, consider a cell-grid holding 10 triangles and 20 quads and a query that is provided 5 points. The first phase will identify which of the 5 points are insides triangles, which lie in quadrilaterals, and which lie in neither. Say that 2 lie inside triangles, 2 inside quadrilaterals, and 1 is outside the domain. Furthermore, the first phase will identify which particular triangles or quadrilaterals contain the input points. The two points which lie in triangles will report a number in [0,10[ while the two points which lie in quadrilaterals will report a number in [0, 20[. Finally, for cells which have a reference element, the parametric coordinates of each input point are computed.
The second phase additionally interpolates a cell-attribute (let's say "Velocity" in our example) at each input point.
You may configure the query to skip either phase (classification or interpolation). If you skip classification, you must provide the the classification information for the input points. The method you call (ClassifyPoints, InterpolatePoints, or InterpolateCellParameters) determines which phase(s) are applied during evaluation.
When running in InterpolatePoints mode (both classification and interpolation phases are performed), the output from our example is reported like so:
GetClassifierCellTypes()
– returns an array with a cell-type hash for each type of cell containing an input point. The hash value can be used to construct a vtkStringToken. Our example would return an array with 3 values which might be ordered: "vtkDGTri"_hash, "vtkDGQuad"_hash, and 0 (an "invalid" hash).
GetClassifierCellOffsets()
– returns an array with the same number of values as the call above. Each value specifies the start of reporting for points contained in the corresponding cell type. Our example would return [0, 2, 4] to match the values above.
GetClassifierPointIDs()
– returns an array whose length matches the number of input points. Each value is the index of an input point. Input points do not have their order preserved so that all the points contained in a single cell can be reported together. Our example might return [4, 2, 1, 0, 3]. This will always be a permutation of the counting integers and, for our example, always hold integers in [0, 5[.
GetClassifierCellIndices()
– returns an array whose length matches the number of input points. Each value is the index into cells of the corresponding type, indicating which cell contains the input point. For our example, the first two numbers will be in [0, 10[, the second two will be in [0, 20[, and the last will be -1. (This is because we have two points inside 10 triangles, two points inside 20 quads, and one un-classifiable input point.)
GetClassifierPointParameters()
– returns an array whose length matches the number of input points. Each value is a 3-tuple of reference-cell coordinates (or indeterminate if the cell type does not provide a reference cell).
GetInterpolatedValues()
– returns an array whose number of tuples matches the number of input points and whose number of components matches the number of components of the requested cell-attribute. For our example, an array with 5 tuples of 3 components each would be returned; it would be named "Velocity" (matching the cell-attribute's name).
Note that because you can pass in the arrays above (except the interpolated values) to short-circuit classification, it is possible to evaluate multiple cell-attributes without duplicating the classification work.
In InterpolateCellParameters mode, calling the methods above which begin with GetClassifier…
will simply return the input arrays you passed to configure the query.
Warnings
The output arrays above generally match the number of input points, but will sometimes exceed the number of input points. This will occur when multiple cells contain an input point (either on a shared boundary or because the cells overlap).
Note that the output should never have fewer points than the input as even points outside the cells will be classified as such.
Currently, this class is limited to evaluating numeric attributes; string or variant arrays are not supported.
- Tests:
- vtkCellGridEvaluator (Tests)
Definition at line 121 of file vtkCellGridEvaluator.h.