vtkArrayCalculator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkArrayCalculator_h
#define vtkArrayCalculator_h

#include "vtkDataObject.h"        // For attribute types
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPassInputTypeAlgorithm.h"
#include "vtkTuple.h"         // needed for vtkTuple
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include <vector> // needed for vector

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;

class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkArrayCalculator : public vtkPassInputTypeAlgorithm
{
public:
  vtkTypeMacro(vtkArrayCalculator, vtkPassInputTypeAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkArrayCalculator* New();


  vtkSetStringMacro(Function);
  vtkGetStringMacro(Function);


  void AddScalarArrayName(const char* arrayName, int component = 0);
  void AddVectorArrayName(const char* arrayName);
  VTK_DEPRECATED_IN_9_6_0("Use AddVectorArrayName(const char* arrayName) instead")
  void AddVectorArrayName(
    const char* arrayName, int component0, int component1 = 1, int component2 = 2)
  {
    static_cast<void>(component0); // to avoid unused parameter warning
    static_cast<void>(component1); // to avoid unused parameter warning
    static_cast<void>(component2); // to avoid unused parameter warning
    this->AddVectorArrayName(arrayName);
  }


  void AddScalarVariable(const char* variableName, const char* arrayName, int component = 0);
  void AddVectorVariable(const char* variableName, const char* arrayName);
  VTK_DEPRECATED_IN_9_6_0(
    "Use AddVectorVariable(const char* variableName, const char* arrayName) instead")
  void AddVectorVariable(const char* variableName, const char* arrayName, int component0,
    int component1 = 1, int component2 = 2)
  {
    static_cast<void>(component0); // to avoid unused parameter warning
    static_cast<void>(component1); // to avoid unused parameter warning
    static_cast<void>(component2); // to avoid unused parameter warning
    this->AddVectorVariable(variableName, arrayName);
  }


  void AddCoordinateScalarVariable(const char* variableName, int component = 0);
  void AddCoordinateVectorVariable(const char* variableName);
  VTK_DEPRECATED_IN_9_6_0("Use AddCoordinateVectorVariable(const char* variableName) instead")
  void AddCoordinateVectorVariable(
    const char* variableName, int component0, int component1 = 1, int component2 = 2)
  {
    static_cast<void>(component0); // to avoid unused parameter warning
    static_cast<void>(component1); // to avoid unused parameter warning
    static_cast<void>(component2); // to avoid unused parameter warning
    this->AddCoordinateVectorVariable(variableName);
  }


  vtkSetStringMacro(ResultArrayName);
  vtkGetStringMacro(ResultArrayName);


  vtkGetMacro(ResultArrayType, int);
  vtkSetMacro(ResultArrayType, int);


  vtkGetMacro(CoordinateResults, vtkTypeBool);
  vtkSetMacro(CoordinateResults, vtkTypeBool);
  vtkBooleanMacro(CoordinateResults, vtkTypeBool);


  vtkGetMacro(ResultNormals, bool);
  vtkSetMacro(ResultNormals, bool);
  vtkBooleanMacro(ResultNormals, bool);


  vtkGetMacro(ResultTCoords, bool);
  vtkSetMacro(ResultTCoords, bool);
  vtkBooleanMacro(ResultTCoords, bool);

  const char* GetAttributeTypeAsString();

  static const int DEFAULT_ATTRIBUTE_TYPE = -1;

  vtkSetMacro(AttributeType, int);
  vtkGetMacro(AttributeType, int);
  void SetAttributeTypeToDefault() { this->SetAttributeType(DEFAULT_ATTRIBUTE_TYPE); }
  void SetAttributeTypeToPointData() { this->SetAttributeType(vtkDataObject::POINT); }
  void SetAttributeTypeToCellData() { this->SetAttributeType(vtkDataObject::CELL); }
  void SetAttributeTypeToEdgeData() { this->SetAttributeType(vtkDataObject::EDGE); }
  void SetAttributeTypeToVertexData() { this->SetAttributeType(vtkDataObject::VERTEX); }
  void SetAttributeTypeToRowData() { this->SetAttributeType(vtkDataObject::ROW); }

  void RemoveAllVariables();

  virtual void RemoveScalarVariables();

  virtual void RemoveVectorVariables();

  virtual void RemoveCoordinateScalarVariables();

  virtual void RemoveCoordinateVectorVariables();


  const std::vector<std::string>& GetScalarArrayNames() { return this->ScalarArrayNames; }
  std::string GetScalarArrayName(int i);
  const std::vector<std::string>& GetVectorArrayNames() { return this->VectorArrayNames; }
  std::string GetVectorArrayName(int i);
  const std::vector<std::string>& GetScalarVariableNames() { return this->ScalarVariableNames; }
  std::string GetScalarVariableName(int i);
  const std::vector<std::string>& GetVectorVariableNames() { return this->VectorVariableNames; }
  std::string GetVectorVariableName(int i);
  const std::vector<int>& GetSelectedScalarComponents() { return this->SelectedScalarComponents; }
  int GetSelectedScalarComponent(int i);
  VTK_DEPRECATED_IN_9_6_0("This method no longer returns valid data")
  const std::vector<vtkTuple<int, 3>>& GetSelectedVectorComponents();
  VTK_DEPRECATED_IN_9_6_0("This method no longer returns valid data")
  vtkTuple<int, 3> GetSelectedVectorComponents(int) { return {}; }
  int GetNumberOfScalarArrays() { return static_cast<int>(this->ScalarArrayNames.size()); }
  int GetNumberOfVectorArrays() { return static_cast<int>(this->VectorArrayNames.size()); }
  const std::vector<std::string>& GetCoordinateScalarVariableNames()
  {
    return this->CoordinateScalarVariableNames;
  }
  std::string GetCoordinateScalarVariableName(int i);
  const std::vector<std::string>& GetCoordinateVectorVariableNames()
  {
    return this->CoordinateVectorVariableNames;
  }
  std::string GetCoordinateVectorVariableName(int i);
  const std::vector<int>& GetSelectedCoordinateScalarComponents()
  {
    return this->SelectedCoordinateScalarComponents;
  }
  int GetSelectedCoordinateScalarComponent(int i);
  int GetNumberOfCoordinateScalarVariables()
  {
    return static_cast<int>(this->CoordinateScalarVariableNames.size());
  }
  int GetNumberOfCoordinateVectorVariables()
  {
    return static_cast<int>(this->CoordinateVectorVariableNames.size());
  }


  vtkSetMacro(ReplaceInvalidValues, vtkTypeBool);
  vtkGetMacro(ReplaceInvalidValues, vtkTypeBool);
  vtkBooleanMacro(ReplaceInvalidValues, vtkTypeBool);
  vtkSetMacro(ReplacementValue, double);
  vtkGetMacro(ReplacementValue, double);


  vtkSetMacro(IgnoreMissingArrays, bool);
  vtkGetMacro(IgnoreMissingArrays, bool);
  vtkBooleanMacro(IgnoreMissingArrays, bool);

  enum FunctionParserTypes
  {
    FunctionParser,       // vtkFunctionParser
    ExprTkFunctionParser, // vtkExprTkFunctionParser
    NumberOfFunctionParserTypes
  };


  vtkSetEnumMacro(FunctionParserType, FunctionParserTypes);
  void SetFunctionParserTypeToFunctionParser()
  {
    this->FunctionParserType = FunctionParserTypes::FunctionParser;
    this->Modified();
  }
  void SetFunctionParserTypeToExprTkFunctionParser()
  {
    this->FunctionParserType = FunctionParserTypes::ExprTkFunctionParser;
    this->Modified();
  }
  vtkGetEnumMacro(FunctionParserType, FunctionParserTypes);

  vtkDataSet* GetDataSetOutput();

protected:
  vtkArrayCalculator();
  ~vtkArrayCalculator() override;

  int FillInputPortInformation(int, vtkInformation*) override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  int GetAttributeTypeFromInput(vtkDataObject* input) const;

  static std::string CheckValidVariableName(const char* variableName);

  FunctionParserTypes FunctionParserType;

  char* Function;
  char* ResultArrayName;
  std::vector<std::string> ScalarArrayNames;
  std::vector<std::string> VectorArrayNames;
  std::vector<std::string> ScalarVariableNames;
  std::vector<std::string> VectorVariableNames;
  int AttributeType;
  std::vector<int> SelectedScalarComponents;

  vtkTypeBool ReplaceInvalidValues;
  double ReplacementValue;
  bool IgnoreMissingArrays;

  vtkTypeBool CoordinateResults;
  bool ResultNormals;
  bool ResultTCoords;
  std::vector<std::string> CoordinateScalarVariableNames;
  std::vector<std::string> CoordinateVectorVariableNames;
  std::vector<int> SelectedCoordinateScalarComponents;

  int ResultArrayType;

private:
  vtkArrayCalculator(const vtkArrayCalculator&) = delete;
  void operator=(const vtkArrayCalculator&) = delete;

  enum ResultTypes
  {
    SCALAR,
    VECTOR
  };

  template <typename TFunctionParser, typename TResultArray>
  class vtkArrayCalculatorFunctor;

  template <typename TFunctionParser>
  struct vtkArrayCalculatorWorker;

  template <typename TFunctionParser>
  vtkSmartPointer<TFunctionParser> InitializeFunctionParser(vtkDataObject* input) const;

  // Do the bulk of the work
  template <typename TFunctionParser>
  int ProcessDataObject(vtkDataObject* input, vtkDataObject* output);
};

VTK_ABI_NAMESPACE_END
#endif