VTK  9.7.20261119
vtkCellGridFindCriticalPoints::Query Class Reference

#include <vtkCellGridFindCriticalPoints.h>

Detailed Description

A cell-grid query for locating a cell-attribute's critical points.

Definition at line 79 of file vtkCellGridFindCriticalPoints.h.

Inheritance diagram for vtkCellGridFindCriticalPoints::Query:
[legend]
Collaboration diagram for vtkCellGridFindCriticalPoints::Query:
[legend]

Public Types

enum  PassType : int { CountOutputs = 0 , AllocateOutputs = 1 , GenerateOutputs = 2 }
 The passes a responder is run through: first solve every cell of its type (caching the results, so the solve never runs twice), then - once every cell type's count is known - size the output arrays once, then write the cached results into their allotted slice. More...
typedef vtkCellGridQuery Superclass
Public Types inherited from vtkCellGridQuery
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.
vtkCellGridFindCriticalPoints::Query * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
bool Initialize () override
 Override this if your query-result state requires initialization.
bool IsAnotherPassRequired () override
 Force three passes through this query.
vtkMTimeType GetMTime () override
 Return the MTime also considering the cell-attribute.
vtkPolyData * GetOutput () const
 Get the request's output point set.
vtkCellGrid * GetInput () const
 Get the request's input cell-grid.
void SetCriticalPoints (vtkStringToken cellTypeName, std::vector< std::vector< vtk::basis::bezier::CriticalPoint > > criticalPointsByCell)
 Called by a responder during the CountOutputs pass to cache the critical points found for every cell of cellTypeName, indexed by that cell type's local cell ID - so the GenerateOutputs pass can write them to the output without solving for them again.
const std::vector< std::vector< vtk::basis::bezier::CriticalPoint > > & GetCriticalPoints (vtkStringToken cellTypeName) const
 Return the critical points SetCriticalPoints() cached for cellTypeName, or an empty vector if that cell type cached none.
void SetCriticalPointTypes (vtkStringToken cellTypeName, std::vector< std::vector< int > > typesByCell)
 Called by a responder during the CountOutputs pass to cache each critical point's classification (the output's own "Type": 0 = minimum, 1 = maximum, 2 = saddle), indexed the same way SetCriticalPoints() indexes its own points - so a cell's coefficients only ever need extracting once.
const std::vector< std::vector< int > > & GetCriticalPointTypes (vtkStringToken cellTypeName) const
 Return the classifications SetCriticalPointTypes() cached for cellTypeName, or an empty vector if that cell type cached none.
void Allocate ()
 Size the output's points and point-data arrays, assign each cell type a contiguous slice of them (GetCellTypeOffset()), build CellOffsets (GetCellOffset()), and build one poly-vertex output cell per source cell that has a critical point.
vtkIdType GetCellTypeOffset (vtkStringToken cellTypeName) const
 Return cellTypeName's own base index into GetCellOffset()'s dense numbering.
vtkIdType GetCellOffset (vtkIdType cellTypeOffset, vtkIdType cellId) const
 Return the output index Allocate() assigned to the critical points of cell cellId (local to its type), given that type's own cellTypeOffset (from GetCellTypeOffset()) - whether or not it has any (in which case this equals the next cell's own offset).
virtual void SetCellAttribute (vtkCellAttribute *)
virtual vtkCellAttribute * GetCellAttribute ()
Public Member Functions inherited from vtkCellGridQuery
vtkCellGridQuery * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
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 Finalize ()
 Override this if your query-result state requires finalization.
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.
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.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
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 Public Member Functions

static Query * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkCellGridFindCriticalPoints::Query * SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCellGridQuery
static vtkTypeBool IsTypeOf (const char *type)
static vtkCellGridQuery * SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject * New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
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 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.

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 Query ()=default
 ~Query () override
Protected Member Functions inherited from vtkCellGridQuery
 vtkCellGridQuery ()=default
 ~vtkCellGridQuery () override=default
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 ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkCellGrid * Input { nullptr }
vtkPolyData * Output { nullptr }
vtkCellAttribute * CellAttribute { nullptr }
std::unordered_map< vtkStringToken, std::vector< std::vector< vtk::basis::bezier::CriticalPoint > > > CriticalPoints
std::unordered_map< vtkStringToken, std::vector< std::vector< int > > > Types
 Parallel to CriticalPoints - same keys, same per-cell indexing.
