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

TTK VTK-filter that provides multiple methods to extract subsets of an input data object based on a logical expression. More...

#include <ttkExtract.h>

Inheritance diagram for ttkExtract:
ttkAlgorithm ttk::Debug ttk::BaseClass ttkForEach

Public Types

enum class  EXTRACTION_MODE {
  AUTO = -1 , BLOCKS = 0 , ROWS = 1 , GEOMETRY = 2 ,
  ARRAY_VALUES = 3 , ARRAYS = 4 , BLOCK_TUPLES = 5
}
 
enum class  VALIDATION_MODE {
  LESS_THEN = 0 , LESS_EQUAL_THEN = 1 , EQUAL = 2 , UNEQUAL = 3 ,
  GREATER_EQUAL_THEN = 4 , GREATER_THEN = 5
}
 
enum class  CELL_MODE { ALL = 0 , ANY = 1 }
 
typedef ttkAlgorithm Superclass
 
- Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual void SetExtractionMode (int _arg)
 
virtual void SetExtractionMode (EXTRACTION_MODE)
 
virtual EXTRACTION_MODE GetExtractionMode () const
 
virtual void SetValidationMode (int _arg)
 
virtual void SetValidationMode (VALIDATION_MODE)
 
virtual VALIDATION_MODE GetValidationMode () const
 
virtual void SetCellMode (int _arg)
 
virtual void SetCellMode (CELL_MODE)
 
virtual CELL_MODE GetCellMode () const
 
virtual void SetMaskOnly (bool)
 
virtual bool GetMaskOnly ()
 
virtual void SetOutputType (int)
 
virtual int GetOutputType ()
 
virtual void SetExpressionString (const std::string &)
 
virtual std::string GetExpressionString ()
 
virtual void SetExtractUniqueValues (bool)
 
virtual bool GetExtractUniqueValues ()
 
virtual void SetArrayAttributeType (int)
 
virtual int GetArrayAttributeType ()
 
virtual void SetOutputArrayName (const std::string &)
 
virtual std::string GetOutputArrayName ()
 
virtual void SetImageExtent (int, int, int, int, int, int)
 
virtual void SetImageExtent (int[6])
 
virtual int * GetImageExtent ()
 
virtual void GetImageExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetImageExtent (int[6])
 
std::string GetVtkDataTypeName (const int outputType) const
 
int ExtractBlocks (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &indices, const bool &extractTuples) const
 
int ExtractRows (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &indices) const
 
int AddMaskArray (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &labels)
 
int ExtractGeometry (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &labels)
 
int ExtractArrayValues (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &indices)
 
int ExtractArray (vtkDataObject *output, vtkDataObject *input, const std::vector< double > &indices)
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
- Public Member Functions inherited from ttkAlgorithm
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, ttk::Triangulation *triangulation, const bool getGlobalOrder=false, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
 
vtkDataArray * checkForGlobalAndComputeOrderArray (vtkDataSet *const inputData, vtkDataArray *scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray *orderArray, ttk::Triangulation *triangulation, const bool enforceOrderArrayIdx)
 
vtkDataArray * ComputeOrderArray (vtkDataSet *const inputData, vtkDataArray *scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray *oldOrderArray, ttk::Triangulation *triangulation)
 
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)
 

Static Public Member Functions

static ttkExtractNew ()
 
static int IsTypeOf (const char *type)
 
static ttkExtractSafeDownCast (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

 ttkExtract ()
 
 ~ttkExtract () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) 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, std::map< int, int > &neighToId, 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, std::map< int, int > &neighborsToId)
 
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 provides multiple methods to extract subsets of an input data object based on a logical expression.

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

This filter provides multiple methods to extract subsets of an input data object based on a logical expression:

  1. Blocks: The filter extracts all blocks of a vtkMultiBlockDataSet based on a list of block indices. It is also possible to extract a single block of a vtkMultiBlockDataSet and explicitly specify its type, which is then returned instead of a vtkMultiBlockDataSet containing a single block. This is especially useful to extract vtkImageData objects.
  2. Block Tuples: Many pipelines produce vtkMultiBlockDataSets that contain vtkMultiBlockDataSets that represent lists. For example, a parent vtkMultiBlockDataSet might contain lists of Merge Trees, Persistence Diagrams, and Domain segmentations, where each entry in a list represents a timestep/ensemble member. Extracting all elements for a given list of timesteps/ensemble members is very cumbersome with the original block extraction method. The block tuples mode makes it possible to conveniently extract these tuples based on a list of timesteps/ensemble member indices.
  3. Rows: The filter extracts all rows of a vtkTable based on a list of row indices.
  4. Geometry: The filter extracts the subset of the input geometry whose point/cell data satisfies a logical expression. It is also possible to pass on the input dataset and only add a mask array that marks points/cells that satisfy the condition.
  5. Array Values: The filter extracts all array values of a vtkAbstractArray based on a list of value indices. The extracted values are stored in a new field data array.
  6. Arrays: The filter extracts all point/cell data arrays based on a given list of indices (not names).

Online examples:

Definition at line 55 of file ttkExtract.h.

Member Typedef Documentation

◆ Superclass

Definition at line 151 of file ttkExtract.h.

Member Enumeration Documentation

◆ CELL_MODE

enum class ttkExtract::CELL_MODE
strong
Enumerator
ALL 
ANY 

Definition at line 77 of file ttkExtract.h.

◆ EXTRACTION_MODE

enum class ttkExtract::EXTRACTION_MODE
strong
Enumerator
AUTO 
BLOCKS 
ROWS 
GEOMETRY 
ARRAY_VALUES 
ARRAYS 
BLOCK_TUPLES 

