TTK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ttkArrayEditor Class Reference

TTK VTK-filter that edit arrays of a vtkDataObject. More...

#include <ttkArrayEditor.h>

Inheritance diagram for ttkArrayEditor:
ttkAlgorithm ttk::Debug ttk::BaseClass

Public Types

enum class  MODE { ADD_ARRAYS_FROM_STRING = 0 , ADD_ARRAYS_FROM_SOURCE = 1 , FILTER_ARRAYS_FROM_SOURCE = 2 , EDIT_ARRAY = 3 }
 
typedef ttkAlgorithm Superclass
 
- Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void SetEditorMode (int _arg)
 
virtual void SetEditorMode (MODE)
 
virtual MODE GetEditorMode () const
 
virtual void SetTargetAssociation (int)
 
virtual int GetTargetAssociation ()
 
virtual void SetDataString (const std::string &)
 
virtual std::string GetDataString ()
 
virtual void SetReplaceExistingArrays (bool)
 
virtual bool GetReplaceExistingArrays ()
 
virtual void SetTargetArrayName (const std::string &)
 
virtual std::string GetTargetArrayName ()
 
virtual void SetTargetArrayType (int)
 
virtual int GetTargetArrayType ()
 
virtual void SetTargetArrayIndexation (int, int)
 
void SetTargetArrayIndexation (int[2])
 
virtual int * GetTargetArrayIndexation ()
 
virtual void GetTargetArrayIndexation (int &, int &)
 
virtual void GetTargetArrayIndexation (int[2])
 
vtkDataArraySelection * GetArraySelection (int association)
 
vtkDataArraySelection * GetPointDataArraySelection ()
 
vtkDataArraySelection * GetCellDataArraySelection ()
 
vtkDataArraySelection * GetFieldDataArraySelection ()
 
vtkDataArraySelection * GetVertexDataArraySelection ()
 
vtkDataArraySelection * GetEdgeDataArraySelection ()
 
vtkDataArraySelection * GetRowDataArraySelection ()
 
- Public Member Functions inherited from ttkAlgorithm
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void UpdateThreadNumber ()
 
void SetThreadNumber (int threadNumber)
 
void SetUseAllCores (bool useAllCores)
 
void SetDebugLevel (int debugLevel)
 
void SetCompactTriangulationCacheSize (float cacheSize)
 
vtkDataArray * GetOptionalArray (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, const int &inputPort=0)
 
vtkDataArray * GetOrderArray (vtkDataSet *const inputData, const int scalarArrayIdx, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
 
ttk::SimplexIdGetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0, const bool printErr=true)
 
ttk::TriangulationGetTriangulation (vtkDataSet *dataSet)
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVectors, vtkInformationVector *outputVector) override
 
vtkDataSet * GetOutput ()
 
vtkDataSet * GetOutput (int)
 
void SetInputData (vtkDataSet *)
 
void SetInputData (int, vtkDataSet *)
 
void AddInputData (vtkDataSet *)
 
void AddInputData (int, vtkDataSet *)
 
template<typename inputType >
int checkEmptyMPIInput (inputType *input)
 This method tests whether the input is a nullptr. If the computation is being done on multiple processes, it is possible that the domain of one process or more is empty, but not others, therefore in that particular case the rest of the filter will not be computed but an error message will not be sent.
 
- Public Member Functions inherited from ttk::Debug
 Debug ()
 
 ~Debug () override
 
virtual int setDebugLevel (const int &debugLevel)
 
int setWrapper (const Wrapper *wrapper) override
 
int printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
void setDebugMsgPrefix (const std::string &prefix)
 
- Public Member Functions inherited from ttk::BaseClass
 BaseClass ()
 
virtual ~BaseClass ()=default
 
int getThreadNumber () const
 
virtual int setThreadNumber (const int threadNumber)
 
virtual int setWrapper (const Wrapper *wrapper)
 

Static Public Member Functions

static ttkArrayEditorNew ()
 
static int IsTypeOf (const char *type)
 
static ttkArrayEditorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static ttkAlgorithmSafeDownCast (vtkObject *o)
 
static std::string GetOrderArrayName (vtkDataArray *const array)
 
static vtkInformationIntegerKey * SAME_DATA_TYPE_AS_INPUT_PORT ()
 

Protected Member Functions

 ttkArrayEditor ()
 
 ~ttkArrayEditor () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- Protected Member Functions inherited from ttkAlgorithm
 ttkAlgorithm ()
 
 ~ttkAlgorithm () override
 
void MPIGhostPipelinePreconditioning (vtkDataSet *input)
 
void MPIPipelinePreconditioning (vtkDataSet *input, std::vector< int > &neighbors, ttk::Triangulation *triangulation=nullptr)
 
bool checkGlobalIdValidity (ttk::LongSimplexId *globalIds, ttk::SimplexId simplexNumber, unsigned char *ghost, int *rankArray)
 
int GenerateGlobalIds (vtkDataSet *input, std::unordered_map< ttk::SimplexId, ttk::SimplexId > &vertGtoL, std::vector< int > &neighborRanks)
 
void MPITriangulationPreconditioning (ttk::Triangulation *triangulation, vtkDataSet *input)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVectors, vtkInformationVector *outputVector)
 