std::unordered_map< vtkStringToken, vtkIdType > CellIndexBase
 Each cell type's own base index into CellOffsets' dense, flattened (type, local cell ID) numbering.
vtkSmartPointer< vtkIdTypeArray > CellOffsets
 Per-cell (dense, every type, including cells with none) prefix sum of critical-point counts, built by Allocate(); GetCellOffset() reads this.
bool Allocated { false }
Protected Attributes inherited from vtkCellGridQuery
int Pass { -1 }
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

Friends

class vtkCellGridFindCriticalPoints

Additional Inherited Members

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

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ PassType

The passes a responder is run through: first solve every cell of its type (caching the results, so the solve never runs twice), then - once every cell type's count is known - size the output arrays once, then write the cached results into their allotted slice.

Enumerator
CountOutputs 
AllocateOutputs 
GenerateOutputs 

Definition at line 90 of file vtkCellGridFindCriticalPoints.h.

Constructor & Destructor Documentation

◆ Query()

vtkCellGridFindCriticalPoints::Query::Query ( )
protecteddefault

◆ ~Query()

vtkCellGridFindCriticalPoints::Query::~Query ( )
overrideprotected

Member Function Documentation

◆ New()

Query * vtkCellGridFindCriticalPoints::Query::New ( )
static

◆ IsTypeOf()

vtkTypeBool vtkCellGridFindCriticalPoints::Query::IsTypeOf ( const char * type)
static

◆ IsA()

virtual vtkTypeBool vtkCellGridFindCriticalPoints::Query::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 vtkCellGridQuery.

◆ SafeDownCast()

vtkCellGridFindCriticalPoints::Query * vtkCellGridFindCriticalPoints::Query::SafeDownCast ( vtkObjectBase * o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridFindCriticalPoints::Query::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridFindCriticalPoints::Query * vtkCellGridFindCriticalPoints::Query::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridFindCriticalPoints::Query::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 vtkObjectBase.

◆ Initialize()

bool vtkCellGridFindCriticalPoints::Query::Initialize ( )
overridevirtual

Override this if your query-result state requires initialization.

You may override this method to do additional work, but you must be careful to call the base method from your override.

Returning false will abort processing of the query. No error message will be printed.

Reimplemented from vtkCellGridQuery.

◆ IsAnotherPassRequired()

bool vtkCellGridFindCriticalPoints::Query::IsAnotherPassRequired ( )
inlineoverridevirtual

Force three passes through this query.

Reimplemented from vtkCellGridQuery.

Definition at line 100 of file vtkCellGridFindCriticalPoints.h.

◆ GetMTime()

vtkMTimeType vtkCellGridFindCriticalPoints::Query::GetMTime ( )
overridevirtual

Return the MTime also considering the cell-attribute.

Reimplemented from vtkObject.

◆ SetCellAttribute()

virtual void vtkCellGridFindCriticalPoints::Query::SetCellAttribute ( vtkCellAttribute * )
virtual

Specify the cell-attribute whose critical points should be located.

◆ GetCellAttribute()

virtual vtkCellAttribute * vtkCellGridFindCriticalPoints::Query::GetCellAttribute ( )
virtual

Specify the cell-attribute whose critical points should be located.

◆ GetOutput()

vtkPolyData * vtkCellGridFindCriticalPoints::Query::GetOutput ( ) const
inline

Get the request's output point set.

Definition at line 112 of file vtkCellGridFindCriticalPoints.h.

◆ GetInput()

vtkCellGrid * vtkCellGridFindCriticalPoints::Query::GetInput ( ) const
inline

Get the request's input cell-grid.

Definition at line 114 of file vtkCellGridFindCriticalPoints.h.

◆ SetCriticalPoints()

void vtkCellGridFindCriticalPoints::Query::SetCriticalPoints ( vtkStringToken cellTypeName,
std::vector< std::vector< vtk::basis::bezier::CriticalPoint > > criticalPointsByCell )

Called by a responder during the CountOutputs pass to cache the critical points found for every cell of cellTypeName, indexed by that cell type's local cell ID - so the GenerateOutputs pass can write them to the output without solving for them again.

◆ GetCriticalPoints()

const std::vector< std::vector< vtk::basis::bezier::CriticalPoint > > & vtkCellGridFindCriticalPoints::Query::GetCriticalPoints ( vtkStringToken cellTypeName) const

Return the critical points SetCriticalPoints() cached for cellTypeName, or an empty vector if that cell type cached none.

◆ SetCriticalPointTypes()

void vtkCellGridFindCriticalPoints::Query::SetCriticalPointTypes ( vtkStringToken cellTypeName,
std::vector< std::vector< int > > typesByCell )

Called by a responder during the CountOutputs pass to cache each critical point's classification (the output's own "Type": 0 = minimum, 1 = maximum, 2 = saddle), indexed the same way SetCriticalPoints() indexes its own points - so a cell's coefficients only ever need extracting once.