Definition at line 58 of file ttkExtract.h.

◆ VALIDATION_MODE

enum class ttkExtract::VALIDATION_MODE
strong
Enumerator
LESS_THEN 
LESS_EQUAL_THEN 
EQUAL 
UNEQUAL 
GREATER_EQUAL_THEN 
GREATER_THEN 

Definition at line 68 of file ttkExtract.h.

Constructor & Destructor Documentation

◆ ttkExtract()

ttkExtract::ttkExtract ( )
protected

Definition at line 29 of file ttkExtract.cpp.

◆ ~ttkExtract()

ttkExtract::~ttkExtract ( )
overrideprotecteddefault

Member Function Documentation

◆ AddMaskArray()

int ttkExtract::AddMaskArray ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  labels 
)

Definition at line 389 of file ttkExtract.cpp.

◆ ExtractArray()

int ttkExtract::ExtractArray ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  indices 
)

Definition at line 629 of file ttkExtract.cpp.

◆ ExtractArrayValues()

int ttkExtract::ExtractArrayValues ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  indices 
)

Definition at line 553 of file ttkExtract.cpp.

◆ ExtractBlocks()

int ttkExtract::ExtractBlocks ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  indices,
const bool &  extractTuples 
) const

Definition at line 112 of file ttkExtract.cpp.

◆ ExtractGeometry()

int ttkExtract::ExtractGeometry ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  labels 
)

Definition at line 465 of file ttkExtract.cpp.

◆ ExtractRows()

int ttkExtract::ExtractRows ( vtkDataObject *  output,
vtkDataObject *  input,
const std::vector< double > &  indices 
) const

Definition at line 237 of file ttkExtract.cpp.

◆ FillInputPortInformation()

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

Definition at line 55 of file ttkExtract.cpp.

◆ FillOutputPortInformation()

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

Definition at line 64 of file ttkExtract.cpp.

◆ GetArrayAttributeType()

virtual int ttkExtract::GetArrayAttributeType ( )
virtual

◆ GetCellMode()

virtual CELL_MODE ttkExtract::GetCellMode ( ) const
virtual

◆ GetClassName()

virtual const char * ttkExtract::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

Reimplemented in ttkForEach.

◆ GetExpressionString()

virtual std::string ttkExtract::GetExpressionString ( )
virtual

◆ GetExtractionMode()

virtual EXTRACTION_MODE ttkExtract::GetExtractionMode ( ) const
virtual

◆ GetExtractUniqueValues()

virtual bool ttkExtract::GetExtractUniqueValues ( )
virtual

◆ GetImageExtent() [1/3]

virtual int * ttkExtract::GetImageExtent ( )
virtual

◆ GetImageExtent() [2/3]

virtual void ttkExtract::GetImageExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

◆ GetImageExtent() [3/3]

virtual void ttkExtract::GetImageExtent ( int  [6])
virtual

◆ GetMaskOnly()

virtual bool ttkExtract::GetMaskOnly ( )
virtual

◆ GetOutputArrayName()

virtual std::string ttkExtract::GetOutputArrayName ( )
virtual

◆ GetOutputType()

virtual int ttkExtract::GetOutputType ( )
virtual

◆ GetValidationMode()

virtual VALIDATION_MODE ttkExtract::GetValidationMode ( ) const
virtual

◆ GetVtkDataTypeName()

std::string ttkExtract::GetVtkDataTypeName ( const int  outputType) const

Definition at line 37 of file ttkExtract.cpp.

◆ IsA()

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

Reimplemented from ttkAlgorithm.

Reimplemented in ttkForEach.

◆ IsTypeOf()

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

◆ New()

static ttkExtract * ttkExtract::New ( )
static

◆ RequestData()

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

Definition at line 693 of file ttkExtract.cpp.

◆ RequestInformation()

int ttkExtract::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
overrideprotected

Definition at line 87 of file ttkExtract.cpp.

◆ SafeDownCast()

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

◆ SetArrayAttributeType()

virtual void ttkExtract::SetArrayAttributeType ( int  )
virtual

◆ SetCellMode() [1/2]

virtual void ttkExtract::SetCellMode ( CELL_MODE  )
virtual

◆ SetCellMode() [2/2]

virtual void ttkExtract::SetCellMode ( int  _arg)
virtual

◆ SetExpressionString()

virtual void ttkExtract::SetExpressionString ( const std::string &  )
virtual

◆ SetExtractionMode() [1/2]

virtual void ttkExtract::SetExtractionMode ( EXTRACTION_MODE  )
virtual

◆ SetExtractionMode() [2/2]

virtual void ttkExtract::SetExtractionMode ( int  _arg)
virtual

◆ SetExtractUniqueValues()

virtual void ttkExtract::SetExtractUniqueValues ( bool  )
virtual

◆ SetImageExtent() [1/2]

virtual void ttkExtract::SetImageExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

◆ SetImageExtent() [2/2]

virtual void ttkExtract::SetImageExtent ( int  [6])
virtual

◆ SetMaskOnly()

virtual void ttkExtract::SetMaskOnly ( bool  )
virtual

◆ SetOutputArrayName()

virtual void ttkExtract::SetOutputArrayName ( const std::string &  )
virtual

◆ SetOutputType()

virtual void ttkExtract::SetOutputType ( int  )
virtual

◆ SetValidationMode() [1/2]

virtual void ttkExtract::SetValidationMode ( int  _arg)
virtual

◆ SetValidationMode() [2/2]

virtual void ttkExtract::SetValidationMode ( VALIDATION_MODE  )
virtual

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