VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSortFieldData Class Reference

provides a method for sorting field data More...

#include <vtkSortFieldData.h>

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

Public Types

typedef vtkSortDataArray Superclass
 
- Public Types inherited from vtkSortDataArray
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSortFieldDataNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkSortDataArray
vtkSortDataArrayNewInstance () const
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSortFieldDataNew ()
 Standard VTK methods for instantiating, managing type, and printing information about this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSortFieldDataSafeDownCast (vtkObjectBase *o)
 
static vtkIdTypeSort (vtkFieldData *fd, const char *arrayName, int k, int returnIndices)
 Given field data (and derived classes such as point data and cell data), sort all the arrays in the field data given an array and a component number k from that array. More...
 
static vtkIdTypeSort (vtkFieldData *fd, const char *arrayName, int k, int returnIndices, int dir)
 Given field data (and derived classes such as point data and cell data), sort all the arrays in the field data given an array and a component number k from that array. More...
 
- Static Public Member Functions inherited from vtkSortDataArray
static vtkSortDataArrayNew ()
 Standard VTK methods for instantiating, managing type, and printing information about this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSortDataArraySafeDownCast (vtkObjectBase *o)
 
static void Sort (vtkIdList *keys)
 Sorts the given array in ascending order. More...
 
static void Sort (vtkAbstractArray *keys)
 
static void Sort (vtkIdList *keys, int dir)
 Sorts the given array in either ascending (dir=0) or descending (dir!=0) order. More...
 
static void Sort (vtkAbstractArray *keys, int dir)
 
static void Sort (vtkAbstractArray *keys, vtkAbstractArray *values)
 Sorts the given key/value pairs based on the keys (the keys are expected to be 1-tuples, values may have number of components >= 1). More...
 
static void Sort (vtkAbstractArray *keys, vtkIdList *values)
 
static void Sort (vtkAbstractArray *keys, vtkAbstractArray *values, int dir)
 Sorts the given key/value pairs based on the keys (the keys are expected to be 1-tuples, values may have number of components >= 1). More...
 
static void Sort (vtkAbstractArray *keys, vtkIdList *values, int dir)
 
static void SortArrayByComponent (vtkAbstractArray *arr, int k)
 Sorts the given data array using the specified component as a key. More...
 
static void SortArrayByComponent (vtkAbstractArray *arr, int k, int dir)
 Sorts the given data array using the specified component as a key. More...
 
static vtkIdTypeInitializeSortIndices (vtkIdType numKeys)
 The following are general functions which can be used to produce an ordering, and/or sort various types of VTK arrays. More...
 
static void GenerateSortIndices (int dataType, void *dataIn, vtkIdType numKeys, int numComp, int k, vtkIdType *idx)
 
static void ShuffleArray (vtkIdType *idx, int dataType, vtkIdType numKeys, int numComp, vtkAbstractArray *arr, void *dataIn, int dir)
 
static void ShuffleIdList (vtkIdType *idx, vtkIdType sze, vtkIdList *arrayIn, vtkIdType *dataIn, int dir)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSortFieldData ()
 
 ~vtkSortFieldData () override
 
- Protected Member Functions inherited from vtkSortDataArray
 vtkSortDataArray ()
 
 ~vtkSortDataArray () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkSortDataArray
static void GenerateSort1Indices (int dataType, void *dataIn, vtkIdType numKeys, vtkIdType *idx)
 
static void Shuffle1Array (vtkIdType *idx, int dataType, vtkIdType numKeys, vtkAbstractArray *arr, void *dataIn, int dir)
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

provides a method for sorting field data

vtkSortFieldData is used to sort data, based on its value, or with an associated key, into either ascending or descending order. This is useful for operations like selection, or analysis, when evaluating and processing data.

This class, which extends the base functionality of vtkSortDataArray, is used to sort field data and its various subclasses (vtkFieldData, vtkDataSetAttributes, vtkPointData, vtkCellData, etc.)

Warning
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly on multi-core machines.
The sort methods below are static, hence the sorting methods can be used without instantiating the class. All methods are thread safe.
See also
vtkSortDataArray

Definition at line 52 of file vtkSortFieldData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 61 of file vtkSortFieldData.h.

Constructor & Destructor Documentation

◆ vtkSortFieldData()

vtkSortFieldData::vtkSortFieldData ( )
protected

◆ ~vtkSortFieldData()

vtkSortFieldData::~vtkSortFieldData ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSortFieldData* vtkSortFieldData::New ( )
static

Standard VTK methods for instantiating, managing type, and printing information about this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSortFieldData::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 vtkSortDataArray.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSortFieldData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSortDataArray.

◆ NewInstance()

vtkSortFieldData* vtkSortFieldData::NewInstance ( ) const

◆ PrintSelf()

void vtkSortFieldData::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 vtkSortDataArray.

◆ Sort() [1/2]

static vtkIdType* vtkSortFieldData::Sort ( vtkFieldData fd,
const char *  arrayName,
int  k,
int  returnIndices 
)
inlinestatic

Given field data (and derived classes such as point data and cell data), sort all the arrays in the field data given an array and a component number k from that array.

In other words, if an array has n components, the kth component is used to sort the array and all of the other arrays in the field data. Also note that the user can indicate whether the function returns the sort indices (returnIndices=1). If the indices are returned, then the user takes ownership of the data and must delete it. Note that the indices are in sorted (ascending) order, and indicate the final sorted position of the sort. So for example indices[0]=10 indicates that the original data in position 10 in the field, was moved to position 0 after the sort. By default, returnIndices=0. (Other notes: if any array is not the same length as the sorting array, then it will be skipped and not sorted.)

Definition at line 80 of file vtkSortFieldData.h.

◆ Sort() [2/2]

static vtkIdType* vtkSortFieldData::Sort ( vtkFieldData fd,
const char *  arrayName,
int  k,
int  returnIndices,
int  dir 
)
static

Given field data (and derived classes such as point data and cell data), sort all the arrays in the field data given an array and a component number k from that array.

In other words, if an array has n components, the kth component is used to sort the array and all of the other arrays in the field data. The order of the sorted data is goven by dir: dir=0 means sort in ascending order; dir=1 means sort in descending order. Also note that the user can indicate whether the function returns the sort indices (returnIndices=1). If the indices are returned, then the user takes ownership of the data and must delete it. Note that the indices are always in sorted (ascending) order, and indicate the final sorted position of the sort. So for example indices[0]=10 indicates that the original data in position 10 in the field, was moved to position 0 after the sort (i.e., position 0 is the smallest value). However, if sort direction dir=1, the indices do not change but the final shuffle of the data is in reverse order (note idx[n-1] for n keys is the largest value). By default, returnIndices=0. (Other notes: if any array is not the same length as the sorting array, then it will be skipped and not sorted.)


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