◆ GetCriticalPointTypes()

const std::vector< std::vector< int > > & vtkCellGridFindCriticalPoints::Query::GetCriticalPointTypes ( vtkStringToken cellTypeName) const

Return the classifications SetCriticalPointTypes() cached for cellTypeName, or an empty vector if that cell type cached none.

◆ Allocate()

void vtkCellGridFindCriticalPoints::Query::Allocate ( )

Size the output's points and point-data arrays, assign each cell type a contiguous slice of them (GetCellTypeOffset()), build CellOffsets (GetCellOffset()), and build one poly-vertex output cell per source cell that has a critical point.

A no-op after the first call, so every cell type's AllocateOutputs pass may call it unconditionally.

◆ GetCellTypeOffset()

vtkIdType vtkCellGridFindCriticalPoints::Query::GetCellTypeOffset ( vtkStringToken cellTypeName) const

Return cellTypeName's own base index into GetCellOffset()'s dense numbering.

A hash lookup - resolve it once per cell type and pass it to GetCellOffset() rather than calling that overload of GetCellOffset() that looks it up again on every cell.

◆ GetCellOffset()

vtkIdType vtkCellGridFindCriticalPoints::Query::GetCellOffset ( vtkIdType cellTypeOffset,
vtkIdType cellId ) const

Return the output index Allocate() assigned to the critical points of cell cellId (local to its type), given that type's own cellTypeOffset (from GetCellTypeOffset()) - whether or not it has any (in which case this equals the next cell's own offset).

◆ vtkCellGridFindCriticalPoints

friend class vtkCellGridFindCriticalPoints
friend

Definition at line 161 of file vtkCellGridFindCriticalPoints.h.

Member Data Documentation

◆ Input

vtkCellGrid* vtkCellGridFindCriticalPoints::Query::Input { nullptr }
protected

Definition at line 165 of file vtkCellGridFindCriticalPoints.h.

◆ Output

vtkPolyData* vtkCellGridFindCriticalPoints::Query::Output { nullptr }
protected

Definition at line 166 of file vtkCellGridFindCriticalPoints.h.

◆ CellAttribute

vtkCellAttribute* vtkCellGridFindCriticalPoints::Query::CellAttribute { nullptr }
protected

Definition at line 167 of file vtkCellGridFindCriticalPoints.h.

◆ CriticalPoints

std::unordered_map<vtkStringToken, std::vector<std::vector<vtk::basis::bezier::CriticalPoint> > > vtkCellGridFindCriticalPoints::Query::CriticalPoints
protected

Definition at line 170 of file vtkCellGridFindCriticalPoints.h.

◆ Types

std::unordered_map<vtkStringToken, std::vector<std::vector<int> > > vtkCellGridFindCriticalPoints::Query::Types
protected

Parallel to CriticalPoints - same keys, same per-cell indexing.

Definition at line 172 of file vtkCellGridFindCriticalPoints.h.

◆ CellIndexBase

std::unordered_map<vtkStringToken, vtkIdType> vtkCellGridFindCriticalPoints::Query::CellIndexBase
protected

Each cell type's own base index into CellOffsets' dense, flattened (type, local cell ID) numbering.

Definition at line 175 of file vtkCellGridFindCriticalPoints.h.

◆ CellOffsets

vtkSmartPointer<vtkIdTypeArray> vtkCellGridFindCriticalPoints::Query::CellOffsets
protected

Per-cell (dense, every type, including cells with none) prefix sum of critical-point counts, built by Allocate(); GetCellOffset() reads this.

Definition at line 179 of file vtkCellGridFindCriticalPoints.h.

◆ Allocated

bool vtkCellGridFindCriticalPoints::Query::Allocated { false }
protected

Definition at line 180 of file vtkCellGridFindCriticalPoints.h.


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