virtual int RequestInformation (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateTime (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateExtent (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestDataNotGenerated (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestData (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
int FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
int FillOutputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
- Protected Member Functions inherited from ttk::Debug
int printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const
 
int welcomeMsg (std::ostream &stream)
 

Additional Inherited Members

- Protected Attributes inherited from ttkAlgorithm
float CompactTriangulationCacheSize {0.2f}
 
- Protected Attributes inherited from ttk::Debug
int debugLevel_
 
std::string debugMsgPrefix_
 
std::string debugMsgNamePrefix_
 
- Protected Attributes inherited from ttk::BaseClass
bool lastObject_
 
int threadNumber_
 
Wrapperwrapper_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter that edit arrays of a vtkDataObject.

Author
Jonas Lukasczyk jl@jl.nosp@m.uk.d.nosp@m.e
Date
1.10.2018

This filter adds data arrays to a 'vtkDataObject' (called target) based on a string or point/cell/field data of an optional second 'vtkDataObject' (called source). This filter can also be used to directly edit an array (including renaming, type conversion, and reindexing).

Online examples:

Definition at line 36 of file ttkArrayEditor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file ttkArrayEditor.h.

Member Enumeration Documentation

◆ MODE

enum class ttkArrayEditor::MODE
strong
Enumerator
ADD_ARRAYS_FROM_STRING 
ADD_ARRAYS_FROM_SOURCE 
FILTER_ARRAYS_FROM_SOURCE 
EDIT_ARRAY 

Definition at line 38 of file ttkArrayEditor.h.

Constructor & Destructor Documentation

◆ ttkArrayEditor()

ttkArrayEditor::ttkArrayEditor ( )
protected

Definition at line 20 of file ttkArrayEditor.cpp.

◆ ~ttkArrayEditor()

ttkArrayEditor::~ttkArrayEditor ( )
overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

int ttkArrayEditor::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 47 of file ttkArrayEditor.cpp.

◆ FillOutputPortInformation()

int ttkArrayEditor::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 57 of file ttkArrayEditor.cpp.

◆ GetArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetArraySelection ( int  association)

Definition at line 39 of file ttkArrayEditor.cpp.

◆ GetCellDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetCellDataArraySelection ( )
inline

Definition at line 82 of file ttkArrayEditor.h.

◆ GetClassName()

virtual const char * ttkArrayEditor::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetDataString()

virtual std::string ttkArrayEditor::GetDataString ( )
virtual

◆ GetEdgeDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetEdgeDataArraySelection ( )
inline

Definition at line 91 of file ttkArrayEditor.h.

◆ GetEditorMode()

virtual MODE ttkArrayEditor::GetEditorMode ( ) const
virtual

◆ GetFieldDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetFieldDataArraySelection ( )
inline

Definition at line 85 of file ttkArrayEditor.h.

◆ GetPointDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetPointDataArraySelection ( )
inline

Definition at line 79 of file ttkArrayEditor.h.

◆ GetReplaceExistingArrays()

virtual bool ttkArrayEditor::GetReplaceExistingArrays ( )
virtual

◆ GetRowDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetRowDataArraySelection ( )
inline

Definition at line 94 of file ttkArrayEditor.h.

◆ GetTargetArrayIndexation() [1/3]

virtual int * ttkArrayEditor::GetTargetArrayIndexation ( )
virtual

◆ GetTargetArrayIndexation() [2/3]

virtual void ttkArrayEditor::GetTargetArrayIndexation ( int &  ,
int &   
)
virtual

◆ GetTargetArrayIndexation() [3/3]

virtual void ttkArrayEditor::GetTargetArrayIndexation ( int  [2])
virtual

◆ GetTargetArrayName()

virtual std::string ttkArrayEditor::GetTargetArrayName ( )
virtual

◆ GetTargetArrayType()

virtual int ttkArrayEditor::GetTargetArrayType ( )
virtual

◆ GetTargetAssociation()

virtual int ttkArrayEditor::GetTargetAssociation ( )
virtual

◆ GetVertexDataArraySelection()

vtkDataArraySelection * ttkArrayEditor::GetVertexDataArraySelection ( )
inline

Definition at line 88 of file ttkArrayEditor.h.

◆ IsA()

virtual int ttkArrayEditor::IsA ( const char *  type)
virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

static int ttkArrayEditor::IsTypeOf ( const char *  type)
static

◆ New()

static ttkArrayEditor * ttkArrayEditor::New ( )
static

◆ RequestData()

int ttkArrayEditor::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
overrideprotected

Definition at line 79 of file ttkArrayEditor.cpp.

◆ SafeDownCast()

static ttkArrayEditor * ttkArrayEditor::SafeDownCast ( vtkObject *  o)
static

◆ SetDataString()

virtual void ttkArrayEditor::SetDataString ( const std::string &  )
virtual

◆ SetEditorMode() [1/2]

virtual void ttkArrayEditor::SetEditorMode ( int  _arg)
virtual

◆ SetEditorMode() [2/2]

virtual void ttkArrayEditor::SetEditorMode ( MODE  )
virtual

◆ SetReplaceExistingArrays()

virtual void ttkArrayEditor::SetReplaceExistingArrays ( bool  )
virtual

◆ SetTargetArrayIndexation() [1/2]

virtual void ttkArrayEditor::SetTargetArrayIndexation ( int  ,
int   
)
virtual

◆ SetTargetArrayIndexation() [2/2]

void ttkArrayEditor::SetTargetArrayIndexation ( int  [2])

◆ SetTargetArrayName()

virtual void ttkArrayEditor::SetTargetArrayName ( const std::string &  )
virtual

◆ SetTargetArrayType()

virtual void ttkArrayEditor::SetTargetArrayType ( int  )
virtual

◆ SetTargetAssociation()

virtual void ttkArrayEditor::SetTargetAssociation ( int  )
virtual

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